DtRtiBaseMsgParam Class Reference

The base class for all templated RTI message parameters. More...

Inheritance diagram for DtRtiBaseMsgParam:

Collaboration diagram for DtRtiBaseMsgParam:

Public Member Functions
	~DtRtiBaseMsgParam ()
void	setPrevParam (DtRtiBaseMsgParam *prevParam)
	Sets the pointer to the previous parameter in the message.
virtual void *	endPtr ()=0
	Returns a pointer to location just after this parameter in the message.
virtual const void *	endPtr () const =0
void *	beginPtr ()
	Returns a pointer to the start of this parameter in the message.
const void *	beginPtr () const
virtual unsigned	minSize ()=0
	Returns the minimum size of this parameter.
virtual void	print () const =0
	Prints the parameter.
virtual const char *	name () const
	Returns the parameter name.
unsigned	octetBoundary () const
	Returns the octet boundary of the parameter in the message.
virtual void	setOctetBoundary (unsigned prevBoundary)=0
	Sets the octet boundary of the parameter in the message based on the boundary of this parameter and the boundary of the previous parameter.
virtual unsigned	elementSize ()=0
	Returns the size of single element in this parameter.

Protected Member Functions
	DtRtiBaseMsgParam (const char *paramName)

Protected Attributes
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

The base class for all templated RTI message parameters.

Constructor & Destructor Documentation

DtRtiBaseMsgParam::~DtRtiBaseMsgParam ( )

inline

DtRtiBaseMsgParam::DtRtiBaseMsgParam ( const char *  paramName )

inlineprotected

Member Function Documentation

void* DtRtiBaseMsgParam::beginPtr ( )

inline

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

References endPtr(), and myPrevParam.

Referenced by DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >::paramPtr(), DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::paramPtr(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::paramPtr(), and DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::paramPtr().

const void* DtRtiBaseMsgParam::beginPtr ( ) const

inline

References endPtr(), and myPrevParam.

virtual unsigned DtRtiBaseMsgParam::elementSize ( )

pure virtual

Returns the size of single element in this parameter.

Only really used for array parameters.

Implemented in DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >, DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >, DtRtiMsgParam< ParamType, NetParamType >, DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >, DtNetAssistantMsgHeaderParam, DtNetMsgHeaderParam, and DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >.

virtual void* DtRtiBaseMsgParam::endPtr ( )

pure virtual

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

Implemented in DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >, DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >, DtRtiMsgParam< ParamType, NetParamType >, DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >, DtNetAssistantMsgHeaderParam, DtNetMsgHeaderParam, and DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >.

Referenced by beginPtr().

virtual const void* DtRtiBaseMsgParam::endPtr ( ) const

pure virtual

Implemented in DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >, DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >, DtRtiMsgParam< ParamType, NetParamType >, DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >, DtNetAssistantMsgHeaderParam, DtNetMsgHeaderParam, and DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >.

virtual unsigned DtRtiBaseMsgParam::minSize ( )

pure virtual

Returns the minimum size of this parameter.

Implemented in DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >, DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >, DtRtiMsgParam< ParamType, NetParamType >, DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >, DtNetAssistantMsgHeaderParam, DtNetMsgHeaderParam, and DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >.

Referenced by DtRtiTemplateMsg::addParameter(), and DtAssistantTemplateMsg::addParameter().

virtual const char* DtRtiBaseMsgParam::name ( ) const

inlinevirtual

Returns the parameter name.

References myName.

Referenced by DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >::print(), DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::print(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::print(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::print(), and DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::print().

unsigned DtRtiBaseMsgParam::octetBoundary ( ) const

inline

Returns the octet boundary of the parameter in the message.

References myOctetBoundary.

Referenced by setPrevParam().

virtual void DtRtiBaseMsgParam::print ( ) const

pure virtual

Prints the parameter.

Implemented in DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >, DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >, DtRtiMsgParam< ParamType, NetParamType >, DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >, DtNetAssistantMsgHeaderParam, DtNetMsgHeaderParam, and DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >.

virtual void DtRtiBaseMsgParam::setOctetBoundary ( unsigned  prevBoundary )

pure virtual

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).

Implemented in DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >, DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >, DtRtiMsgParam< ParamType, NetParamType >, DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >, DtNetAssistantMsgHeaderParam, DtNetMsgHeaderParam, and DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >.

Referenced by setPrevParam().

void DtRtiBaseMsgParam::setPrevParam ( DtRtiBaseMsgParam *  prevParam )

inline

Sets the pointer to the previous parameter in the message.

References myPrevParam, octetBoundary(), and setOctetBoundary().

Referenced by DtRtiTemplateMsg::addParameter(), and DtAssistantTemplateMsg::addParameter().

Member Data Documentation

const char* DtRtiBaseMsgParam::myName

protected

The parameter name.

Referenced by name().

unsigned DtRtiBaseMsgParam::myOctetBoundary

protected

Octet boundary of this parameter.

Referenced by octetBoundary(), DtRtiMsgParam< MAKRti::DtInetAddr, MAKRti::DtNetU128 >::setOctetBoundary(), DtNetMsgHeaderParam::setOctetBoundary(), DtNetAssistantMsgHeaderParam::setOctetBoundary(), DtRtiMsgParam< MAKRti::DtU32, MAKRti::DtNetU32 >::setOctetBoundary(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setOctetBoundary(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::setOctetBoundary(), and DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::setOctetBoundary().

DtRtiBaseMsgParam* DtRtiBaseMsgParam::myPrevParam

protected

Pointer to the previous parameter in this message.

Referenced by beginPtr(), and setPrevParam().

---

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

• rtiTemplateMsgParams.h