The DtChangeLatencyTestModeMsg defines a wrapper for the change latency test message used to command an LRC to initiate a latency test, stop a test, or inform it that the we want to observe the test results. More...

Inheritance diagram for DtChangeLatencyTestModeMsg:

Collaboration diagram for DtChangeLatencyTestModeMsg:

Public Member Functions
	DtChangeLatencyTestModeMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors. More...

	DtChangeLatencyTestModeMsg (const DtNetChangeLatencyTestModeMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)

	DtChangeLatencyTestModeMsg (bool continuous, bool shouldHalt, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor specifying netHeader variables. More...

virtual	~DtChangeLatencyTestModeMsg ()
	Destructor. More...

virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this. More...

virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section. More...

virtual bool	runTest () const
	Set/Get Is this a request to start a new test? More...

virtual void	setRunTest (bool yesNo)

virtual DtFederateHandle	initiator () const
	Set/Get handle of the federate to initiate the test. More...

virtual void	setInitiator (DtFederateHandle handle)

virtual bool	continuousUpdate () const
	Set/Get Is this request start/stop a continuous test? More...

virtual void	setContinuousUpdate (bool yesNo)

virtual bool	shouldHaltContinuous () const
	Set / Get is this halt Continuous msg? Irrelevant if continuousUpdate returns false. More...

virtual void	setShouldHaltContinuous (bool yesNo)

virtual bool	observingResults () const
	Set / Get are we observing test results? More...

virtual void	setObservingResults (bool yesNo)

virtual unsigned int	interactionPeriod () const
	Set / Get the period between interactions (in ms). More...

virtual void	setInteractionPeriod (unsigned int period)

virtual unsigned int	numInteractions () const
	Set / Get the number of interactions to send in this test. More...

virtual void	setNumInteractions (unsigned int num)

virtual unsigned int	payloadBytes () const
	Set / Get the number of bytes in the interaction payload. More...

virtual void	setPayloadBytes (unsigned int bytes)

Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor. More...

virtual DtRtiMsg *	cloneWithTransport (bool copy=true) const
	Return a copy/empty object of the same type as this using clone and set the transport type from the host message. More...

virtual DtNetMsgHeader *	netHeader () const
	Get header of network representation. More...

virtual int	version () const
	Return the message version. More...

virtual bool	isValidVersion () const
	Returns bool: message version is valid? More...

virtual void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to. More...

virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle. More...

virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise. More...

virtual DtRtiMsgKind	msgKind () const
	Get the message kind. More...

virtual const char *	kindString () const
	Returns the message kind string name. More...

virtual bool	isConstrained () const
	Return boolean: message type can be time constrained? More...

virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save? More...

virtual void	setTime (const RTI::FedTime &time)
	Set/Get time Used in timestamped messages. More...

virtual RTI::FedTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const

virtual bool	hasTime () const
	Returns true if time field is valid. More...

virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages. More...

virtual unsigned long	serialNumber () const

virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type. More...

virtual DtTransportHandle	transportType () const

virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order. More...

virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object. More...

virtual bool	addMetadata (caddr_t mtdAddr, unsigned int size, unsigned int alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata. More...

virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed. More...

bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types. More...

bool	isUpdateMsgType () const

virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions. More...

virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const

virtual void	printTime (const char label, RTI::FedTime const timeValue) const
	Print the given time. More...

virtual void	printInterval (const char label, RTI::FedTime const intervalValue) const
	Print the interval. More...

virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise. More...

virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec(). More...

virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name. More...

virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle. More...

virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle. More...

virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number. More...

virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number. More...

virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number. More...

virtual unsigned long	serviceCallNumber () const
	Set/Get service call number. More...

virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...

virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...

Static Public Member Functions
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators. More...

static DtRtiMsg *	create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)

static void	addCallback (DtConnectionMgr conn, DtChangeLatencyTestModeCb cb, void usr)
	Adds or removes a callback with the given connection manager for this message type. More...

static void	removeCallback (DtConnectionMgr conn, DtChangeLatencyTestModeCb cb, void usr)

Static Public Member Functions inherited from DtRtiMsg
static const DtNetMsgHeader *	netHeader (const void *buffer)
	Extracts the header network representation from the buffer. More...

static const char *	kindToString (DtRtiMsgKind kind)
	Returns the name of the message, by kind enumeration. More...

static const char *	kindString (const void *buffer)
	Extracts the message kind from the given buffer and returns its string name. More...

static unsigned long	totalSize (const void *buffer)
	Extracts the message total size form the given buffer. More...

static const DtRtiMsgKind	msgKind (const void *buffer)
	Extracts the message kind from the given buffer. More...

static unsigned int	version (const void *buffer)
	Extracts the message version form the given buffer. More...

static unsigned int	fedExHandle (const void *buffer)
	Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name) More...

static DtFederateHandle	federateHandle (const void *buffer)
	Extracts the message federate handle form the given buffer. More...

static unsigned long	sequenceNumber (const void *buffer)
	Extracts the message sequence number form the given buffer. More...

static unsigned char	flags (const void *buffer)
	Extracts the message flags form the given buffer. More...

static unsigned long	metadataSize (const void *buffer)
	Extracts the message metadata size form the given buffer. More...

static void	setDefaultRegionSet (unsigned long defaultRegionSet)
	Set the default region set handle. More...

static void	setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
	Set/Get flag to enable use of 32 bit size field for attribute/parameter values. More...

static bool	use32BitsForValueSize ()

