DtRtiArraySizeMsgParam< ParamType, NetParamType > Class Template Reference

The template for an RTI message parameter which is actually the size of an array. More...

Inheritance diagram for DtRtiArraySizeMsgParam< ParamType, NetParamType >:

Collaboration diagram for DtRtiArraySizeMsgParam< ParamType, NetParamType >:

Public Member Functions
	DtRtiArraySizeMsgParam (const char *paramName)
	~DtRtiArraySizeMsgParam ()
void	registerArray (DtRtiBaseMsgParam *arrayParam)
	Registers an array parameter which uses this parameter as a record of its size.
unsigned	bytesNeeded (unsigned num) const
	Returns the number of bytes needed to hold the number of items specified.
const void *	firstArrayPtr () const
	Returns the location of the first array whose size is held by this parameter.
void *	firstArrayPtr ()
Public Member Functions inherited from DtRtiMsgParam< ParamType, NetParamType >
	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 Attributes
std::list< DtRtiBaseMsgParam * >	myArrayParams
	List of arrays using this as their size.

Additional Inherited Members
Protected Member Functions inherited from DtRtiMsgParam< ParamType, NetParamType >
	DtRtiMsgParam (const DtRtiMsgParam &)
NetParamType *	paramPtr ()
	Returns a pointer to location of this parameter in the message.
const NetParamType *	paramPtr () const

Detailed Description

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

The template for an RTI message parameter which is actually the size of an array.

Constructor & Destructor Documentation

template<typename ParamType , typename NetParamType >

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

inline

template<typename ParamType , typename NetParamType >

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

inline

Member Function Documentation

template<typename ParamType , typename NetParamType >

unsigned DtRtiArraySizeMsgParam< ParamType, NetParamType >::bytesNeeded ( unsigned  num ) const

inline

Returns the number of bytes needed to hold the number of items specified.

References DtRtiArraySizeMsgParam< ParamType, NetParamType >::myArrayParams.

template<typename ParamType , typename NetParamType >

const void* DtRtiArraySizeMsgParam< ParamType, NetParamType >::firstArrayPtr ( ) const

inline

Returns the location of the first array whose size is held by this parameter.

References DtRtiArraySizeMsgParam< ParamType, NetParamType >::myArrayParams.

template<typename ParamType , typename NetParamType >

void* DtRtiArraySizeMsgParam< ParamType, NetParamType >::firstArrayPtr ( )

inline

References DtRtiArraySizeMsgParam< ParamType, NetParamType >::myArrayParams.

template<typename ParamType , typename NetParamType >

void DtRtiArraySizeMsgParam< ParamType, NetParamType >::registerArray ( DtRtiBaseMsgParam *  arrayParam )

inline

Registers an array parameter which uses this parameter as a record of its size.

It's possible for multiple arrays to share the same size parameter. Whenever this size is increased, it will automatically allocate memory for all of its associated arrays. It DOES NOT support automatically shrinking an array.

References DtRtiArraySizeMsgParam< ParamType, NetParamType >::myArrayParams.

Member Data Documentation

template<typename ParamType , typename NetParamType >

std::list<DtRtiBaseMsgParam*> DtRtiArraySizeMsgParam< ParamType, NetParamType >::myArrayParams

protected

List of arrays using this as their size.

Referenced by DtRtiArraySizeMsgParam< ParamType, NetParamType >::bytesNeeded(), DtRtiArraySizeMsgParam< ParamType, NetParamType >::firstArrayPtr(), and DtRtiArraySizeMsgParam< ParamType, NetParamType >::registerArray().

---

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

• rtiTemplateMsgArrayParams.h