DtInteractionMsg is a message type that represents an HLA Interaction. More...

Inheritance diagram for DtInteractionMsg:

Collaboration diagram for DtInteractionMsg:

Public Member Functions
	DtInteractionMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtInteractionMsg ()
	Destructor.
virtual void	setChannel (unsigned long handleValue)
	Set/Get DDM channel.
virtual unsigned long	channel () const
virtual void	setHandle (DtInteractionClassHandle hand)=0
	Set/Get handle.
virtual DtInteractionClassHandle	handle () const =0
virtual void	setTag (char const *tag)
	Set/Get tag.
virtual char const *	tag () const
virtual void	setParams (const DtPhvps &theParameters, bool checkBufferSize=true)
	Set/Get parameters.
virtual void	getParams (DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo *classInfo=NULL) const
	Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed parameters if class info is provided otherwise gets all parameters in message.
virtual unsigned long	numParams () const
	Get number of parameters.
Static Public Member Functions
static void	setChannelIncluded (bool includeChannel)
	Set/Get flag to include DDM channel identifier.
static bool	channelIncluded ()
Protected Member Functions
virtual void	setTagSize (int size)=0
	Set/Get tag size.
virtual int	tagSize () const =0
virtual DtNetU32 *	channelPtr () const =0
	Returns pointer to the channel in the netMsg.
virtual char *	tagPtr ()=0
	Returns pointer to the tag in the netMsg.
virtual DtNetParams *	netParams ()=0
	Returns pointer to the network rep of the pvList.
virtual DtNetBigParams *	netBigParams ()=0
	Supports big parameter values > 64K.
virtual DtNetParamValue *	nextNetParam (DtNetParamValue *netParam) const
	Find pointer to next parameter in the network rep.
virtual DtNetBigParamValue *	nextNetBigParam (DtNetBigParamValue *netParam) const
	Supports parameter values > 64K.
virtual void	fillFromNetParams (const DtNetParams netRepParams, DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo classInfo=NULL) const
	Fill the given parameter set with the message's parameters Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.
virtual void	fillFromNetBigParams (const DtNetBigParams netRepParams, DtPhvps &params, bool useMsgMemory, DtInteractionClassInfo classInfo=NULL) const
	Fill the given parameter set with the message's parameters Supports parameter values > 64K Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.
virtual void	fillNetParams (const DtPhvps &theParameters, DtNetParams *netRepParams)
	Fill message with given parameter set.
virtual void	fillNetBigParams (const DtPhvps &theParameters, DtNetBigParams *netRepParams)
	Supports parameter values > 64K.
virtual void	setSizeOfNetParams (unsigned long size)
	Sets size for the network rep of the pvList.
virtual unsigned long	sizeNeededForNetParams (const DtPhvps &params) const
	Returns the size the network representation will consume.
virtual int	channelFieldSize () const
	Returns size of channel field.
virtual int	tagFieldSize () const
	Returns size of tag field.
virtual DtInteractionMsg *	self () const
	Returns pointer to the serial number in the netMsg.
Protected Attributes
char *	myTag
unsigned long	myParamFieldLength
Static Protected Attributes
static bool	theChannelIncluded = false

Detailed Description

DtInteractionMsg is a message type that represents an HLA Interaction.

Constructor & Destructor Documentation

DtInteractionMsg::DtInteractionMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructor.

References DtRtiMsg::myAllowedDuringSave, and DtRtiMsg::myConstrained.

DtInteractionMsg::~DtInteractionMsg ( ) [virtual]

Destructor.

References myTag, and NULL.

Member Function Documentation

unsigned long DtInteractionMsg::channel ( ) const [virtual]

References channelIncluded(), channelPtr(), and DtDefaultRegionSetHandle.

Referenced by DtInteractionRoMsg::printData(), and DtInteractionMgr::processInteraction().

int DtInteractionMsg::channelFieldSize ( ) const [protected, virtual]

Returns size of channel field.

References channelIncluded().

Referenced by DtInteractionRoMsg::tagPtr().

bool DtInteractionMsg::channelIncluded ( ) [inline, static]

References theChannelIncluded.

