lmsg::DataMsg< T, MsgID > Class Template Reference
[DMT message facility]

#include <DataMsg.hh>

Inheritance diagram for lmsg::DataMsg< T, MsgID >:

List of all members.

Public Member Functions
	DataMsg (void)
	DataMsg (const DataMsg< T, MsgID > &x)
	DataMsg (const T &x)
virtual	~DataMsg (void)
size_type	size (void) const
void	getData (TransOutput &out) const
MsgHeader::MsgType	getType (void) const
void	setData (TransInput &in) throw (std::runtime_error)
T &	refData (void)
	Reference message data.
const T &	refData (void) const
	Reference constant message data.

---

Detailed Description

template<class T, unsigned int MsgID>
class lmsg::DataMsg< T, MsgID >

Template for messages with a single data item. The data item may be any defined class with the following properties.

• A copy constructor
• An operator>>(TransInput&, T&) defined either intrinsically in the TransInput class or as an external function.
• An operator<<(TransOutput&,const T&) defined either intrinsically in the TransOutput class or as an external function.

brief Data message template.

Author:

John Zweizig

Version:

Revision

1.3

; Modified

Date

2008/04/15 21:07:53

---

Constructor & Destructor Documentation

template<class T, unsigned int MsgID>

lmsg::DataMsg< T, MsgID >::DataMsg

(

void

)

[inline]

Construct a message. brief Default constructor.

template<class T, unsigned int MsgID>

lmsg::DataMsg< T, MsgID >::DataMsg

(

const DataMsg< T, MsgID > &

x

)

[inline]

Construct a message identical to an existing message. brief Copy constructor.

template<class T, unsigned int MsgID>

lmsg::DataMsg< T, MsgID >::DataMsg

(

const T &

x

)

[inline, explicit]

Construct a message and initialize data to a specified value. brief Data constructor.

template<class T, unsigned int MsgID>

virtual lmsg::DataMsg< T, MsgID >::~DataMsg

(

void

)

[inline, virtual]

Destroy a message. brief Default destructor.

---

Member Function Documentation

template<class T, unsigned int MsgID>

size_type lmsg::DataMsg< T, MsgID >::size

(

void

)

const [inline, virtual]

Get the message text length. brief Text length.

Returns:

Always zero for dataless messages.

Implements lmsg::Message.

template<class T, unsigned int MsgID>

void lmsg::DataMsg< T, MsgID >::getData

(

TransOutput &

out

)

const [virtual]

Write the message data to translation stream. brief Get message data.

Implements lmsg::Message.

template<class T, unsigned int MsgID>

MsgHeader::MsgType lmsg::DataMsg< T, MsgID >::getType

(

void

)

const [inline, virtual]

Get the message type. brief Message type.

Returns:

As specified by template argument.

Implements lmsg::Message.

template<class T, unsigned int MsgID>

void lmsg::DataMsg< T, MsgID >::setData

(

TransInput &

in

)

throw (std::runtime_error) [virtual]

Read data from a transltion stream into the message. brief Set message data.

Implements lmsg::Message.

template<class T, unsigned int MsgID>

T& lmsg::DataMsg< T, MsgID >::refData

(

void

)

[inline]

Reference message data.

Get a reference to the data portion of the message.

Returns:

Reference to data portion of message.

template<class T, unsigned int MsgID>

const T& lmsg::DataMsg< T, MsgID >::refData

(

void

)

const [inline]

Reference constant message data.

Get a reference to the data portion of the message.

Returns:

Constant reference to data portion of message.

---

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

• lmsg/DataMsg.hh

---