Class iarchive

odtone::mih::iarchive

Synopsis

// In header: </home/carlos/Projectos/odtone/inc/odtone/mih/archive.hpp>


class iarchive {
public:
  // types
  typedef iarchive                             iarchive_type; 
  typedef std::vector< uint8 >::const_iterator const_iterator;

  // construct/copy/destruct
  iarchive(archive &);
  iarchive(archive &, uint);
  iarchive(iarchive &, uint);

  // public member functions
  void reset(archive &);
  void position(uint);
  uint position() const;
  uint length() const;
  void advance(uint);
  const_iterator begin() const;
  const_iterator current() const;
  const_iterator end() const;
  uint list_length();
  iarchive & operator&(bool &);
  iarchive & operator&(uint8 &);
  iarchive & operator&(uint16 &);
  iarchive & operator&(uint32 &);
  iarchive & operator&(uint64 &);
  iarchive & operator&(sint8 &);
  iarchive & operator&(sint16 &);
  iarchive & operator&(sint32 &);
  iarchive & operator&(sint64 &);
  iarchive & operator&(octet_string &);
  iarchive & operator&(std::vector< uint8 > &);
};

Description

The MIH types support deserialization for the input archive. This particular archive does not include the TLV field, which is necessary to support the definition of new sequence types from existing MIH types.

`iarchive` public construct/copy/destruct

```
iarchive(archive & ar);
```
Construct an input archive.

Parameters:

ar

The archive from where extract the data.
```
iarchive(archive & ar, uint length);
```
Construct an input archive.

Parameters:

ar

The archive from where extract the data.

length

Size of the data.
```
iarchive(iarchive & ar, uint length);
```
Construct an input archive.

Parameters:

ar

The input archive from where extract the data.

length

Size of the data.

`iarchive` public member functions

```
void reset(archive & ar);
```
Overwrites the current data.

Parameters:

ar

The archive from where extract the data.
```
void position(uint pos);
```
Point to a new position in the input archive.

Parameters:

pos

The new position to point in the input archive.
```
uint position() const;
```
Get the current position in the input archive.

Returns:

The current position in the input archive.
```
uint length() const;
```
Get the length of the input archive.

Returns:

The length of the input archive.
```
void advance(uint pos);
```
Advance the position in the input archive.

Parameters:

pos

The number of positions to advance.
```
const_iterator begin() const;
```
A random-access iterator addressing the first element in the input archive or to the location succeeding an empty archive. The iterator should always be compared with vector::end to ensure it is valid.

Returns:

Returns a random-access iterator to the first element in the input archive.
```
const_iterator current() const;
```
A random-access iterator addressing the current element in the input archive.

Returns:

A random-access iterator that points just beyond the end of the archive.
```
const_iterator end() const;
```
A random-access iterator to the end of the input archive object. If the archive is empty, vector::end == vector::begin.

Returns:

A random-access iterator that points just beyond the end of the input archive.
```
uint list_length();
```
Get the size of a list of a particular data type.

Returns:

The size of a list of a particular data type.
```
iarchive & operator&(bool & val);
```
Get a boolean type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(uint8 & val);
```
Get a odtone::uint8 type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(uint16 & val);
```
Get a odtone::uint16 type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(uint32 & val);
```
Get a odtone::uint32 type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(uint64 & val);
```
Get a odtone::uint64 type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(sint8 & val);
```
Get a odtone::sint8 type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(sint16 & val);
```
Get a odtone::sint16 type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(sint32 & val);
```
Get a odtone::sint32 type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(sint64 & val);
```
Get a odtone::sint64 type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(octet_string & val);
```
Get a odtone::mih::octet_string type value from the current position in the input archive.

Parameters:

val

Reference to where save the value.

Returns:

The updated input archive.
```
iarchive & operator&(std::vector< uint8 > & buf);
```
Get a list of a particular type value from the current position in the input archive.

Parameters:

buf

Reference to where save the value.

Returns:

The updated input archive.

Class iarchive

Synopsis

Description

iarchive public construct/copy/destruct

iarchive public member functions

`iarchive` public construct/copy/destruct

`iarchive` public member functions