Referenced by DtInteractionRoMsg::addCallback(), channel(), channelFieldSize(), DtInteractionRoMsg::DtInteractionRoMsg(), DtInteractionRoMsg::internalDtRtiMsgKind(), DtInteractionRoMsg::printData(), DtInteractionRoMsg::removeCallback(), and setChannel().

virtual DtNetU32* DtInteractionMsg::channelPtr ( ) const [protected, pure virtual]

Returns pointer to the channel in the netMsg.

Implemented in DtInteractionRoMsg.

Referenced by channel(), and setChannel().

void DtInteractionMsg::fillFromNetBigParams	(	const DtNetBigParams *	netRepParams,
		DtPhvps &	params,
		bool	useMsgMemory,
		DtInteractionClassInfo *	classInfo = `NULL`
	)		const `[protected, virtual]`

Fill the given parameter set with the message's parameters Supports parameter values > 64K Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.

References DtNetBigParamValue::handle, nextNetBigParam(), numParams(), DtNetBigParams::numParams, and DtInteractionClassInfo::paramByHandle().

Referenced by getParams().

void DtInteractionMsg::fillFromNetParams	(	const DtNetParams *	netRepParams,
		DtPhvps &	params,
		bool	useMsgMemory,
		DtInteractionClassInfo *	classInfo = `NULL`
	)		const `[protected, virtual]`

Fill the given parameter set with the message's parameters Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.

References DtNetParamValue::handle, nextNetParam(), DtNetParams::numParams, numParams(), and DtInteractionClassInfo::paramByHandle().

Referenced by getParams().

void DtInteractionMsg::fillNetBigParams	(	const DtPhvps &	theParameters,
		DtNetBigParams *	netRepParams
	)		`[protected, virtual]`

Supports parameter values > 64K.

References DtNetBigParamValue::handle, nextNetBigParam(), DtNetBigParams::numParams, and DtNetBigParamValue::size.

Referenced by setParams().

void DtInteractionMsg::fillNetParams	(	const DtPhvps &	theParameters,
		DtNetParams *	netRepParams
	)		`[protected, virtual]`

Fill message with given parameter set.

References DtNetParamValue::handle, nextNetParam(), DtNetParams::numParams, and DtNetParamValue::size.

Referenced by setParams().

void DtInteractionMsg::getParams	(	DtPhvps &	params,
		bool	useMsgMemory,
		DtInteractionClassInfo *	classInfo = `NULL`
	)		const `[virtual]`

Parameter value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed parameters if class info is provided otherwise gets all parameters in message.

References fillFromNetBigParams(), fillFromNetParams(), netBigParams(), netParams(), and DtRtiMsg::use32BitsForValueSize().

Referenced by DtInteractionRoMsg::printData(), and DtInteractionMgr::processInteraction().

virtual DtInteractionClassHandle DtInteractionMsg::handle ( ) const [pure virtual]

Implemented in DtInteractionRoMsg.

Referenced by DtInteractionMgr::processInteraction().

virtual DtNetBigParams* DtInteractionMsg::netBigParams ( ) [protected, pure virtual]

Supports big parameter values > 64K.

Implemented in DtInteractionRoMsg.

Referenced by getParams(), numParams(), and setParams().

virtual DtNetParams* DtInteractionMsg::netParams ( ) [protected, pure virtual]

Returns pointer to the network rep of the pvList.

Implemented in DtInteractionRoMsg.

Referenced by getParams(), numParams(), setParams(), and setSizeOfNetParams().

DtNetBigParamValue * DtInteractionMsg::nextNetBigParam ( DtNetBigParamValue * netParam ) const [protected, virtual]

Supports parameter values > 64K.

References DtNetBigParamValue::totalSize().

Referenced by fillFromNetBigParams(), and fillNetBigParams().

DtNetParamValue * DtInteractionMsg::nextNetParam ( DtNetParamValue * netParam ) const [protected, virtual]

Find pointer to next parameter in the network rep.

References DtNetParamValue::totalSize().

Referenced by fillFromNetParams(), and fillNetParams().

unsigned long DtInteractionMsg::numParams ( ) const [virtual]

Get number of parameters.

