DtCommentPdu Class Reference

Instances of DtCommentPdu are used to send/receive comment PDUs. More...

Inheritance diagram for DtCommentPdu:

Collaboration diagram for DtCommentPdu:

Public Types
enum	{ PduStaticSize = 32 }
Public Types inherited from DtPduWithData
enum	{ PduStaticSize = 40 }

Public Member Functions
	DtCommentPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtCommentPdu (const DtNetCommentPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtCommentPdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, const char *message, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual void	setComment (const char *message, int size)
	Set the comment.
virtual const char *	comment () const
Public Member Functions inherited from DtPduWithData
	DtPduWithData ()
	Constructor.
virtual	~DtPduWithData ()
	Destructor.
	DtPduWithData (const DtPduWithData &orig)
DtPduWithData &	operator= (const DtPduWithData &orig)
	Assignment operator.
virtual int	numFixedFields () const
	Returns number of fixed fields.
virtual int	numVarFields () const
	Returns number of variable length fields.
virtual DtDatumParam	varDatumId (int index) const
	Returns the datum param found in the index'th variable datum record.
virtual DtDatumParam	fixedDatumId (int index) const
	Returns the datum param found in the index'th fixed datum record.
virtual DtDatumParam	datumId (DtDatumRecordType fixedOrVar, int index) const
	Returns the datum param found in the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFIXED or DtVAR.
virtual int	datumSizeBits (DtDatumRecordType fixedOrVar, int index) const
	Returns the number of bits of data contained in the value fields of the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFIXED or DtVAR.
virtual int	datumSizeBytes (DtDatumRecordType fixedOrVar, int index) const
	Returns the number of bytes of data contained in the value fields of the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFIXED or DtVAR.
virtual void	getIndex (DtDatumParam param, DtDatumRecordType *fixedOrVar, int *index, DtDatumRetCode *retcode=NULL) const
	Looks through all fixed and variable records for one containing param as the parameter ID.
virtual DtFloat32	datumValFloat32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=NULL) const
	******* INSPECTING DATUM VALUES BY INDEX ********* If you know the data type of the value contained in a particular record, use one of the following to return it.
virtual DtFloat64	datumValFloat64 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=NULL) const
virtual unsigned long	datumValUnsigned32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=NULL) const
virtual long	datumValInt32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=NULL) const
virtual const char *	datumValByteArray (DtDatumRecordType fixedOrVar, int index) const
virtual DtFloat32	datumValFloat32 (DtDatumParam param, DtDatumRetCode *retcode=NULL) const
	******* INSPECTING DATUM VALUES BY PARAM ID ********* If you know the data type of the value contained in a particular record, use one of the following to return it.
virtual DtFloat64	datumValFloat64 (DtDatumParam param, DtDatumRetCode *retcode=NULL) const
virtual unsigned long	datumValUnsigned32 (DtDatumParam param, DtDatumRetCode *retcode=NULL) const
virtual long	datumValInt32 (DtDatumParam param, DtDatumRetCode *retcode=NULL) const
virtual const char *	datumValByteArray (DtDatumParam param, DtDatumRetCode *retcode=NULL) const
virtual void	initDataSection (const DtDatumParam *fixedParams, const DtVarDatumSpec *specList)
	****************** MUTATOR FUNCTIONS ******************
virtual void	setNumFixedFields (int newNum)
	Sets the number of fixed or variable fields to newNum.
virtual void	setNumVarFields (int newNum)
virtual void	setDatumParam (DtDatumRecordType fixedOrVar, int index, DtDatumParam param, DtDatumRetCode *retcode=NULL)
	Set the datum ID in the index'th fixed or variable datum record to param, depending on whether fixedOrVar is DtFIXED or DtVAR.
virtual void	setVarDataBytes (int index, int length, DtDatumRetCode *retcode=NULL)
	Allocates length bytes for the index'th variable datum record.
virtual void	setDatumValFloat64 (DtDatumRecordType fixedOrVar, int index, DtFloat64 val, DtDatumRetCode *retcode=NULL)
	******* SETTING DATA VALUES BY INDEX ********* Use one of the following to set the data value in a fixed or variable datum record, depending on the data type of your data.
