Tawara  0.1.0
Public Member Functions | Protected Member Functions | List of all members
tawara::UIntElement Class Reference

Unsigned integer primitive element. More...

#include <tawara/uint_element.h>

Inheritance diagram for tawara::UIntElement:
Inheritance graph
[legend]
Collaboration diagram for tawara::UIntElement:
Collaboration graph
[legend]

Public Member Functions

 UIntElement (uint32_t id, uint64_t value)
 Create a new unsigned integer element with no default. More...
 
 UIntElement (uint32_t id, uint64_t value, uint64_t default_value)
 Create a new unsigned integer element with a default value. More...
 
virtual UIntElementoperator= (uint64_t const &rhs)
 Value assignment operator. More...
 
virtual std::streamsize write_body (std::ostream &output)
 Element body writing. More...
 
- Public Member Functions inherited from tawara::PrimitiveElement< uint64_t >
 PrimitiveElement (uint32_t id, uint64_tvalue)
 Create a new element with no default. More...
 
 PrimitiveElement (uint32_t id, uint64_tvalue, uint64_tdefault_value)
 Create a signed integer element with a default value. More...
 
virtual uint32_t id () const
 Get the element's ID. More...
 
virtual void id (uint32_t id)
 Set the element's ID. More...
 
virtual uint64_t value () const
 Get the value. More...
 
virtual void value (uint64_tvalue)
 Set the value. More...
 
 operator uint64_t () const
 Cast to the stored type. More...
 
virtual bool has_default () const
 Check if a default value is set. More...
 
virtual uint64_t get_default () const
 Get the default value. More...
 
virtual void set_default (uint64_tdefault_value)
 Set the default value. More...
 
virtual uint64_t remove_default ()
 Remove the default value. More...
 
virtual bool is_default () const
 Check if this element is at the default value. More...
 
- Public Member Functions inherited from tawara::Element
 Element (tawara::ids::ID id)
 Create a new Element. More...
 
virtual ~Element ()
 Destructor. More...
 
uint32_t id () const
 Get the element's ID. More...
 
std::streampos offset () const
 Get the element's offset in the byte stream. More...
 
virtual std::streamsize size () const
 Get the total size of the element. More...
 
virtual std::streamsize write (std::ostream &output)
 Element writing. More...
 
virtual std::streamsize read (std::istream &input)
 Element reading. More...
 

Protected Member Functions

virtual std::streamsize body_size () const
 Get the size of the body of this element. More...
 
virtual std::streamsize read_body (std::istream &input, std::streamsize size)
 Element body loading. More...
 
- Protected Member Functions inherited from tawara::PrimitiveElement< uint64_t >
virtual bool equal_ (PrimitiveElement< uint64_t > const &rhs)
 
- Protected Member Functions inherited from tawara::Element
std::streamsize write_id (std::ostream &output)
 Element ID writing. More...
 
virtual std::streamsize write_size (std::ostream &output)
 Element size writing. More...
 

Additional Inherited Members

- Protected Attributes inherited from tawara::PrimitiveElement< uint64_t >
uint64_t value_
 
uint64_t default_
 
bool has_default_
 
- Protected Attributes inherited from tawara::Element
tawara::ids::ID id_
 
std::streampos offset_
 

Detailed Description

Unsigned integer primitive element.

This element stores an unsigned integer. The maximum size of the value is 2^64.

Definition at line 57 of file uint_element.h.

Constructor & Destructor Documentation

tawara::UIntElement::UIntElement ( uint32_t  id,
uint64_t  value 
)

Create a new unsigned integer element with no default.

Parameters
[in]idThe element's ID, as an unsigned integer up to 28 bits.
[in]valueThe element's value.
tawara::UIntElement::UIntElement ( uint32_t  id,
uint64_t  value,
uint64_t  default_value 
)

Create a new unsigned integer element with a default value.

Parameters
[in]idThe element's ID, as an unsigned integer up to 28 bits.
[in]valueThe element's value.
[in]default_valueThe default value of the element.

Member Function Documentation

virtual std::streamsize tawara::UIntElement::body_size ( ) const
protectedvirtual

Get the size of the body of this element.

Implements tawara::Element.

virtual UIntElement& tawara::UIntElement::operator= ( uint64_t const &  rhs)
virtual

Value assignment operator.

Reimplemented from tawara::PrimitiveElement< uint64_t >.

virtual std::streamsize tawara::UIntElement::read_body ( std::istream &  input,
std::streamsize  size 
)
protectedvirtual

Element body loading.

Implements tawara::Element.

virtual std::streamsize tawara::UIntElement::write_body ( std::ostream &  output)
virtual

Element body writing.

Implements tawara::Element.


The documentation for this class was generated from the following file: