agentxcpp::TimeTicksVariable Class Reference

Represents a TimeTicks as described in RFC 2741. More...

#include <TimeTicksVariable.hpp>

Inheritance diagram for agentxcpp::TimeTicksVariable:

Public Member Functions
	TimeTicksVariable (quint32 initial_value=0)
	(Default) constructor. More...
void	setValue (quint32 _value)
	Set the value. More...
quint32	value ()
	Get the current value. More...
virtual void	perform_get ()
	Perform a Get request. More...
virtual testset_result_t	perform_testset (quint32 _v)
	Perform an SNMP TestSet request. More...
virtual void	perform_cleanupset (quint32 _v)
	Perform an SNMP CleanupSet request. More...
virtual bool	perform_commitset (quint32 _v)
	Perform an SNMP CommitSet request. More...
virtual bool	perform_undoset (quint32 _v)
	Perform an SNMP UndoSet request. More...
virtual Oid	toOid () const
	Convert the value to an OID. More...
Public Member Functions inherited from agentxcpp::AbstractVariable
virtual	~AbstractVariable ()
	Virtual destructor. More...

Protected Attributes
quint32	v
	The TimeTicks value. More...

Additional Inherited Members
Public Types inherited from agentxcpp::AbstractVariable
enum	testset_result_t {   noError = 0, genErr = 5, noAccess = 6, wrongType = 7,   wrongLength = 8, wrongValue = 10, noCreation = 11, inconsistentValue = 12,   resourceUnavailable = 13, notWritable = 17, inconsistentName = 18 }
	Result type for the TestSet validation. More...

Detailed Description

Represents a TimeTicks as described in RFC 2741.

Constructor & Destructor Documentation

agentxcpp::TimeTicksVariable::TimeTicksVariable ( quint32  initial_value = 0 )

inline

(Default) constructor.

Parameters

initial_value

The initial value of the object.

Member Function Documentation

virtual void agentxcpp::TimeTicksVariable::perform_cleanupset ( quint32  _v )

inlinevirtual

Perform an SNMP CleanupSet request.

This method is invoked when an SNMP CleanupSet request is received. It shall release any resources allocated by perform_testset().

The default implementation does nothing. If no action is required to perform the CleanupSet operation, this method need not be overridden.

Parameters

_v	The value to which the variable was (possibly) set.

virtual bool agentxcpp::TimeTicksVariable::perform_commitset ( quint32  _v )

inlinevirtual

Perform an SNMP CommitSet request.

This method is invoked when an SNMP CommitSet request is received. It shall perform the actual write operation.

The default implementation returns false to indicate that the operation failed. To implement a writeable SNMP variable this method must be overridden.

Parameters

_v	The value which shall be written.

Returns

True if the operation succeeded, false otherwise.

virtual void agentxcpp::TimeTicksVariable::perform_get ( )

inlinevirtual

Perform a Get request.

This method is invoked when an SNMP Get request is received. It should update the internal value v.

virtual testset_result_t agentxcpp::TimeTicksVariable::perform_testset ( quint32  _v )

inlinevirtual

Perform an SNMP TestSet request.

This method is invoked when an SNMP TestSet request is received. It shall check whether a Set operation is possible for the variable. It shall acquire the resources needed to perform the Set operation (but the Set operation shall not yet be performed).

The default implementation returns AbstractVariable::noAccess to indicate that this is a read-only variable. Thus, for read-only variables this method need not be overridden.

Parameters

_v	The new value provided by the master agent.

Returns

The result of the check (this is reported to the master agent).

virtual bool agentxcpp::TimeTicksVariable::perform_undoset ( quint32  _v )

inlinevirtual

Perform an SNMP UndoSet request.

This method is invoked when an SNMP UndoSet request is received. It shall undo whatever perform_commitset() performed. It shall also release all resources allocated by perform_testset(), because perform_cleanupset() will not be called afterwards.

The default implementation returns false to indicate that the operation failed. It is strongly recommended that writeable variables override this method.

Parameters

_v	The value just set by perform_commitset().

Returns

True on success, false otherwise.

void agentxcpp::TimeTicksVariable::setValue ( quint32  _value )

inline

Set the value.

Parameters

_value

The new value.

virtual Oid agentxcpp::TimeTicksVariable::toOid ( ) const

inlinevirtual

Convert the value to an OID.

The conversion is done according to RFC 2578, 7.7. "Mapping of the INDEX clause". The value is converted to an Oid with a single subid.

This method should not be overridden.

Note

If a TIMETICK is used in an INDEX clause, the value 0 should be avoided according to RFC 2578, 7.7. "Mapping of the INDEX clause".

Implements agentxcpp::AbstractVariable.

quint32 agentxcpp::TimeTicksVariable::value ( )

inline

Get the current value.

Returns

The value.

Member Data Documentation

quint32 agentxcpp::TimeTicksVariable::v

protected

The TimeTicks value.

According to RFC 2578, TimeTicks is a non-negative 32-bit number.