DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType > Class Template Reference

The template for an RTI message parameter which is actually an array of items of the same type. More...

Inheritance diagram for DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >:

Collaboration diagram for DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >:

Public Member Functions
	DtRtiArrayMsgParam (const char *paramName, AllocatedMsgParamType *allocatedNum)
	~DtRtiArrayMsgParam ()
bool	addParam (ParamType val)
	Adds a new parameter data item to the array.
bool	setParams (const ParamType *vals, unsigned num)
	Sets the entire contents of the array.
template<typename ParamContainerType >
bool	setParams (const ParamContainerType &container)
	Sets the entire contents of the array.
template<typename ParamContainerType >
void	getParams (ParamContainerType &container) const
	Populates the container with all of the parameter data in this parameter array.
unsigned	getParams (ParamType *buff) const
	Populates the buffer with all of the parameter data in this parameter array.
bool	getFirstParam (ParamType &val) const
	Gets the value of the first parameter item in the array and resets the index for getNextParam().
bool	getNextParam (ParamType &val) const
	Gets the value of the next parameter item in the array.
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, which is 0 since it could be an empty array.
unsigned	elementSize ()
	Returns the size of single element in this parameter.
unsigned	numItems () const
	Returns the number of items in this array.
void	setNumItems (unsigned num)
	Sets the number of items in this array.
void	print () const
	Prints the parameter.
void	setOctetBoundary (unsigned prevBoundary)
	Sets the octet boundary of the parameter in the message.
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
	DtRtiArrayMsgParam (const DtRtiArrayMsgParam &)
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)

Protected Attributes
AllocatedMsgParamType *	myAllocatedNumParam
	The parameter which specifies how many elements can fit in the space allotted for this array.
unsigned	myNumUsed
	The number of items currently used in the array.
unsigned	myMutableNextParamIndex
	The index to the next item to be retrieved by nextParam.
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 ConvParamType, typename NetParamType, typename AllocatedMsgParamType>
class DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >

The template for an RTI message parameter which is actually an array of items of the same type.

Constructor & Destructor Documentation

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::DtRtiArrayMsgParam ( const char *  paramName, AllocatedMsgParamType *  allocatedNum  )

inline

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam.

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::~DtRtiArrayMsgParam ( )

inline

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::DtRtiArrayMsgParam ( const DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType > &  )

protected

Member Function Documentation

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

bool DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::addParam ( ParamType  val )

inline

Adds a new parameter data item to the array.

If there is not enough allocated space, returns false and makes no change.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myNumUsed, and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

unsigned DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::elementSize ( )

inlinevirtual

Returns the size of single element in this parameter.

Implements DtRtiBaseMsgParam.

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

void* DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::endPtr ( )

inlinevirtual

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

Implements DtRtiBaseMsgParam.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam, and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

const void* DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::endPtr ( ) const

inlinevirtual

Implements DtRtiBaseMsgParam.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam, and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

bool DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getFirstParam ( ParamType &  val ) const

inline

Gets the value of the first parameter item in the array and resets the index for getNextParam().

Returns false if there are no parameters.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myMutableNextParamIndex, and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

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

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

bool DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getNextParam ( ParamType &  val ) const

inline

Gets the value of the next parameter item in the array.

Returns false and does not alter val if there are no parameters left.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myMutableNextParamIndex, and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

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

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

template<typename ParamContainerType >

void DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getParams ( ParamContainerType &  container ) const

inline

Populates the container with all of the parameter data in this parameter array.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::numItems(), and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

Referenced by DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::print().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

unsigned DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getParams ( ParamType *  buff ) const

inline

Populates the buffer with all of the parameter data in this parameter array.

Returns the number of items.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::numItems(), and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

unsigned DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::minSize ( )

inlinevirtual

Returns the minimum size of this parameter, which is 0 since it could be an empty array.

Implements DtRtiBaseMsgParam.

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

unsigned DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::numItems ( ) const

inline

Returns the number of items in this array.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam.

Referenced by DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::addParam(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::getFirstParam(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::getNextParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getParams(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::getParams(), and DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::setParams().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

NetParamType* DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr ( )

inlineprotected

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

References DtRtiBaseMsgParam::beginPtr().

Referenced by DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::addParam(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::addParam(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::addParams(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::endPtr(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::endPtr(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::endPtr(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getFirstParam(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::getFirstParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getNextParam(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::getNextParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getParams(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::getParams(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::getParams(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::getSubStrings(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setParams(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::setParams(), and DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::setSubStrings().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

const NetParamType* DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr ( ) const

inlineprotected

References DtRtiBaseMsgParam::beginPtr().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

void DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::print ( ) const

inlinevirtual

Prints the parameter.

Implements DtRtiBaseMsgParam.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getFirstParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getNextParam(), and DtRtiBaseMsgParam::name().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

void DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setNumItems ( unsigned  num )

inline

Sets the number of items in this array.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam.

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

void DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setOctetBoundary ( unsigned  prevBoundary )

inlinevirtual

Sets the octet boundary of the parameter in the message.

For arrays the the octet boundary is always the size of one element, since we cannot guarantee anything else.

Implements DtRtiBaseMsgParam.

References DtRtiBaseMsgParam::myOctetBoundary.

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

bool DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setParams ( const ParamType *  vals, unsigned  num  )

inline

Sets the entire contents of the array.

If there is not enough allocated space, returns false and makes no change.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myNumUsed, and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

template<typename ParamContainerType >

bool DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setParams ( const ParamContainerType &  container )

inline

Sets the entire contents of the array.

If there is not enough allocated space, returns false and makes no change.

References DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam, DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myNumUsed, and DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::paramPtr().

Member Data Documentation

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

AllocatedMsgParamType* DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myAllocatedNumParam

protected

The parameter which specifies how many elements can fit in the space allotted for this array.

Referenced by DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::addParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::DtRtiArrayMsgParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::endPtr(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::endPtr(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::endPtr(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getFirstParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getNextParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getParams(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::getParams(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::getSubStrings(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::numItems(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::numItems(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::numItems(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setNumItems(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::setNumItems(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::setNumItems(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setParams(), and DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::setSubStrings().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

unsigned DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myMutableNextParamIndex

mutableprotected

The index to the next item to be retrieved by nextParam.

Referenced by DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getFirstParam(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::getFirstParam(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::getNextParam(), and DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::getNextParam().

template<typename ParamType , typename ConvParamType , typename NetParamType , typename AllocatedMsgParamType >

unsigned DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::myNumUsed

protected

The number of items currently used in the array.

Referenced by DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::addParam(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::addParam(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::addParams(), DtRtiArrayMsgParam< ParamType, ConvParamType, NetParamType, AllocatedMsgParamType >::setParams(), DtRtiArrayMsgParam< MAKRti::DtInetAddr, MAKRti::DtU128, MAKRti::DtNetU128, AllocatedMsgParamType >::setParams(), DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::setParams(), and DtRtiArrayMsgParam< char, char, char, AllocatedMsgParamType >::setSubStrings().

---

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

• rtiTemplateMsgArrayParams.h