DtIfPing Class Reference

class DtIfPing:

Instances of DtIfPing will be used to measure round trip time from sender to receiver. The sender will send the time the message is sent, and the receiver will send back the time the message was received.

Content-Type: DtIfPlanMessageType

Inheritance diagram for DtIfPing:

Public Member Functions
	DtIfPing ()
virtual	~DtIfPing () override
	DtIfPing (const DtIfPing &orig)
DtIfPing &	operator= (const DtIfPing &orig)
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual void	setTimeSent (double)
virtual double	timeSent () const
virtual void	setTimeReceived (double)
virtual double	timeReceived () const
virtual double	deliveryTime () const
virtual void	setAck (bool)
virtual bool	ack () const
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual void	printDataToString (DtString &str) override
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
double	myTimeSent
double	myTimeReceived
bool	myAck
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfPing::DtIfPing

(

)

default constructor

virtual DtIfPing::~DtIfPing ( )

overridevirtual

destructor

DtIfPing::DtIfPing

(

const DtIfPing &

orig

)

copy constructor

Member Function Documentation

DtIfPing& DtIfPing::operator=

(

const DtIfPing &

orig

)

assignment operator

virtual int DtIfPing::type ( ) const

overridevirtual

Returns the type of Interface Content.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfPing::clone ( ) const

overridevirtual

Implements DtSimInterfaceContent.

virtual void DtIfPing::setTimeSent ( double  )

virtual

Set/get the time that this ping was sent. On an ack the time sent is the time the ping was originally sent and the time received is the time it was received at the source.

virtual double DtIfPing::timeSent ( ) const

virtual

virtual void DtIfPing::setTimeReceived ( double  )

virtual

Set/get the time that this ping was received. This will be set when the ack is tru.

virtual double DtIfPing::timeReceived ( ) const

virtual

virtual double DtIfPing::deliveryTime ( ) const

virtual

Time difference between when sent and when received. Note that the delivery time is only valid if the clocks are synchronized between the sender and receiver. If they are not then the delivery time will be off by the clock difference. Round trip latency can be determined by the value of the receipt time at the source - original time sent from the source.

virtual void DtIfPing::setAck ( bool  )

virtual

virtual bool DtIfPing::ack ( ) const

virtual

virtual int DtIfPing::netRepSize ( ) const

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfPing::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfPing::setToNet ( )

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfPing::printDataToString ( DtString &  str )

overridevirtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfPing::creator ( )

static

Member Data Documentation

double DtIfPing::myTimeSent

protected

double DtIfPing::myTimeReceived

protected

bool DtIfPing::myAck

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmsgs/ifPing.h