DtNetMsgHeaderParam Class Reference

A message parameter class specifically to handle DtNetMsgHeader. More...

Inheritance diagram for DtNetMsgHeaderParam:

Collaboration diagram for DtNetMsgHeaderParam:

Public Member Functions
	DtNetMsgHeaderParam (DtRtiTemplateMsg *msg)
	~DtNetMsgHeaderParam ()
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 ()
	Same as minSize.
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.

Static Public Member Functions
static const char *	headerName ()

Protected Member Functions
	DtNetMsgHeaderParam (const DtNetMsgHeaderParam &)
Protected Member Functions inherited from DtRtiBaseMsgParam
	DtRtiBaseMsgParam (const char *paramName)

Protected Attributes
DtRtiTemplateMsg *	myMsg
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

A message parameter class specifically to handle DtNetMsgHeader.

Constructor & Destructor Documentation

DtNetMsgHeaderParam::DtNetMsgHeaderParam ( DtRtiTemplateMsg *  msg )

inline

DtNetMsgHeaderParam::~DtNetMsgHeaderParam ( )

inline

DtNetMsgHeaderParam::DtNetMsgHeaderParam ( const DtNetMsgHeaderParam &  )

protected

Member Function Documentation

unsigned DtNetMsgHeaderParam::elementSize ( )

inlinevirtual

Same as minSize.

Implements DtRtiBaseMsgParam.

void* DtNetMsgHeaderParam::endPtr ( )

inlinevirtual

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

Implements DtRtiBaseMsgParam.

References myMsg, and DtRtiMsg::netHeader().

const void* DtNetMsgHeaderParam::endPtr ( ) const

inlinevirtual

Implements DtRtiBaseMsgParam.

References myMsg, and DtRtiMsg::netHeader().

static const char* DtNetMsgHeaderParam::headerName ( )

inlinestatic

unsigned DtNetMsgHeaderParam::minSize ( )

inlinevirtual

Returns the minimum size of this parameter.

Implements DtRtiBaseMsgParam.

Referenced by DtRtiTemplateMsg::DtRtiTemplateMsg(), and setOctetBoundary().

void DtNetMsgHeaderParam::print ( ) const

inlinevirtual

Prints the parameter.

Implements DtRtiBaseMsgParam.

void DtNetMsgHeaderParam::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.

References minSize(), and DtRtiBaseMsgParam::myOctetBoundary.

Referenced by DtRtiTemplateMsg::DtRtiTemplateMsg().

Member Data Documentation

DtRtiTemplateMsg* DtNetMsgHeaderParam::myMsg

protected

Referenced by endPtr().

---

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

• rtiTemplateMsg.h