#include <MessageDefinition.h>

Inheritance diagram for variant_topic_tools::MessageDefinition:

Public Member Functions
void	clear ()
	Clear the message definition.
MessageDataType	getMessageDataType () const
	Retrieve the message data type represented by this message definition.
bool	isValid () const
	True, if this message definition is valid.
void	load (const std::string &messageDataType)
	Attempt to load the message definition for the specified message data type.
	MessageDefinition ()
	Default constructor.
	MessageDefinition (const MessageType &messageType)
	Constructor (overloaded version accepting a message type)
	MessageDefinition (const MessageDataType &messageDataType)
	Constructor (overloaded version accepting a message data type)
	MessageDefinition (const MessageDefinition &src)
	Copy constructor.
void	setMessageDataType (const MessageDataType &messageDataType)
	Set the message data type represented by this message definition.
void	setMessageType (const MessageType &messageType)
	Set the message type represented by this message definition.
template<typename T >
void	setMessageType ()
	Set the message type represented by this message definition (templated version)
void	write (std::ostream &stream) const
	Write the message definition to a stream.
	~MessageDefinition ()
	Destructor.
Static Public Member Functions
template<typename T >
static MessageDefinition	create ()
	Create a message definition.
Protected Member Functions
void	fill (const MessageDataType &currentDataType, MessageFieldCollection< DataType > &currentCollection)
	Recursively fill the fields of the message definition.
Protected Attributes
DataType	messageDataType
	The message data type represented by this message definition.

Detailed Description

Message definition.

Definition at line 41 of file MessageDefinition.h.

Constructor & Destructor Documentation

variant_topic_tools::MessageDefinition::MessageDefinition ( )

Default constructor.

Definition at line 37 of file MessageDefinition.cpp.

variant_topic_tools::MessageDefinition::MessageDefinition ( const MessageType & messageType )

Constructor (overloaded version accepting a message type)

Definition at line 40 of file MessageDefinition.cpp.

variant_topic_tools::MessageDefinition::MessageDefinition ( const MessageDataType & messageDataType )

Constructor (overloaded version accepting a message data type)

Definition at line 44 of file MessageDefinition.cpp.

variant_topic_tools::MessageDefinition::MessageDefinition ( const MessageDefinition & src )

Copy constructor.

Definition at line 48 of file MessageDefinition.cpp.

variant_topic_tools::MessageDefinition::~MessageDefinition ( )

Destructor.

Definition at line 53 of file MessageDefinition.cpp.

Member Function Documentation

void variant_topic_tools::MessageDefinition::clear ( ) [virtual]

Clear the message definition.

Reimplemented from variant_topic_tools::MessageFieldCollection< DataType >.

Definition at line 178 of file MessageDefinition.cpp.

template<typename T >

static MessageDefinition variant_topic_tools::MessageDefinition::create ( ) [static]

Create a message definition.

void variant_topic_tools::MessageDefinition::fill	(	const MessageDataType &	currentDataType,
		MessageFieldCollection< DataType > &	currentCollection
	)		`[protected]`

Recursively fill the fields of the message definition.

Definition at line 183 of file MessageDefinition.cpp.

MessageDataType variant_topic_tools::MessageDefinition::getMessageDataType ( ) const

Retrieve the message data type represented by this message definition.

Definition at line 157 of file MessageDefinition.cpp.

bool variant_topic_tools::MessageDefinition::isValid ( ) const

True, if this message definition is valid.

Definition at line 161 of file MessageDefinition.cpp.

void variant_topic_tools::MessageDefinition::load ( const std::string & messageDataType )

Attempt to load the message definition for the specified message data type.

Definition at line 169 of file MessageDefinition.cpp.

void variant_topic_tools::MessageDefinition::setMessageDataType ( const MessageDataType & messageDataType )

Set the message data type represented by this message definition.

Definition at line 152 of file MessageDefinition.cpp.

void variant_topic_tools::MessageDefinition::setMessageType ( const MessageType & messageType )

Set the message type represented by this message definition.

Definition at line 60 of file MessageDefinition.cpp.

template<typename T >

void variant_topic_tools::MessageDefinition::setMessageType ( )

Set the message type represented by this message definition (templated version)

void variant_topic_tools::MessageDefinition::write ( std::ostream & stream ) const

Write the message definition to a stream.

Definition at line 194 of file MessageDefinition.cpp.

Member Data Documentation

DataType variant_topic_tools::MessageDefinition::messageDataType [protected]

The message data type represented by this message definition.

Definition at line 109 of file MessageDefinition.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation