iso::com::iso::com::Message Class Reference

#include <iso_com_message_source.h>

List of all members.

Public Member Functions

 Message ()
 default constructor
 Message (const Message &pMessage)
 copy constructor
 ~Message ()
 destructor
const Messageoperator= (const Message &pMessage)
 assignment operator
unsigned int valueGroupCount () const
 return number of value groups
const MessageValueGroupvalueGroup (unsigned int pValueGroupIndex) const throw (ComException)
 return message value group
const QVector< MessageValueGroup * > & valueGroups () const
 return message value groups
unsigned int valueCount (unsigned int pValueGroupIndex) const
 return number of values in value group
template<class Type>
bool checkValues (unsigned int pValueGroupIndex) const
 check values
template<class Type, int ValueCount>
bool checkValues (unsigned int pValueGroupIndex) const
 check values
template<class Type>
const Type * values (unsigned int pValueGroupIndex) const throw (ComException)
 return values
template<class Type>
void addValues (unsigned int pValueCount, Type *pValues)
 add values
void addValues (MessageValueGroup *pValueGroup)
 add value group
void removeValues (unsigned int pValueGroupIndex) throw (ComException)
 remove values
void clear ()
 remove and deleted all value groups
base::String info () const
 print textual message information

Protected Attributes

QVector< MessageValueGroup * > mValueGroups

Friends

std::ostream & operator<< (std::ostream &pOstream, const Message &pMessage)
 print message information


Constructor & Destructor Documentation

iso::com::Message::Message (  ) 

default constructor

iso::com::Message::Message ( const Message pMessage  ) 

copy constructor

Parameters:
pMessage message to copy

iso::com::Message::~Message (  ) 

destructor


Member Function Documentation

const Message & iso::com::Message::operator= ( const Message pMessage  ) 

assignment operator

Parameters:
pMessage message to copy value groups from
Returns:
message reference

unsigned int iso::com::Message::valueGroupCount (  )  const

return number of value groups

Returns:
number of value groups

const MessageValueGroup & iso::com::Message::valueGroup ( unsigned int  pValueGroupIndex  )  const throw (ComException)

return message value group

Parameters:
pValueGroupIndex value group index
Returns:
value group
Exceptions:
ComException value group index out of bounds

const QVector< MessageValueGroup * > & iso::com::Message::valueGroups (  )  const

return message value groups

unsigned int iso::com::Message::valueCount ( unsigned int  pValueGroupIndex  )  const

return number of values in value group

Parameters:
pValueGroupIndex value group index
Returns:
number of values in value group
Exceptions:
ComException value group index out of bounds

template<class Type, int ValueCount>
bool iso::com::iso::com::Message::checkValues ( unsigned int  pValueGroupIndex  )  const

check values

Parameters:
pValueGroupIndex value group index
Returns:
true if value group matches type, false otherwise
Exceptions:
ComException value group index out of bounds

template<class Type, int ValueCount>
bool iso::com::iso::com::Message::checkValues ( unsigned int  pValueGroupIndex  )  const

check values

Parameters:
pValueGroupIndex value group index
Returns:
true if value group matches type and value count, false otherwise
Exceptions:
ComException value group index out of bounds

template<class Type>
const Type * iso::com::iso::com::Message::values ( unsigned int  pValueGroupIndex  )  const throw (ComException)

return values

Parameters:
pValueGroupIndex value group index
Returns:
array of typed values
Exceptions:
ComException value group index out of bounds or type mismatch

template<class Type>
void iso::com::iso::com::Message::addValues ( unsigned int  pValueCount,
Type *  pValues 
)

add values

Parameters:
pValueCount number of values
pValues values
Remarks:
: creates new value group containing a copy of passed values

void iso::com::Message::addValues ( MessageValueGroup pValueGroup  ) 

add value group

Parameters:
pValueGroup value group
Remarks:
value group is added to message (no copy is created, i.e, this value group will be deleted when the message is destroyed)

void iso::com::Message::removeValues ( unsigned int  pValueGroupIndex  )  throw (ComException)

remove values

Parameters:
pValueGroupIndex index of value group
Exceptions:
index out of bounds

void iso::com::Message::clear (  ) 

remove and deleted all value groups

base::String iso::com::Message::info (  )  const

print textual message information


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  pOstream,
const Message pMessage 
) [friend]

print message information

Parameters:
pOstream output stream
pMessage message


Member Data Documentation

QVector< MessageValueGroup* > iso::com::iso::com::Message::mValueGroups [protected]


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 13:53:12 2011 for iso_com by  doxygen 1.5.1