virtual void	setDatumValFloat32 (DtDatumRecordType fixedOrVar, int index, DtFloat32 val, DtDatumRetCode *retcode=NULL)
virtual void	setDatumValInt32 (DtDatumRecordType fixedOrVar, int index, long val, DtDatumRetCode *retcode=NULL)
virtual void	setDatumValUnsigned32 (DtDatumRecordType fixedOrVar, int index, unsigned long val, DtDatumRetCode *retcode=NULL)
virtual void	setDatumValByteArray (DtDatumRecordType fixedOrVar, int index, const char *val, DtDatumRetCode *retcode=NULL)
virtual void	setDatumValFloat64 (DtDatumParam param, DtFloat64 val, DtDatumRetCode *retcode=NULL)
	****** SETTING DATA VALUES BY PARAM ID ********* Use one of the following to set the data value in a fixed or variable datum record, depending on the data type of your data.
virtual void	setDatumValFloat32 (DtDatumParam param, DtFloat32 val, DtDatumRetCode *retcode=NULL)
virtual void	setDatumValInt32 (DtDatumParam param, long val, DtDatumRetCode *retcode=NULL)
virtual void	setDatumValUnsigned32 (DtDatumParam param, unsigned long val, DtDatumRetCode *retcode=NULL)
virtual void	setDatumValByteArray (DtDatumParam param, const char *val, DtDatumRetCode *retcode=NULL)
virtual void	printData () const
	Implements DtPdu's virtual function to print the PDU's data.
virtual void	printDataToStream (std::ostream &stream) const
	Prints the contents of the PDU to the specified stream.
virtual void	printDataSection () const
	Helper function that prints only the contents of the data records.
virtual void	printDataSectionToStream (std::ostream &stream) const
Public Member Functions inherited from DtSimanPdu
DtSimanPdu &	operator= (const DtSimanPdu &orig)
	Assignment operator.
virtual const DtEntityIdentifier &	senderId () const
	Get the sender ID.
virtual const DtEntityIdentifier &	receiverId () const
	Get the receiver ID.
virtual void	setSenderId (const DtEntityIdentifier &id)
	Set the sender ID.
virtual void	setReceiverId (const DtEntityIdentifier &id)
	Set the receiver ID.
Public Member Functions inherited from DtInteraction
	DtInteraction ()
	default constructor
virtual	~DtInteraction ()
	destructor
	DtInteraction (const DtInteraction &orig)
	copy constructor
DtInteraction &	operator= (const DtInteraction &orig)
	assignment operator
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	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 a DtCommentPdu.
static void	addCallback (DtExerciseConn *conn, DtCommentPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtCommentPduCb cb, void *usr)

Protected Member Functions
DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
DtNetDataPduTail *	dataSection () const
	Returns the data portion of the pdu.
Protected Member Functions inherited from DtPduWithData
virtual DtDatumRecordSet *	datumRecSet ()
	Returns our datum record set helper object.
virtual const DtDatumRecordSet *	datumRecSet () const
	Const version of above.
virtual DtNetFixDatum *	nthFixedDataRecord (int index) const
	Return a pointer to the index'th fixed data record in the network representation.
virtual DtNetVarDatum *	nthVarDataRecord (int index) const
	Return a pointer to the index'th variable data record in the network representation.
virtual void *	datumValPtr (DtDatumRecordType fixedOrVar, int index) const
	Returns a pointer to the index'th fixed or variable record in the network representation, depending on whether fixedOrVar is DtFIXED or DtVAR.

Additional Inherited Members
Protected Attributes inherited from DtPduWithData
DtDatumRecordSet *	myRecSet

Detailed Description

Instances of DtCommentPdu are used to send/receive comment PDUs.

Member Enumeration Documentation

anonymous enum

Enumerator:

PduStaticSize

Constructor & Destructor Documentation

DtCommentPdu::DtCommentPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtCommentPdu::DtCommentPdu	(	const DtNetCommentPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtCommentPdu::DtCommentPdu	(	const DtEntityIdentifier &	sender,
		const DtEntityIdentifier &	receiver,
		const char *	message,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Member Function Documentation

static void DtCommentPdu::addCallback ( DtExerciseConn *  conn, DtCommentPduCb  cb, void *  usr  )

static

Add (register)/Remove (deregister) function to be called when pdu is received.

virtual const char* DtCommentPdu::comment ( ) const

virtual

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

static

Create a DtCommentPdu.

Caller is responsible for deletion.

DtNetDataPduTail* DtCommentPdu::dataSection ( ) const

protectedvirtual

Returns the data portion of the pdu.

Implements DtPduWithData.

DtPduKind DtCommentPdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

References DtCommentPduKind.

static void DtCommentPdu::removeCallback ( DtExerciseConn *  conn, DtCommentPduCb  cb, void *  usr  )

static

virtual void DtCommentPdu::setComment ( const char *  message, int  size  )

virtual

Set the comment.

Comments are sent in the first variable length message record.

---

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

• commentPdu.h