agentxcpp::Integer Class Reference

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

#include <Integer.hpp>

Inheritance diagram for agentxcpp::Integer:

Collaboration diagram for agentxcpp::Integer:

List of all members.

Public Member Functions
	Integer (int32_t _value=0)
	Create an Integer object.
virtual data_t	serialize () const
	Encode the object as described in RFC 2741, section 5.4.
	Integer (data_t::const_iterator &pos, const data_t::const_iterator &end, bool big_endian=true)
	Construct the object from input stream.
virtual void	update ()
	Update the internal state of the object.
virtual int32_t	get ()
	Obtain the current value for the object.
Private Attributes
int32_t	value
	The Integer value.

---

Detailed Description

Represents an Integer as descibed in RFC 2741.

Definition at line 32 of file Integer.hpp.

---

Constructor & Destructor Documentation

agentxcpp::Integer::Integer

(

int32_t

_value = 0

)

[inline]

Create an Integer object.

The default value of the new object is 0.

Exceptions:

None.

Definition at line 52 of file Integer.hpp.

Integer::Integer	(	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:

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 38 of file Integer.cpp.

References value.

---

Member Function Documentation

virtual int32_t agentxcpp::Integer::get

(

)

[inline, virtual]

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 119 of file Integer.hpp.

data_t Integer::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 24 of file Integer.cpp.

References value.

virtual void agentxcpp::Integer::update

(

)

[inline, virtual]

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 101 of file Integer.hpp.

References value.

---

Member Data Documentation

int32_t agentxcpp::Integer::value [private]

The Integer value.

According to RFC 2578, INTEGER is a signed 32-bit number.

Definition at line 40 of file Integer.hpp.

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

---

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

• /home/tanjeff/projekte/agentxcpp/src/Integer.hpp
• /home/tanjeff/projekte/agentxcpp/src/Integer.cpp