agentxcpp::RemoveAgentCapsPDU Class Reference

Represents an RemoveAgentCaps-PDU. More...

#include <RemoveAgentCapsPDU.hpp>

Inheritance diagram for agentxcpp::RemoveAgentCapsPDU:

Collaboration diagram for agentxcpp::RemoveAgentCapsPDU:

List of all members.

Public Member Functions
	RemoveAgentCapsPDU (binary::const_iterator &pos, const binary::const_iterator &end, bool big_endian)
	Parse constructor.
	RemoveAgentCapsPDU ()
	Default Constructor.
	RemoveAgentCapsPDU (oid id)
	Constructor.
void	set_id (oid id)
	Set the id field.
oid	get_id ()
	Get the id field.
binary	serialize ()
	Serialize the PDU.
Public Member Functions inherited from agentxcpp::PDUwithContext
bool	has_context ()
	Whether the PDU has a context.
Octet_String	get_context ()
	Get context.
void	set_context (Octet_String value)
	Set the PDU's context.
void	remove_context ()
	Removes the context from the PDU.
Public Member Functions inherited from agentxcpp::PDU
bool	get_new_index ()
	Get new_index flag.
void	set_new_index (bool new_index)
	Set new_index flag.
bool	get_any_index ()
	Get any_index flag.
void	set_any_index (bool any_index)
	Set any_index flag.
uint32_t	get_sessionID ()
	Get sessionID.
void	set_sessionID (uint32_t id)
	Set sessionID.
uint32_t	get_transactionID ()
	Get transactionID.
void	set_transactionID (uint32_t id)
	Set transactionID.
uint32_t	get_packetID ()
	Get packetID.
void	set_packetID (uint32_t packetID)
	Set packetID.
virtual binary	serialize () const =0
	Serialize function for concrete PDUs.

Private Attributes
oid	id
	The Object Identifier containing the value of sysORID that should no longer be exported.

Additional Inherited Members
Protected Member Functions inherited from agentxcpp::PDUwithContext
	PDUwithContext (binary::const_iterator &pos, const binary::const_iterator &end, bool big_endian)
	Parse constructor.
void	add_header (type_t type, binary &payload) const
	Add PDU header and context field to the payload.
	PDUwithContext ()
	Default Constructor.
Protected Member Functions inherited from agentxcpp::PDU
	PDU (binary::const_iterator &pos, const binary::const_iterator &end, bool big_endian)
	Parse constructor.
	PDU ()
	Default constructor.
virtual	~PDU ()
	Destructor.

---

Detailed Description

Represents an RemoveAgentCaps-PDU.

Definition at line 32 of file RemoveAgentCapsPDU.hpp.

---

Constructor & Destructor Documentation

RemoveAgentCapsPDU::RemoveAgentCapsPDU	(	binary::const_iterator &	pos,
		const binary::const_iterator &	end,
		bool	big_endian
	)

Parse constructor.

Construct the object by parsing a stream. See Parsing incoming PDUs for details about PDU parsing.

Parameters:

pos	Iterator pointing to the current stream position. The iterator is advanced while reading the header.
end	Iterator pointing one element past the end of the current stream. This is needed to mark the end of the buffer.
big_endian	Whether the serialized form of the PDU is in big_endian format.

Exceptions:

parse_error

If parsing fails, for example because reading the stream fails or the PDU is malformed.

Definition at line 25 of file RemoveAgentCapsPDU.cpp.

agentxcpp::RemoveAgentCapsPDU::RemoveAgentCapsPDU ( )

inline

Default Constructor.

Sets the state of the object to the defaults as set by the PDU::PDUwithContext() constructor. The field 'id' is initialized to be empty.

Definition at line 77 of file RemoveAgentCapsPDU.hpp.

RemoveAgentCapsPDU::RemoveAgentCapsPDU

(

oid

id

)

Constructor.

Sets the state of the object to the defaults as set by the PDU::PDUwithContext() constructor. The field id is initialized according to the parameter.

Parameters:

id	The value of the id field.

Definition at line 52 of file RemoveAgentCapsPDU.cpp.

References id.

---

Member Function Documentation

oid agentxcpp::RemoveAgentCapsPDU::get_id ( )

inline

Get the id field.

Returns:

The id value.

Definition at line 105 of file RemoveAgentCapsPDU.hpp.

References id.

binary RemoveAgentCapsPDU::serialize

(

)

Serialize the PDU.

Definition at line 37 of file RemoveAgentCapsPDU.cpp.

References agentxcpp::PDUwithContext::add_header(), and agentxcpp::PDU::agentxRemoveAgentCapsPDU.

void agentxcpp::RemoveAgentCapsPDU::set_id ( oid  id )

inline

Set the id field.

Parameters:

id	The new id value.

Definition at line 95 of file RemoveAgentCapsPDU.hpp.

References id.

---

Member Data Documentation

oid agentxcpp::RemoveAgentCapsPDU::id

private

The Object Identifier containing the value of sysORID that should no longer be exported.

See RFC 2741, 6.2.15. "The agentx-RemoveAgentCaps-PDU" for details.

Definition at line 42 of file RemoveAgentCapsPDU.hpp.

Referenced by get_id(), RemoveAgentCapsPDU(), and set_id().

---

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

• /home/tanjeff/projekte/agentxcpp/agentXcpp-0.1.1/src/RemoveAgentCapsPDU.hpp
• /home/tanjeff/projekte/agentxcpp/agentXcpp-0.1.1/src/RemoveAgentCapsPDU.cpp