References netBigParams(), netParams(), DtNetParams::numParams, DtNetBigParams::numParams, and DtRtiMsg::use32BitsForValueSize().

Referenced by fillFromNetBigParams(), fillFromNetParams(), DtInteractionRoMsg::printData(), and DtInteractionMgr::processInteraction().

DtInteractionMsg * DtInteractionMsg::self ( ) const [inline, protected, virtual]

Returns pointer to the serial number in the netMsg.

Casts away const-ness

void DtInteractionMsg::setChannel ( unsigned long handleValue ) [virtual]

Set/Get DDM channel.

References channelIncluded(), and channelPtr().

Referenced by DtInteractionRoMsg::DtInteractionRoMsg(), and DtInteractionRoMsg::set().

void DtInteractionMsg::setChannelIncluded ( bool includeChannel ) [static]

Set/Get flag to include DDM channel identifier.

References theChannelIncluded.

Referenced by DtFedExec::DtFedExec(), DtInteractionMgr::DtInteractionMgr(), and DtConnectionMgr::initParams().

virtual void DtInteractionMsg::setHandle ( DtInteractionClassHandle hand ) [pure virtual]

Set/Get handle.

Implemented in DtInteractionRoMsg.

void DtInteractionMsg::setParams	(	const DtPhvps &	theParameters,
		bool	checkBufferSize = `true`
	)		`[virtual]`

Set/Get parameters.

References fillNetBigParams(), fillNetParams(), netBigParams(), netParams(), setSizeOfNetParams(), sizeNeededForNetParams(), and DtRtiMsg::use32BitsForValueSize().

Referenced by DtInteractionRoMsg::DtInteractionRoMsg(), and DtInteractionRoMsg::set().

void DtInteractionMsg::setSizeOfNetParams ( unsigned long size ) [protected, virtual]

Sets size for the network rep of the pvList.

References DtRtiMsg::adjustBytes(), myParamFieldLength, and netParams().

Referenced by setParams().

void DtInteractionMsg::setTag ( char const * tag ) [virtual]

Set/Get tag.

References DtRtiMsg::adjustBytes(), myTag, NULL, setTagSize(), tagFieldSize(), tagPtr(), and tagSize().

Referenced by DtInteractionRoMsg::DtInteractionRoMsg(), and DtInteractionRoMsg::set().

virtual void DtInteractionMsg::setTagSize ( int size ) [protected, pure virtual]

Set/Get tag size.

Implemented in DtInteractionRoMsg.

Referenced by setTag().

unsigned long DtInteractionMsg::sizeNeededForNetParams ( const DtPhvps & params ) const [protected, virtual]

Returns the size the network representation will consume.

References DtRtiMsg::use32BitsForValueSize().

Referenced by setParams().

char const * DtInteractionMsg::tag ( ) const [virtual]

References myTag, NULL, tagPtr(), and tagSize().

Referenced by DtInteractionRoMsg::printData(), and DtInteractionMgr::processInteraction().

int DtInteractionMsg::tagFieldSize ( ) const [protected, virtual]

Returns size of tag field.

References tagSize().

Referenced by DtInteractionRoMsg::DtInteractionRoMsg(), DtInteractionRoMsg::netBigParams(), DtInteractionRoMsg::netParams(), and setTag().

virtual char* DtInteractionMsg::tagPtr ( ) [protected, pure virtual]

Returns pointer to the tag in the netMsg.

Implemented in DtInteractionRoMsg.

Referenced by setTag(), and tag().

virtual int DtInteractionMsg::tagSize ( ) const [protected, pure virtual]

Implemented in DtInteractionRoMsg.

Referenced by setTag(), tag(), and tagFieldSize().

Member Data Documentation

unsigned long DtInteractionMsg::myParamFieldLength [protected]

Referenced by DtInteractionRoMsg::DtInteractionRoMsg(), and setSizeOfNetParams().

char* DtInteractionMsg::myTag [protected]

Referenced by setTag(), tag(), and ~DtInteractionMsg().

bool DtInteractionMsg::theChannelIncluded = false [static, protected]

Referenced by channelIncluded(), and setChannelIncluded().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation