Siena Fast Forwarding Documentation (v. 1.13.0)
Public Member Functions | List of all members
siena::message::iterator Class Referenceabstract

interface of a generic message iterator. More...

#include <types.h>

Inheritance diagram for siena::message::iterator:
Inheritance graph
[legend]
Collaboration diagram for siena::message::iterator:
Collaboration graph
[legend]

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_t name () const =0
 returns the name of this attribute.
 
- Public Member Functions inherited from siena::value
virtual ~value ()
 virtual destructor
 
virtual type_id type () const =0
 returns the actual type identifier of this value. More...
 
virtual int_t int_value () const =0
 returns this value as an integer. More...
 
virtual string_t string_value () const =0
 returns this value as a string. More...
 
virtual bool_t bool_value () const =0
 returns this value as a boolean. More...
 
virtual double_t 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, and simple_types.cc.

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.
Examples:
message_iteration.cc.