DBus::MessageAppendIterator Class Reference
[DBus Messages]

Insertion iterator allow values to be appended to a message. More...

#include <messageappenditerator.h>

Public Member Functions
	MessageAppendIterator ()
	MessageAppendIterator (Message &message)
	MessageAppendIterator (DBusCxxPointer< Message > message)
	~MessageAppendIterator ()
const Message *	message () const
	Returns a pointer to the message associated with this iterator or NULL if no message is associated.
DBusMessageIter *	cobj ()
	Returns a pointer to the underlying DBusMessageIter object.
bool	init (Message &message)
	Initializes the iterator for the specified message.
void	invalidate ()
	Invalidates the iterator.
bool	is_valid () const
	True if this is a valid iterator.
	operator bool () const
	True if the iterator is valid and initialized, false otherwise.
bool	append (bool v)
bool	append (uint8_t v)
bool	append (int16_t v)
bool	append (uint16_t v)
bool	append (int32_t v)
bool	append (uint32_t v)
bool	append (int64_t v)
bool	append (uint64_t v)
bool	append (double v)
bool	append (const char *v)
bool	append (const std::string &v)
bool	append (const Signature &v)
bool	append (const Path &v)
bool	append (char v)
bool	append (int8_t v)
bool	append (float v)
bool	append (long int v)
bool	append (long unsigned int v)
template<typename T >
void	append (const std::vector< T > &v)
template<typename T >
MessageAppendIterator &	operator<< (const T &v)
void	open_container (ContainerType t, const std::string &contained_signature)
void	close_container ()
MessageAppendIterator *	sub_iterator ()
Protected Member Functions
template<typename T >
bool	protected_append (const T &v)
bool	protected_append (const bool &v)
bool	protected_append (const std::string &v)
bool	protected_append (const Signature &v)
bool	protected_append (const Path &v)
Protected Attributes
Message *	m_message
DBusMessageIter	m_cobj
MessageAppendIterator *	m_subiter

Detailed Description

Insertion iterator allow values to be appended to a message.

Author:: Rick L Vinyard Jr <rvinyard@cs.nmsu.edu>

Constructor & Destructor Documentation

DBus::MessageAppendIterator::MessageAppendIterator ( )

References m_cobj.

Referenced by open_container().

DBus::MessageAppendIterator::MessageAppendIterator ( Message & message )

References init(), and m_cobj.

DBus::MessageAppendIterator::MessageAppendIterator ( DBusCxxPointer< Message > message )

DBus::MessageAppendIterator::~MessageAppendIterator ( )

Member Function Documentation

template<typename T >

void DBus::MessageAppendIterator::append ( const std::vector< T > & v ) [inline]

References close_container(), DBus::CONTAINER_ARRAY, m_subiter, and open_container().

bool DBus::MessageAppendIterator::append ( long unsigned int v )

References protected_append().

bool DBus::MessageAppendIterator::append ( long int v )

References protected_append().

bool DBus::MessageAppendIterator::append ( float v )

References protected_append().

bool DBus::MessageAppendIterator::append ( int8_t v )

References protected_append().

bool DBus::MessageAppendIterator::append ( char v )

References protected_append().

bool DBus::MessageAppendIterator::append ( const Path & v )

References protected_append().

bool DBus::MessageAppendIterator::append ( const Signature & v )

References protected_append().

bool DBus::MessageAppendIterator::append ( const std::string & v )

References protected_append().

bool DBus::MessageAppendIterator::append ( const char * v )

References protected_append().

bool DBus::MessageAppendIterator::append ( double v )

References protected_append().

bool DBus::MessageAppendIterator::append ( uint64_t v )

References protected_append().

bool DBus::MessageAppendIterator::append ( int64_t v )

References protected_append().

bool DBus::MessageAppendIterator::append ( uint32_t v )

References protected_append().

bool DBus::MessageAppendIterator::append ( int32_t v )

References protected_append().

bool DBus::MessageAppendIterator::append ( uint16_t v )

References protected_append().

bool DBus::MessageAppendIterator::append ( int16_t v )

References protected_append().

bool DBus::MessageAppendIterator::append ( uint8_t v )

References protected_append().

bool DBus::MessageAppendIterator::append ( bool v )

References protected_append().

Referenced by operator<<().

void DBus::MessageAppendIterator::close_container ( )

References cobj(), m_cobj, and m_subiter.

Referenced by append(), and open_container().

DBusMessageIter * DBus::MessageAppendIterator::cobj ( )

Returns a pointer to the underlying DBusMessageIter object.

References m_cobj.

Referenced by close_container(), and open_container().

bool DBus::MessageAppendIterator::init ( Message & message )

Initializes the iterator for the specified message.

References DBus::Message::cobj(), m_cobj, m_message, and m_subiter.

Referenced by MessageAppendIterator().

void DBus::MessageAppendIterator::invalidate ( )

Invalidates the iterator.

References m_cobj, m_message, and m_subiter.

bool DBus::MessageAppendIterator::is_valid ( ) const

True if this is a valid iterator.

References DBus::Message::is_valid(), and m_message.

Referenced by operator bool(), and protected_append().

const Message* DBus::MessageAppendIterator::message ( ) const

Returns a pointer to the message associated with this iterator or NULL if no message is associated.

void DBus::MessageAppendIterator::open_container	(	ContainerType	t,
		const std::string &	contained_signature
	)

References close_container(), cobj(), DBus::CONTAINER_DICT_ENTRY, DBus::CONTAINER_STRUCT, m_cobj, m_message, m_subiter, and MessageAppendIterator().

Referenced by append().

DBus::MessageAppendIterator::operator bool ( ) const

True if the iterator is valid and initialized, false otherwise.

References is_valid().

template<typename T >

MessageAppendIterator& DBus::MessageAppendIterator::operator<< ( const T & v ) [inline]

References append().

bool DBus::MessageAppendIterator::protected_append ( const Path & v ) [protected]

References DBus::Message::invalidate(), is_valid(), m_cobj, m_message, and DBus::TYPE_OBJECT_PATH.

bool DBus::MessageAppendIterator::protected_append ( const Signature & v ) [protected]

References DBus::Message::invalidate(), is_valid(), m_cobj, m_message, and DBus::TYPE_SIGNATURE.

bool DBus::MessageAppendIterator::protected_append ( const std::string & v ) [protected]

References protected_append().

bool DBus::MessageAppendIterator::protected_append ( const bool & v ) [protected]

References DBus::Message::invalidate(), is_valid(), m_cobj, m_message, and DBus::TYPE_BOOLEAN.

template<typename T >

bool DBus::MessageAppendIterator::protected_append ( const T & v ) [inline, protected]

References DBus::Message::invalidate(), is_valid(), m_cobj, m_message, and DBus::type().

Referenced by append(), and protected_append().

MessageAppendIterator * DBus::MessageAppendIterator::sub_iterator ( )

References m_subiter.

Member Data Documentation

DBusMessageIter DBus::MessageAppendIterator::m_cobj [protected]

Referenced by close_container(), cobj(), init(), invalidate(), MessageAppendIterator(), open_container(), and protected_append().

Message* DBus::MessageAppendIterator::m_message [protected]

Referenced by init(), invalidate(), is_valid(), open_container(), and protected_append().

MessageAppendIterator* DBus::MessageAppendIterator::m_subiter [protected]

Referenced by append(), close_container(), init(), invalidate(), open_container(), and sub_iterator().

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

DBus::MessageAppendIterator Class Reference [DBus Messages]

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

DBus::MessageAppendIterator Class Reference
[DBus Messages]