DtRtiMsgParam< ParamType, NetParamType > Class Template Reference

The template for an RTI message parameter. More...

Inheritance diagram for DtRtiMsgParam< ParamType, NetParamType >:

Collaboration diagram for DtRtiMsgParam< ParamType, NetParamType >:

Public Member Functions
	DtRtiMsgParam (const char *paramName)
	~DtRtiMsgParam ()
void	setParam (ParamType val)
	Sets the value of the parameter.
void	setParamRef (const ParamType &val)
	Sets the value of the parameter by reference.
ParamType	param () const
	Gets the value of the parameter.
void	getParam (ParamType &val) const
	Gets the value of the parameter by reference.
void *	endPtr ()
	Returns a pointer to location just after this parameter in the message.
const void *	endPtr () const
unsigned	minSize ()
	Returns the minimum size of this parameter.
unsigned	elementSize ()
	Returns the size of single element in this parameter.
void	print () const
	Prints the parameter.
void	setOctetBoundary (unsigned prevBoundary)
	Sets the octet boundary of the parameter in the message based on the boundary of this parameter and the boundary of the previous parameter.
Public Member Functions inherited from DtRtiBaseMsgParam
	~DtRtiBaseMsgParam ()
void	setPrevParam (DtRtiBaseMsgParam *prevParam)
	Sets the pointer to the previous parameter in the message.
void *	beginPtr ()
	Returns a pointer to the start of this parameter in the message.
const void *	beginPtr () const
virtual const char *	name () const
	Returns the parameter name.
unsigned	octetBoundary () const
	Returns the octet boundary of the parameter in the message.

Protected Member Functions
	DtRtiMsgParam (const DtRtiMsgParam &)
NetParamType *	paramPtr ()
	Returns a pointer to location of this parameter in the message.
const NetParamType *	paramPtr () const
Protected Member Functions inherited from DtRtiBaseMsgParam
	DtRtiBaseMsgParam (const char *paramName)

Additional Inherited Members
Protected Attributes inherited from DtRtiBaseMsgParam
DtRtiBaseMsgParam *	myPrevParam
	Pointer to the previous parameter in this message.
unsigned	myOctetBoundary
	Octet boundary of this parameter.
const char *	myName
	The parameter name.

Detailed Description

template<typename ParamType, typename NetParamType>
class DtRtiMsgParam< ParamType, NetParamType >

The template for an RTI message parameter.

Constructor & Destructor Documentation

template<typename ParamType, typename NetParamType>

DtRtiMsgParam< ParamType, NetParamType >::DtRtiMsgParam ( const char *  paramName )

inline

template<typename ParamType, typename NetParamType>

DtRtiMsgParam< ParamType, NetParamType >::~DtRtiMsgParam ( )

inline

template<typename ParamType, typename NetParamType>

DtRtiMsgParam< ParamType, NetParamType >::DtRtiMsgParam ( const DtRtiMsgParam< ParamType, NetParamType > &  )

protected

Member Function Documentation

template<typename ParamType, typename NetParamType>

unsigned DtRtiMsgParam< ParamType, NetParamType >::elementSize ( )

inlinevirtual

Returns the size of single element in this parameter.

Only really used for array parameters.

Implements DtRtiBaseMsgParam.

template<typename ParamType, typename NetParamType>

void* DtRtiMsgParam< ParamType, NetParamType >::endPtr ( )

inlinevirtual

Returns a pointer to location just after this parameter in the message.

Implements DtRtiBaseMsgParam.

template<typename ParamType, typename NetParamType>

const void* DtRtiMsgParam< ParamType, NetParamType >::endPtr ( ) const

inlinevirtual

Implements DtRtiBaseMsgParam.

template<typename ParamType, typename NetParamType>

void DtRtiMsgParam< ParamType, NetParamType >::getParam ( ParamType &  val ) const

inline

Gets the value of the parameter by reference.

template<typename ParamType, typename NetParamType>

unsigned DtRtiMsgParam< ParamType, NetParamType >::minSize ( )

inlinevirtual

Returns the minimum size of this parameter.

Implements DtRtiBaseMsgParam.

Referenced by DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::setOctetBoundary().

template<typename ParamType, typename NetParamType>

ParamType DtRtiMsgParam< ParamType, NetParamType >::param ( ) const

inline

Gets the value of the parameter.

Referenced by DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >::print(), and DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::print().

template<typename ParamType, typename NetParamType>

NetParamType* DtRtiMsgParam< ParamType, NetParamType >::paramPtr ( )

inlineprotected

Returns a pointer to location of this parameter in the message.

Referenced by DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >::endPtr(), DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::endPtr(), DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >::getParam(), DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::getParam(), DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >::param(), DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::param(), DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::setParam(), DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >::setParamRef(), and DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::setParamRef().

template<typename ParamType, typename NetParamType>

const NetParamType* DtRtiMsgParam< ParamType, NetParamType >::paramPtr ( ) const

inlineprotected

template<typename ParamType, typename NetParamType>

void DtRtiMsgParam< ParamType, NetParamType >::print ( ) const

inlinevirtual

Prints the parameter.

Implements DtRtiBaseMsgParam.

template<typename ParamType, typename NetParamType>

void DtRtiMsgParam< ParamType, NetParamType >::setOctetBoundary ( unsigned  prevBoundary )

inlinevirtual

Sets the octet boundary of the parameter in the message based on the boundary of this parameter and the boundary of the previous parameter.

Octet boundaries are % 8 (64 bit).

Implements DtRtiBaseMsgParam.

template<typename ParamType, typename NetParamType>

void DtRtiMsgParam< ParamType, NetParamType >::setParam ( ParamType  val )

inline

Sets the value of the parameter.

template<typename ParamType, typename NetParamType>

void DtRtiMsgParam< ParamType, NetParamType >::setParamRef ( const ParamType &  val )

inline

Sets the value of the parameter by reference.

---

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

• rtiTemplateMsgParams.h