Siena Simplification Library Documentation (v. 1.1.4)

Message Class Reference

Implementation of the siena::message interface. More...

#include <ssimp_types.h>

List of all members.

Public Member Functions

Message ()

Default constructor.

Message (const Message &m)

Copy constructor.

const Message & operator= (const Message &m)

Assignment operator.

void add (const std::string &name, bool val)

Adds a boolean attribute to the message with the given name and value.

void add (const std::string &name, double val)

Adds a real attribute to the message with the given name and value.

void add (const std::string &name, int val)

Adds a integer attribute to the message with the given name and value.

void add (const std::string &name, const std::string &val)

Adds a string attribute to the message with the given name and value.

bool contains (const siena::string_t &name) const

Returns true if the specified attribute exists in the message, false otherwise.

siena::message::iterator * first () const

Returns a siena::message::iterator over the attributes if the message is non-empty, NULL otherwise.

siena::attribute * find (const siena::string_t &name) const

Method providing direct access the named attribute.

const std::map< std::string,
Value > & getAttributes () const

Provides access to the internal attribute map.

size_t bytesize () const

Returns the number of bytes required to store the message.

int size () const

Returns the number of attributes contained in the message.

std::string str () const

Returns a string representation of the Messages.

Classes

class Iterator

Implementation of the siena::message::iterator interface. More...

class Value

Class used as the internal storage of attribute values. More...

Detailed Description

Implementation of the siena::message interface.

Member Function Documentation

siena::attribute* Message::find ( const siena::string_t & name ) const [inline]

Method providing direct access the named attribute.
Returns a pointer to the specified attribute if the attribute exists in the message, NULL otherwise.

std::string Message::str ( ) const

Returns a string representation of the Messages.
This method is used primarily for debugging and logging purposes.

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

ssimp_types.h


Public Member Functions
	Message ()
	Default constructor.
	Message (const Message &m)
	Copy constructor.
const Message &	operator= (const Message &m)
	Assignment operator.
void	add (const std::string &name, bool val)
	Adds a boolean attribute to the message with the given name and value.
void	add (const std::string &name, double val)
	Adds a real attribute to the message with the given name and value.
void	add (const std::string &name, int val)
	Adds a integer attribute to the message with the given name and value.
void	add (const std::string &name, const std::string &val)
	Adds a string attribute to the message with the given name and value.
bool	contains (const siena::string_t &name) const
	Returns true if the specified attribute exists in the message, false otherwise.
siena::message::iterator *	first () const
	Returns a `siena::message::iterator` over the attributes if the message is non-empty, NULL otherwise.
siena::attribute *	find (const siena::string_t &name) const
	Method providing direct access the named attribute.
const std::map< std::string, Value > &	getAttributes () const
	Provides access to the internal attribute map.
size_t	bytesize () const
	Returns the number of bytes required to store the message.
int	size () const
	Returns the number of attributes contained in the message.
std::string	str () const
	Returns a string representation of the Messages.
Classes
class	Iterator
	Implementation of the `siena::message::iterator` interface. More...
class	Value
	Class used as the internal storage of attribute values. More...