DBus::MessageAppendIterator Class Reference

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

#include <messageappenditerator.h>

Public Member Functions
	MessageAppendIterator (ContainerType container=ContainerType::None)
	MessageAppendIterator (Message &message, ContainerType container=ContainerType::None)
	MessageAppendIterator (std::shared_ptr< Message > message, ContainerType container=ContainerType::None)
	~MessageAppendIterator ()
const Message *	message () const
	Returns a pointer to the message associated with this iterator or NULL if no message is associated. More...
void	invalidate ()
	Invalidates the iterator. More...
bool	is_valid () const
	True if this is a valid iterator. More...
	operator bool () const
	True if the iterator is valid and initialized, false otherwise. More...
MessageAppendIterator &	operator<< (const bool &v)
MessageAppendIterator &	operator<< (const uint8_t &v)
MessageAppendIterator &	operator<< (const int16_t &v)
MessageAppendIterator &	operator<< (const uint16_t &v)
MessageAppendIterator &	operator<< (const int32_t &v)
MessageAppendIterator &	operator<< (const uint32_t &v)
MessageAppendIterator &	operator<< (const int64_t &v)
MessageAppendIterator &	operator<< (const uint64_t &v)
MessageAppendIterator &	operator<< (const double &v)
MessageAppendIterator &	operator<< (const char *v)
MessageAppendIterator &	operator<< (const std::string &v)
MessageAppendIterator &	operator<< (const Signature &v)
MessageAppendIterator &	operator<< (const Path &v)
MessageAppendIterator &	operator<< (const std::shared_ptr< FileDescriptor > v)
MessageAppendIterator &	operator<< (const Variant &v)
template<typename ... T>
MessageAppendIterator &	operator<< (const MultipleReturn< T... > &v)
template<typename T >
MessageAppendIterator &	operator<< (const std::vector< T > &v)
template<typename Key , typename Data >
MessageAppendIterator &	operator<< (const std::map< Key, Data > &dictionary)
template<typename... T>
MessageAppendIterator &	operator<< (const std::tuple< T... > &tup)

Private Member Functions
bool	open_container (ContainerType t, const std::string &contained_signature)
bool	close_container ()
MessageAppendIterator *	sub_iterator ()

Private Attributes
std::shared_ptr< priv_data >	m_priv

Detailed Description

Insertion iterator allow values to be appended to a message.

Author

Rick L Vinyard Jr rviny.nosp@m.ard@.nosp@m.cs.nm.nosp@m.su.e.nosp@m.du

Constructor & Destructor Documentation

MessageAppendIterator() [1/3]

DBus::MessageAppendIterator::MessageAppendIterator

(

ContainerType

container = ContainerType::None

)

References m_priv.

Referenced by open_container().

MessageAppendIterator() [2/3]

DBus::MessageAppendIterator::MessageAppendIterator	(	Message &	message,
		ContainerType	container = ContainerType::None
	)

References DBus::Message::body(), DBus::default_endianess(), m_priv, message(), and DBus::None.

MessageAppendIterator() [3/3]

DBus::MessageAppendIterator::MessageAppendIterator	(	std::shared_ptr< Message >	message,
		ContainerType	container = ContainerType::None
	)

References DBus::Message::body(), DBus::default_endianess(), m_priv, message(), and DBus::None.

~MessageAppendIterator()

DBus::MessageAppendIterator::~MessageAppendIterator

(

)

Member Function Documentation

close_container()

bool DBus::MessageAppendIterator::close_container ( )

private

References DBus::ARRAY, DBus::DICT_ENTRY, m_priv, DBus::Validator::maximum_array_size(), DBus::None, DBus::STRUCT, and DBus::VARIANT.

Referenced by open_container(), and operator<<().

invalidate()

void DBus::MessageAppendIterator::invalidate

(

)

Invalidates the iterator.

References m_priv.

is_valid()

bool DBus::MessageAppendIterator::is_valid

(

)

const

True if this is a valid iterator.

References m_priv.

Referenced by operator<<().

message()

const Message* DBus::MessageAppendIterator::message

(

)

const

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

Referenced by MessageAppendIterator().

open_container()

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

private

References DBus::TypeInfo::alignment(), DBus::ARRAY, DBus::Signature::begin(), close_container(), DBus::DICT_ENTRY, m_priv, MessageAppendIterator(), DBus::None, DBus::signature(), DBus::STRUCT, DBus::SignatureIterator::type(), and DBus::VARIANT.

Referenced by operator<<().

operator bool()

DBus::MessageAppendIterator::operator bool

(

)

const

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

operator<<() [1/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const bool &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [2/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const char *

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [3/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const double &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [4/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const int16_t &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [5/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const int32_t &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [6/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const int64_t &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [7/19]

template<typename ... T>

MessageAppendIterator& DBus::MessageAppendIterator::operator<< ( const MultipleReturn< T... > &  v )

inline

References DBus::MultipleReturn< Ts >::m_data, DBus::signature(), and DBus::signature_multiple_return_data().

operator<<() [8/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const Path &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [9/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const Signature &

v

)

References is_valid(), m_priv, DBus::None, DBus::signature(), and DBus::Signature::str().

operator<<() [10/19]

template<typename Key , typename Data >

MessageAppendIterator& DBus::MessageAppendIterator::operator<< ( const std::map< Key, Data > &  dictionary )

inline

References DBus::ARRAY, close_container(), DBus::DICT_ENTRY, open_container(), DBus::signature_dict_data(), and sub_iterator().

operator<<() [11/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const std::shared_ptr< FileDescriptor >

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [12/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const std::string &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [13/19]

template<typename... T>

MessageAppendIterator& DBus::MessageAppendIterator::operator<< ( const std::tuple< T... > &  tup )

inline

References close_container(), open_container(), DBus::signature(), DBus::STRUCT, and sub_iterator().

operator<<() [14/19]

template<typename T >

MessageAppendIterator& DBus::MessageAppendIterator::operator<< ( const std::vector< T > &  v )

inline

References DBus::ARRAY, close_container(), open_container(), DBus::signature(), sub_iterator(), and DBus::type().

operator<<() [15/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const uint16_t &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [16/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const uint32_t &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [17/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const uint64_t &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [18/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const uint8_t &

v

)

References is_valid(), m_priv, DBus::None, and DBus::signature().

operator<<() [19/19]

MessageAppendIterator & DBus::MessageAppendIterator::operator<<

(

const Variant &

v

)

References DBus::ARRAY, DBus::Signature::begin(), close_container(), DBus::Variant::data_alignment(), DBus::DICT_ENTRY, DBus::Signature::end(), DBus::INVALID, is_valid(), m_priv, DBus::Variant::marshaled(), open_container(), DBus::SignatureIterator::recurse(), DBus::Variant::signature(), DBus::Variant::type(), and DBus::VARIANT.

sub_iterator()

MessageAppendIterator * DBus::MessageAppendIterator::sub_iterator ( )

private

References m_priv.

Referenced by operator<<().

Member Data Documentation

m_priv

std::shared_ptr<priv_data> DBus::MessageAppendIterator::m_priv

private

Referenced by close_container(), invalidate(), is_valid(), MessageAppendIterator(), open_container(), operator<<(), and sub_iterator().

---

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

• messageappenditerator.h
• messageappenditerator.cpp