AgentXcpp  Revision:4ac4848
Internals Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends
agentxcpp::Octet_String Class Reference

Represents an Octet String as descibed in RFC 2741, section 5.3. More...

#include <Octet_String.hpp>

Inheritance diagram for agentxcpp::Octet_String:
[legend]
Collaboration diagram for agentxcpp::Octet_String:
[legend]

List of all members.

Public Member Functions

data_t serialize () const
 Encode the object as described in RFC 2741, section 5.3.
 Octet_String (data_t initial_value)
 FIXME.
 Octet_String (std::string initial_value)
 Octet_String ()
 FIXME.
 Octet_String (data_t::const_iterator &pos, const data_t::const_iterator &end, bool big_endian=true)
 Construct the object from input stream.
void set_value (data_t new_value)
 Set the current value.
data_t get_value ()
 get the current value

Protected Attributes

data_t value

Detailed Description

Represents an Octet String as descibed in RFC 2741, section 5.3.

Definition at line 32 of file Octet_String.hpp.


Constructor & Destructor Documentation

agentxcpp::Octet_String::Octet_String ( data_t  initial_value) [inline]

FIXME.

Definition at line 53 of file Octet_String.hpp.

Octet_String::Octet_String ( std::string  initial_value)

Definition at line 26 of file Octet_String.cpp.

References value.

FIXME.

Definition at line 60 of file Octet_String.hpp.

Octet_String::Octet_String ( data_t::const_iterator &  pos,
const data_t::const_iterator &  end,
bool  big_endian = true 
)

Construct the object from input stream.

This constructor parses the serialized form of the object. It takes an iterator, starts parsing at the position of the iterator and advances the iterator to the position right behind the object.

The constructor expects valid data from the stream; if parsing fails, parse_error is thrown. In this case, the iterator position is undefined.

Parameters:
posIterator pointing to the current stream position. The iterator is advanced while reading the header.
endIterator pointing one element past the end of the current stream. This is needed to mark the end of the buffer.
big_endianWhether the input stream is in big endian format

Definition at line 72 of file Octet_String.cpp.

References value.


Member Function Documentation

get the current value

Definition at line 98 of file Octet_String.hpp.

References value.

data_t Octet_String::serialize ( ) const [virtual]

Encode the object as described in RFC 2741, section 5.3.

Note: We always use big endian.

Implements variable.

Definition at line 46 of file Octet_String.cpp.

References value.

Referenced by agentxcpp::PDUwithContext::add_header(), agentxcpp::OpenPDU::serialize(), and agentxcpp::AddAgentCapsPDU::serialize().

void agentxcpp::Octet_String::set_value ( data_t  new_value) [inline]

Set the current value.

Definition at line 93 of file Octet_String.hpp.

References value.


Member Data Documentation

Definition at line 37 of file Octet_String.hpp.

Referenced by get_value(), Octet_String(), serialize(), and set_value().


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