DtLatencyTestInteraction Class Reference

DtLatencyTestInteraction holds the data needed to send a test latency interaction. More...

Inheritance diagram for DtLatencyTestInteraction:

Collaboration diagram for DtLatencyTestInteraction:

Public Member Functions
	DtLatencyTestInteraction (DtFomClassMgr *fomMgr)
	Constructor.
virtual	~DtLatencyTestInteraction ()
	Destructor.
virtual const DtPhvps &	parameters ()
	Return the parameter handle value pair set.
virtual bool	setFromParameters (const DtPhvps &phvps)
	Initialize this interaction using the given parameters Return true if expected number parameters were set.
Public Member Functions inherited from DtTestInteraction
	DtTestInteraction (DtFomClassMgr *fomMgr, MAKRti::DtString className)
	Constructor.
virtual	~DtTestInteraction ()
	Destructor.
virtual const MAKRti::DtString &	className () const
	Return the interaction class name.
virtual DtInteractionClassHandle	classHandle () const
	Return the interaction class handle.
virtual DtFederateHandle	targetFederate () const
	get interaction target federate handle parameter
virtual void	setTargetFederate (DtFederateHandle handle)
	set interaction target federate handle parameter
virtual void	setTransportType (MAKRti::DtTransportType transport)
	set transport of parameters.
virtual void	setPayloadSize (unsigned int payload)
	Set payload size.
virtual unsigned int	payloadSize () const
	Get payload size.
virtual MAKRti::DtU32	testId () const
	get test id parameter
virtual void	setTestId (unsigned int id)
	set test id parameter

Static Public Attributes
static const MAKRti::DtString	theInteractionName
Static Public Attributes inherited from DtTestInteraction
static const MAKRti::DtString	theNameTargetFederate
	Parameter name.
static const MAKRti::DtString	theNameTestId
	Parameter name.
static const MAKRti::DtString	theNamePayload
	Parameter name.

Protected Attributes
DtParameterHandle	myDataHandle
Protected Attributes inherited from DtTestInteraction
DtFomClassMgr *	myFomMgr
MAKRti::DtString	myClassName
DtInteractionClassHandle	myClassHandle
DtPhvps *	myParameters
DtParameterHandle	myHandleTargetFederate
	Parameter handle.
DtParameterHandle	myHandleTestId
	Parameter handle.
DtParameterHandle	myHandlePayload
	Parameter handle.
DtFederateHandle	myTargetFederate
	Parameter value.
MAKRti::DtU32	myTestId
	Parameter value.
MAKRti::DtU32	myPayloadSize
	Parameter value.

Private Member Functions
	DtLatencyTestInteraction (DtLatencyTestInteraction const &orig)
	Copy Constructor - not allowed.
DtLatencyTestInteraction &	operator= (DtLatencyTestInteraction const &orig)
	Assignment operator - not allowed.

Additional Inherited Members
Protected Member Functions inherited from DtTestInteraction
virtual void	encodeTargetFederate ()
	Encode target federate value into PHVPS.
virtual void	encodeTestId ()
	Encode test id value into PHVPS.
virtual void	encodePayload ()
	Encode payload into phvps.
virtual bool	decodeTargetFederate (const DtPhvps &parameters, int index)
	Decode target federate from given parameters into this interaction Return true if decoded successfully.
virtual bool	decodeTestId (const DtPhvps &parameters, int index)
	Decode test id from given parameters into this interaction Return true if decoded successfully.
virtual bool	decodePayload (const DtPhvps &parameters, int index)
	Decode payload from given parameters into this interaction Returns true if decoded successfully.
Static Protected Member Functions inherited from DtTestInteraction
static bool	decodeU32 (const DtPhvps &parameters, int index, MAKRti::DtU32 &value)
	Decode a 32 bit unsigned int from the given PHVPS Return true if decoded successfully.
static bool	decodeU64 (const DtPhvps &parameters, int index, MAKRti::DtU64 &value)
	Decode a 64 bit unsigned int from the given PHVPS Return true if decoded successfully.

Detailed Description

DtLatencyTestInteraction holds the data needed to send a test latency interaction.

Constructor & Destructor Documentation

DtLatencyTestInteraction::DtLatencyTestInteraction

(

DtFomClassMgr *

fomMgr

)

Constructor.

DtLatencyTestInteraction::~DtLatencyTestInteraction ( )

virtual

Destructor.

DtLatencyTestInteraction::DtLatencyTestInteraction ( DtLatencyTestInteraction const &  orig )

private

Copy Constructor - not allowed.

Member Function Documentation

DtLatencyTestInteraction& DtLatencyTestInteraction::operator= ( DtLatencyTestInteraction const &  orig )

private

Assignment operator - not allowed.

const DtPhvps & DtLatencyTestInteraction::parameters ( )

virtual

Return the parameter handle value pair set.

Implements DtTestInteraction.

References DtTestInteraction::encodePayload(), DtTestInteraction::encodeTargetFederate(), DtTestInteraction::encodeTestId(), and DtTestInteraction::myParameters.

Referenced by DtTestManager::receiveInteraction(), and DtTestManager::sendSingleLatencyInteraction().

bool DtLatencyTestInteraction::setFromParameters ( const DtPhvps &  phvps )

virtual

Initialize this interaction using the given parameters Return true if expected number parameters were set.

Implements DtTestInteraction.

References DtTestInteraction::decodePayload(), DtTestInteraction::decodeTargetFederate(), DtTestInteraction::decodeTestId(), DtTestInteraction::myHandlePayload, DtTestInteraction::myHandleTargetFederate, and DtTestInteraction::myHandleTestId.

Referenced by DtTestManager::receiveInteraction().

Member Data Documentation

DtParameterHandle DtLatencyTestInteraction::myDataHandle

protected

const MAKRti::DtString DtLatencyTestInteraction::theInteractionName

static

Referenced by addTestToFom().

---

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

• testInteraction.h
• testInteraction.cxx