DtMinefieldResponseNackPdu Class Reference

Instances of DtMinefieldResponseNackPdu are used to request a retransmission of minefield data PDUs. More...

Inheritance diagram for DtMinefieldResponseNackPdu:

Collaboration diagram for DtMinefieldResponseNackPdu:

Public Member Functions
	DtMinefieldResponseNackPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtMinefieldResponseNackPdu (const DtNetMinefieldResponseNackPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtMinefieldResponseNackPdu (const DtMinefieldResponseNackPdu &orig)
virtual	~DtMinefieldResponseNackPdu ()
	destructor
DtMinefieldResponseNackPdu &	operator= (const DtMinefieldResponseNackPdu &orig)
	Assignment operator.
virtual void	setMinefieldID (const DtEntityIdentifier &id)
	Set/Get minefield ID.
virtual const DtEntityIdentifier &	minefieldID () const
virtual void	setRequestingEntityID (const DtEntityIdentifier &id)
	Set/Get requesting entity ID.
virtual const DtEntityIdentifier &	requestingEntityID () const
virtual void	setRequestID (DtU8 id)
	Set/Get request ID.
virtual DtU8	requestID () const
virtual bool	setNumMissingPDUs (DtU8 num)
	Set/Get the number of missing PDUs.
virtual DtU8	numMissingPDUs () const
virtual bool	setPDU_SequenceNumber (int index, DtU8 num)
	Set/Get a PDU sequence number.
virtual bool	getPDU_SequenceNumber (int index, DtU8 &num) const
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data to a stream.
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 DtMinefieldResponseNackPdu.
static void	addCallback (DtExerciseConn *conn, DtMinefieldResponseNackPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtMinefieldResponseNackPduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetMinefieldResponseNackPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.
DtMinefieldResponseNackPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.

Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero parameter records.

Detailed Description

Instances of DtMinefieldResponseNackPdu are used to request a retransmission of minefield data PDUs.

Constructor & Destructor Documentation

DtMinefieldResponseNackPdu::DtMinefieldResponseNackPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtMinefieldResponseNackPdu::DtMinefieldResponseNackPdu	(	const DtNetMinefieldResponseNackPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtMinefieldResponseNackPdu::DtMinefieldResponseNackPdu

(

const DtMinefieldResponseNackPdu &

orig

)

virtual DtMinefieldResponseNackPdu::~DtMinefieldResponseNackPdu ( )

virtual

destructor

Member Function Documentation

static void DtMinefieldResponseNackPdu::addCallback ( DtExerciseConn *  conn, DtMinefieldResponseNackPduCb  cb, void *  usr  )

static

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

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

static

Create a DtMinefieldResponseNackPdu.

Caller is responsible for deletion.

virtual bool DtMinefieldResponseNackPdu::getPDU_SequenceNumber ( int  index, DtU8 &  num  ) const

virtual

virtual DtPduKind DtMinefieldResponseNackPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual const DtEntityIdentifier& DtMinefieldResponseNackPdu::minefieldID ( ) const

virtual

virtual DtNetMinefieldResponseNackPdu* DtMinefieldResponseNackPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual DtU8 DtMinefieldResponseNackPdu::numMissingPDUs ( ) const

virtual

DtMinefieldResponseNackPdu& DtMinefieldResponseNackPdu::operator=

(

const DtMinefieldResponseNackPdu &

orig

)

Assignment operator.

virtual void DtMinefieldResponseNackPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtMinefieldResponseNackPdu::printDataToStream ( std::ostream &  stream ) const

virtual

Print the data to a stream.

Reimplemented from DtPdu.

static void DtMinefieldResponseNackPdu::removeCallback ( DtExerciseConn *  conn, DtMinefieldResponseNackPduCb  cb, void *  usr  )

static

virtual DtU8 DtMinefieldResponseNackPdu::requestID ( ) const

virtual

virtual const DtEntityIdentifier& DtMinefieldResponseNackPdu::requestingEntityID ( ) const

virtual

DtMinefieldResponseNackPdu* DtMinefieldResponseNackPdu::self ( ) const

protected

Casts the 'this' pointer for changing elements in a const function.

Non-virtual, since you can't override based on return type.

virtual void DtMinefieldResponseNackPdu::setMinefieldID ( const DtEntityIdentifier &  id )

virtual

Set/Get minefield ID.

virtual bool DtMinefieldResponseNackPdu::setNumMissingPDUs ( DtU8  num )

virtual

Set/Get the number of missing PDUs.

virtual bool DtMinefieldResponseNackPdu::setPDU_SequenceNumber ( int  index, DtU8  num  )

virtual

Set/Get a PDU sequence number.

Returns false if the index is out of range.

virtual void DtMinefieldResponseNackPdu::setRequestID ( DtU8  id )

virtual

Set/Get request ID.

virtual void DtMinefieldResponseNackPdu::setRequestingEntityID ( const DtEntityIdentifier &  id )

virtual

Set/Get requesting entity ID.

virtual char* DtMinefieldResponseNackPdu::var ( ) const

protectedvirtual

Returns a pointer to the first byte of variable length data.

Member Data Documentation

DtEntityIdentifier DtMinefieldResponseNackPdu::myEntityID

protected

Temporary objects for reference returns.

const int DtMinefieldResponseNackPdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

---

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

• mineRsNackPdu.h