interface of a generic message iterator. More...

#include <attributes.h>

Inheritance diagram for siena::Message::Iterator:

Collaboration diagram for siena::Message::Iterator:

Public Member Functions
virtual bool	next ()=0
	moves this iterator to the next attribute in the sequence. More...

virtual	~Iterator ()
	iterator destructor.

Public Member Functions inherited from siena::Attribute
virtual	~Attribute ()
	virtual destructor

virtual String	name () const =0
	returns the name of this attribute.

Public Member Functions inherited from siena::Value
virtual	~Value ()
	virtual destructor

virtual TypeId	type () const =0
	returns the actual type of this value.

virtual Int	int_value () const =0
	returns this value as an integer. More...

virtual String	string_value () const =0
	returns this value as a string. More...

virtual Bool	bool_value () const =0
	returns this value as a boolean. More...

virtual Double	double_value () const =0
	returns this value as a double. More...

Detailed Description

interface of a generic message iterator.

provides sequential access to the attributes of a message.

Examples:: message_iteration.cc, simple_attributes_types.cc, and simple_attributes_types.h.

Member Function Documentation

virtual bool siena::Message::Iterator::next ( )

pure virtual

moves this iterator to the next attribute in the sequence.

Returns: true if the element pointed to by this iterator before this call to next() is not the last attribute in its message. In this case, after this call to next(), this iterator will point to the next attribute.
false if the element pointed to by this iterator before this call to next() is either the the last attribute in its message, or an invalid attribute. In this case, after this call to next(), this iterator will point to an invalid attribute.