agentxcpp::TimeTicks Class Reference

Represents an TimeTicks as descibed in RFC 2741. More...

#include <TimeTicks.hpp>

Inheritance diagram for agentxcpp::TimeTicks:

Collaboration diagram for agentxcpp::TimeTicks:

List of all members.

Public Member Functions
	TimeTicks ()
	Create an TimeTicks without initialization.
	TimeTicks (binary::const_iterator &pos, const binary::const_iterator &end, bool big_endian=true)
	Construct the object from input stream.
virtual binary	serialize () const
	Encode the object as described in RFC 2741, section 5.4.
virtual void	update ()
	Update the internal state of the object.
virtual uint32_t	get ()
	Obtain the current value for the object.
Public Member Functions inherited from agentxcpp::variable
virtual	~variable ()
	Destructor.

Private Attributes
uint32_t	value
	The TimeTicks value.

---

Detailed Description

Represents an TimeTicks as descibed in RFC 2741.

Definition at line 34 of file TimeTicks.hpp.

---

Constructor & Destructor Documentation

agentxcpp::TimeTicks::TimeTicks ( )

inline

Create an TimeTicks without initialization.

The value after creation is undefined.

Definition at line 53 of file TimeTicks.hpp.

TimeTicks::TimeTicks	(	binary::const_iterator &	pos,
		const binary::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:

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 input stream is in big endian format

Definition at line 36 of file TimeTicks.cpp.

References agentxcpp::read32(), and value.

---

Member Function Documentation

virtual uint32_t agentxcpp::TimeTicks::get ( )

inlinevirtual

Obtain the current value for the object.

This member function is derived by classes representing SNMP variables and shall return the current value of the object.

The default implementation throws generic_error.

Returns:

The current value of the object.

Exceptions:

generic_error

If obtaining the current value fails. No other exception shall be thrown.

Definition at line 120 of file TimeTicks.hpp.

binary TimeTicks::serialize ( ) const

virtual

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

This function uses big endian.

Implements agentxcpp::variable.

Definition at line 25 of file TimeTicks.cpp.

References value, and agentxcpp::write32().

virtual void agentxcpp::TimeTicks::update ( )

inlinevirtual

Update the internal state of the object.

This function calls get() to obtain a new value and writes that value to the 'value' member.

Exceptions:

generic_error

If obtaining the new value failed.

Implements agentxcpp::variable.

Definition at line 102 of file TimeTicks.hpp.

References value.

---

Member Data Documentation

uint32_t agentxcpp::TimeTicks::value

private

The TimeTicks value.

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

Definition at line 43 of file TimeTicks.hpp.

Referenced by serialize(), TimeTicks(), and update().

---

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

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