static void	setSmartForwardingEnabled (bool enabled)
	Set/Get is SmartForwarding enabled? More...

static bool	smartForwardingEnabled ()

Protected Member Functions
virtual DtNetChangeLatencyTestModeMsg *	netChangeLatencyTestModeMsg ()
	The network representation for the notify message. More...

virtual const DtNetChangeLatencyTestModeMsg *	netChangeLatencyTestModeMsg () const

virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of a DtChangeLatencyTestModeMsg message. More...

virtual int	minSize () const
	Returns minimum size of a message, including header. More...

Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor. More...

virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes. More...

void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual. More...

void	initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer)

void	initDtRtiMsg (const DtNetMsgHeader *header, DtBufferPtr buffer)

virtual void	adjustBytes (int offset, int numBytes)
	Adjust numBytes bytes at the indicated offset in the net rep. More...

virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated addres. More...

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle

static const char *	theDefaultTag

Protected Attributes inherited from DtRtiMsg
DtTransportHandle	myTransportType

DtOrderHandle	myOrderType

RTI::FedTime *	myFedTime

bool	myTimeIsValid

bool	myConstrained

bool	myAllowedDuringSave

unsigned long	mySerialNumber

unsigned long	myServiceCallNumber

unsigned long	myTriggerMessage

Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize

static bool	theSmartForwardingEnabled

Detailed Description

The DtChangeLatencyTestModeMsg defines a wrapper for the change latency test message used to command an LRC to initiate a latency test, stop a test, or inform it that the we want to observe the test results.

Constructor & Destructor Documentation

DtChangeLatencyTestModeMsg::DtChangeLatencyTestModeMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

DtChangeLatencyTestModeMsg::DtChangeLatencyTestModeMsg	(	const DtNetChangeLatencyTestModeMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

DtChangeLatencyTestModeMsg::DtChangeLatencyTestModeMsg	(	bool	continuous,
		bool	shouldHalt,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

constructor specifying netHeader variables.

virtual DtChangeLatencyTestModeMsg::~DtChangeLatencyTestModeMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtChangeLatencyTestModeMsg::addCallback	(	DtConnectionMgr *	conn,
		DtChangeLatencyTestModeCb	cb,
		void *	usr
	)

static

Adds or removes a callback with the given connection manager for this message type.

virtual DtRtiMsg* DtChangeLatencyTestModeMsg::clone ( bool copy = true ) const

virtual

Return a copy/empty object of the same type as this.

Implements DtRtiMsg.

virtual bool DtChangeLatencyTestModeMsg::continuousUpdate ( ) const

virtual

Set/Get Is this request start/stop a continuous test?

static DtRtiMsg* DtChangeLatencyTestModeMsg::create	(	const DtNetMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Creators.

static DtRtiMsg* DtChangeLatencyTestModeMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

virtual DtFederateHandle DtChangeLatencyTestModeMsg::initiator ( ) const

virtual

Set/Get handle of the federate to initiate the test.

virtual unsigned int DtChangeLatencyTestModeMsg::interactionPeriod ( ) const

virtual

Set / Get the period between interactions (in ms).

virtual DtRtiMsgKind DtChangeLatencyTestModeMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of a DtChangeLatencyTestModeMsg message.

Implements DtRtiMsg.

virtual int DtChangeLatencyTestModeMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetChangeLatencyTestModeMsg* DtChangeLatencyTestModeMsg::netChangeLatencyTestModeMsg ( )

protectedvirtual

The network representation for the notify message.

virtual const DtNetChangeLatencyTestModeMsg* DtChangeLatencyTestModeMsg::netChangeLatencyTestModeMsg ( ) const

protectedvirtual

virtual unsigned int DtChangeLatencyTestModeMsg::numInteractions ( ) const

virtual

Set / Get the number of interactions to send in this test.

virtual bool DtChangeLatencyTestModeMsg::observingResults ( ) const

virtual

Set / Get are we observing test results?

virtual unsigned int DtChangeLatencyTestModeMsg::payloadBytes ( ) const

virtual

Set / Get the number of bytes in the interaction payload.

virtual void DtChangeLatencyTestModeMsg::printData ( DtLogicalTimeFactory * logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

static void DtChangeLatencyTestModeMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtChangeLatencyTestModeCb	cb,
		void *	usr
	)

static

virtual bool DtChangeLatencyTestModeMsg::runTest ( ) const

virtual

Set/Get Is this a request to start a new test?

virtual void DtChangeLatencyTestModeMsg::setContinuousUpdate ( bool yesNo )

virtual

virtual void DtChangeLatencyTestModeMsg::setInitiator ( DtFederateHandle handle )

virtual

virtual void DtChangeLatencyTestModeMsg::setInteractionPeriod ( unsigned int period )

virtual

virtual void DtChangeLatencyTestModeMsg::setNumInteractions ( unsigned int num )

virtual

virtual void DtChangeLatencyTestModeMsg::setObservingResults ( bool yesNo )

virtual

virtual void DtChangeLatencyTestModeMsg::setPayloadBytes ( unsigned int bytes )

virtual

virtual void DtChangeLatencyTestModeMsg::setRunTest ( bool yesNo )

virtual

virtual void DtChangeLatencyTestModeMsg::setShouldHaltContinuous ( bool yesNo )

virtual

virtual bool DtChangeLatencyTestModeMsg::shouldHaltContinuous ( ) const

virtual

Set / Get is this halt Continuous msg? Irrelevant if continuousUpdate returns false.

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

changeLatencyTestModeMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation