Inheritance diagram for TestPdu:

Collaboration diagram for TestPdu:

Public Member Functions
	TestPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Blank constructor - constructs a blank TestPdu ready to be filled out and sent by application code.
	TestPdu (const NetTestPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	From-network-representation constructor.
virtual	~TestPdu ()
	Destructor - Not required by VR-Link, but should clearly be written if this class has any dynamic data that needs to be cleaned up.
	TestPdu (const TestPdu &orig)
	Copy constructor.
TestPdu &	operator= (const TestPdu &orig)
	Assignment operator.
virtual void	printData () const
	Virtual function override.
virtual void	setA (int val)
	Inspector and mutator functions for the PDU class' data.
virtual int	a () const
virtual void	setB (int index, int val)
	Set/Get the index'th element of the "b" array.
virtual int	b (int index) const
virtual void	setC (float val)
	Set/Get the value of c.
virtual float	c () const
virtual NetTestPdu *	netTestPdu ()
	Returns a pointer to the PDU's network representation by casting the value returned by the base class' packet() function to a NetTestPdu.
virtual const NetTestPdu *	netTestPdu () const
Public Member Functions inherited from DtPdu
virtual	~DtPdu ()
	Destructor.
	DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtPdu &	operator= (const DtPdu &pdu)
	Assignment operator.
virtual void *	packet () const
	Older function that returns a pointer to the network representation.
virtual int	status () const
	Get PDU status.
virtual void	setVersion (int vers)
	Set/Get protocol version from PDU header.
virtual int	protocolVersion () const
virtual void	setExerciseId (int id)
	Set/Get exerciseID in PDU header.
virtual int	exerciseId () const
virtual DtPduKind	kind () const
	Returns PDU kind from PDU header.
virtual DtProtocolFamily	protocolFamily () const
	Returns protocol family from PDU header.
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the PDU header's time stamp to reflect time and type.
virtual DtTime	timeStamp () const
	Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp, as indicated in PDU header.
virtual DtTime	guessTimeValid (DtTime referenceTime) const
	Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.
virtual DtNetPduHeader *	netHeader () const
	Returns a pointer to the PDU's header.
virtual void	print () const
	Print the contents of the PDU by calling printToStream(DtInfo).
virtual void	printToStream (std::ostream &stream) const
	Print the contents of the PDU by calling printHeaderToStream and printDataToStream.
virtual void	printHeader () const
	Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the PDU's header to a stream.
virtual void	printDataToStream (std::ostream &stream) const
virtual void	printDataToString (DtString &str) const
Public Member Functions inherited from DtBaseMsg
virtual	~DtBaseMsg ()
	Destructor.
	DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtBaseMsg &	operator= (const DtBaseMsg &msg)
	Assignment.
virtual const char *	netRep () const
	Get network representation.
virtual int	length () const
	Get size of message.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create and return a new TestPdu.
static void	addCallback (DtExerciseConn conn, TestPduCb cb, void usr)
	Wrappers around DtExerciseConn's add/removeCallback functions.
static void	removeCallback (DtExerciseConn conn, TestPduCb cb, void usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Virtual function override.
Protected Member Functions inherited from DtPdu
	DtPdu ()
	Constructor.
virtual void	setStatus (int okStatus)
	Sets the PDU's status to okStatus.
virtual void	initPdu (int size, DtBufferPtr buffer)
	Must be called after default ctor before PDU is completely constructed.
virtual void	initPdu (const void *initial, DtBufferPtr buffer)
	Called by from-net-rep ctor. Initializes DtBaseMsg.
virtual DtProtocolFamily	kindToFamily (DtPduKind kind) const
	Maps PDU kind to ProtocolFamily.
virtual void	sizeChanged (int size)
	Called by changeSize. Sets the size in the header to size.
virtual void	clearData ()
	zeros out all bytes after the PDU header.
virtual void	initHeader (DtPduKind kind, int size)
	Initializes PDU header. Called by initPdu.
Protected Member Functions inherited from DtBaseMsg
	DtBaseMsg ()
	Constructor Object is not fully constructed until initMsg is called.
void	initMsg (int size, DtBufferPtr bufferPtr)
void	initMsg (const void *initial, int size, DtBufferPtr bufferPtr)
virtual void	changeSize (int size)
	Changes the size of the message.
virtual void	insertBytes (int offset, int numBytes)
	Inserts numBytes zeroed-out bytes at the indicated offset into the net rep.
virtual void	insertBytes (void *address, int numBytes)
	Inserts numBytes zeroed-out bytes at the indicated address.
virtual void	deleteBytes (int offset, int numBytes)
	Deletes numBytes bytes at the indicated offset in the net rep.
virtual void	deleteBytes (void *address, int numBytes)
	Deletes numBytes bytes starting at the indicated address.
virtual void	clearAll ()
	Zeros out all bytes in the network representation.
virtual void *	newInternalBuffer (int size)
	Sets myInternalBuff to point to a malloc'ed buffer of size bytes.

Additional Inherited Members
Protected Attributes inherited from DtPdu
int	myOKStatus

Detailed Description

Define the TestPdu class.

Constructor & Destructor Documentation

TestPdu::TestPdu ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Blank constructor - constructs a blank TestPdu ready to be filled out and sent by application code.

Required.

TestPdu::TestPdu	(	const NetTestPdu *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

From-network-representation constructor.

Constructs a PDU from an already-filled-out buffer containing the exact bytes that represent this type of PDU. This constructor is used by VR-Link (through the static create function) to create an instance of this class from PDU data received from the network. Required.

virtual TestPdu::~TestPdu ( )

virtual

Destructor - Not required by VR-Link, but should clearly be written if this class has any dynamic data that needs to be cleaned up.

TestPdu::TestPdu ( const TestPdu & orig )

Copy constructor.

Not required by VR-Link, but needed if you will ever want to copy TestPdus.

Member Function Documentation

virtual int TestPdu::a ( ) const

virtual

static void TestPdu::addCallback	(	DtExerciseConn *	conn,
		TestPduCb	cb,
		void *	usr
	)

static

Wrappers around DtExerciseConn's add/removeCallback functions.

Not required since the DtExerciseConn functions may be used instead, but strongly encouraged, so that the non-typesafe cast can be limited to this one place. In addition, within addCallback, we choose to register this class's create function with VR-Link, letting VR-Link know to create one of these to represent the right PDU kind. If this is not done within addCallback, it must be done explicitly by application code that uses this class.

virtual int TestPdu::b ( int index ) const

virtual

virtual float TestPdu::c ( ) const

virtual

static DtPdu* TestPdu::create	(	const DtNetPacket *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Create and return a new TestPdu.

Basically a wrapper around the constructor. It is necessary because pointers to static functions like this can be registered with a DtPduFactory (which tells VR-Link how to construct an instance of a particular kind of PDU), but constructors can not. Required.

virtual DtPduKind TestPdu::internalGetPduKind ( ) const

protectedvirtual

Virtual function override.

Returns the PDU kind associated with this PDU class. This value goes in the header of all instances of this PDU class. Required.

Implements DtPdu.

virtual NetTestPdu* TestPdu::netTestPdu ( )

virtual

Returns a pointer to the PDU's network representation by casting the value returned by the base class' packet() function to a NetTestPdu.

We include both const and non-const versions. These functions are optional, but they make it easier to write inspectors and mutators.

virtual const NetTestPdu* TestPdu::netTestPdu ( ) const

virtual

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

Assignment operator.

Not required by VR-Link, but needed if you will ever want to copy TestPdus.

virtual void TestPdu::printData ( ) const

virtual

Virtual function override.

Prints the data values in the PDU. Not strictly required, but encouraged, since otherwise calling print() on an instance of this class will merely print raw hex data.

Reimplemented from DtPdu.

static void TestPdu::removeCallback	(	DtExerciseConn *	conn,
		TestPduCb	cb,
		void *	usr
	)

static

virtual void TestPdu::setA ( int val )

virtual

Inspector and mutator functions for the PDU class' data.

These will look different for each DtPdu subclass. None are required by VR-Link, but the class will not be particularly useful without a way to get data in and out in a typesafe manner. Set/Get the value of a.

virtual void TestPdu::setB	(	int	index,
		int	val
	)

virtual

Set/Get the index'th element of the "b" array.

(Alternatively, we could have created setB() and b() functions that set or returned the whole array all at once.)

virtual void TestPdu::setC ( float val )

virtual

Set/Get the value of c.

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

testPdu.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation