AgentXcpp  Revision:0.1.1
Internals Documentation
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Friends Pages
Public Member Functions
agentxcpp::variable Class Reference

This class represents a SNMP variable. More...

#include <variable.hpp>

Inheritance diagram for agentxcpp::variable:
Collaboration diagram for agentxcpp::variable:

List of all members.

Public Member Functions

virtual binary serialize () const =0
 Serialize the variable.
virtual ~variable ()
 Destructor.
virtual void update ()=0
 Update the internal state of the variable.

Detailed Description

This class represents a SNMP variable.

This class is used as base class for the SNMP variable types (such as Octet_String or Integer). It has no functions or members exposed to the API.

Definition at line 33 of file variable.hpp.

Constructor & Destructor Documentation

virtual agentxcpp::variable::~variable ( )
inlinevirtual

Destructor.

Definition at line 54 of file variable.hpp.

Member Function Documentation

virtual binary agentxcpp::variable::serialize ( ) const
pure virtual

Serialize the variable.

This function must be implemented by all derived classes. The function shall generate a serialized form of the variable.

Returns:
The serialized form of the variable.
Exceptions:
None,:The function shall not throw.

Implemented in agentxcpp::oid, agentxcpp::Counter32, agentxcpp::Counter64, agentxcpp::Gauge32, agentxcpp::TimeTicks, agentxcpp::IpAddress, agentxcpp::Integer, agentxcpp::Octet_String, and agentxcpp::Opaque.

virtual void agentxcpp::variable::update ( )
pure virtual

Update the internal state of the variable.

This function must be implemented in derived classes. It shall update the internal state of the object.

Exceptions:
generic_errorIf obtaining the new value failed. The state of such an object cannot be updated.

Implemented in agentxcpp::oid, agentxcpp::Octet_String, agentxcpp::IpAddress, agentxcpp::Counter32, agentxcpp::Integer, agentxcpp::Counter64, agentxcpp::Gauge32, agentxcpp::TimeTicks, and agentxcpp::Opaque.

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