Siena Fast Forwarding Documentation (v. 1.9.4)

siena::message Class Reference

interface of a generic message in the Siena data model. More...

#include <types.h>

List of all members.

Classes

class  iterator
 interface of a generic message iterator. More...

Public Member Functions

virtual ~message ()
 virtual destructor
virtual iteratorfirst () const =0
 returns an iterator over this message.
virtual attributefind (const string_t &) const =0
 provides direct access to a given attribute.
virtual bool contains (const string_t &) const =0
 test existence of a given attribute.

Detailed Description

interface of a generic message in the Siena data model.

A message is a set of attributes. Individual attributes can be accessed sequentially through a message::iterator, or directly by their name.

Examples:

forwarding_messages.cc, and message_iteration.cc.


Member Function Documentation

virtual attribute* siena::message::find ( const string_t  )  const [pure virtual]

provides direct access to a given attribute.

Finds an attribute in a message based on the attribute's name. Applications must take care of deallocating the objects returned by this method.

Returns:
the given attribute in this message, or NULL if such attribute does not exist.
virtual iterator* siena::message::first (  )  const [pure virtual]

returns an iterator over this message.

The iterator returned by this method must define a complete iteration through the message. The order of the iteration is implementation-dependent.

Returns:
iterator pointing to the first attribute in this message, or NULL if this message is empty.

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