DtMinefieldStatePdu Class Reference

class DtMinefieldStatePdu: More...

Inheritance diagram for DtMinefieldStatePdu:

Collaboration diagram for DtMinefieldStatePdu:

Public Member Functions
	DtMinefieldStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtMinefieldStatePdu (const DtNetMinefieldStatePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtMinefieldStatePdu (const DtMinefieldStatePdu &orig)
virtual	~DtMinefieldStatePdu ()
	destructor
DtMinefieldStatePdu &	operator= (const DtMinefieldStatePdu &orig)
	Assignment operator.
virtual void	setMinefieldID (const DtEntityIdentifier &id)
	Set/Get minefield ID.
virtual const DtEntityIdentifier &	minefieldID () const
virtual void	setSequenceNumber (DtU16 field)
	Set/Get minefield sequence number.
virtual DtU16	sequenceNumber () const
virtual void	setForceID (DtForceType force)
	Set/Get the force ID.
virtual DtForceType	forceID () const
virtual bool	setNumPerimeterPoints (DtU8 num)
	Set/Get the number of perimeter points.
virtual DtU8	numPerimeterPoints () const
virtual void	setMinefieldType (const DtEntityType &type)
	Set/Get minefield type.
virtual const DtEntityType &	minefieldType () const
virtual bool	setNumMineTypes (DtU16 num)
	Set/Get the number of mine types.
virtual DtU16	numMineTypes () const
virtual void	setLocation (const DtVector &coords)
	Set/Get location of minefield.
virtual const DtVector &	location () const
virtual void	setOrientation (const DtTaitBryan &orientation)
	Set/Get orientation.
virtual const DtTaitBryan &	orientation () const
virtual void	setAppearance (DtU16 app)
	Set/Get appearance (as a 16 bit integer).
virtual DtU16	appearance () const
virtual void	setAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
	Set/Get appearance by attribute.
virtual DtAppearAttrVal	appearanceAttribute (DtAppearAttribute attr) const
virtual void	setMinefieldProtocolMode (DtMinefieldProtocol mode)
	Set/Get which network protocol mode is being used in the minefield transmission.
virtual DtMinefieldProtocol	minefieldProtocolMode () const
virtual bool	setPerimeterPoint (int index, const DtMinefieldPerimeterRecord &init)
	Set/Get a perimeter point coordinate record, returns false if the index is out of range.
virtual bool	getPerimeterPoint (int index, DtMinefieldPerimeterRecord &record) const
virtual bool	setMineType (int index, const DtEntityType &init)
	Set/Get a mine type record.
virtual bool	getMineType (int index, DtEntityType &record) 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 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 DtMinefieldStatePdu.
static void	addCallback (DtExerciseConn *conn, DtMinefieldStatePduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtMinefieldStatePduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetMinefieldStatePdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtMinefieldStatePdu *	self () const
	Casts the 'this' pointer for changing elements in a const function Non-virtual since you can't override based on return type.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.
virtual int	perimeterPointRecordOffset (int recordIndex) const
	Returns a buffer offset to a perimeter point record.
virtual int	mineTypeRecordOffset (int recordIndex) const
	Returns a buffer offset to a mine type record.
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.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtEntityType	myEntityType
DtTaitBryan	myEulerAngles
DtVector	myVector
DtMinefieldPerimeterRecord	myPerimeterRecord
Protected Attributes inherited from DtPdu
int	myOKStatus
Protected Attributes inherited from DtBaseMsg
void *	myNetMsg
void *	myInternalBuff
int	myIntBuffSize
int	myMsgSize

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

Detailed Description

class DtMinefieldStatePdu:

Instances of DtMinefieldStatePdu are used to communicate minefield state information.

Constructor & Destructor Documentation

DtMinefieldStatePdu::DtMinefieldStatePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtMinefieldStatePdu::DtMinefieldStatePdu	(	const DtNetMinefieldStatePdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtMinefieldStatePdu::DtMinefieldStatePdu

(

const DtMinefieldStatePdu &

orig

)

virtual DtMinefieldStatePdu::~DtMinefieldStatePdu ( )

virtual

destructor

Member Function Documentation

static void DtMinefieldStatePdu::addCallback ( DtExerciseConn *  conn, DtMinefieldStatePduCb  cb, void *  usr  )

static

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

virtual DtU16 DtMinefieldStatePdu::appearance ( ) const

virtual

virtual DtAppearAttrVal DtMinefieldStatePdu::appearanceAttribute ( DtAppearAttribute  attr ) const

virtual

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

static

Create a DtMinefieldStatePdu.

Caller is responsible for deletion.

virtual DtForceType DtMinefieldStatePdu::forceID ( ) const

virtual

virtual bool DtMinefieldStatePdu::getMineType ( int  index, DtEntityType &  record  ) const

virtual

virtual bool DtMinefieldStatePdu::getPerimeterPoint ( int  index, DtMinefieldPerimeterRecord &  record  ) const

virtual

virtual DtPduKind DtMinefieldStatePdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual const DtVector& DtMinefieldStatePdu::location ( ) const

virtual

virtual const DtEntityIdentifier& DtMinefieldStatePdu::minefieldID ( ) const

virtual

virtual DtMinefieldProtocol DtMinefieldStatePdu::minefieldProtocolMode ( ) const

virtual

virtual const DtEntityType& DtMinefieldStatePdu::minefieldType ( ) const

virtual

virtual int DtMinefieldStatePdu::mineTypeRecordOffset ( int  recordIndex ) const

protectedvirtual

Returns a buffer offset to a mine type record.

virtual DtNetMinefieldStatePdu* DtMinefieldStatePdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual DtU16 DtMinefieldStatePdu::numMineTypes ( ) const

virtual

virtual DtU8 DtMinefieldStatePdu::numPerimeterPoints ( ) const

virtual

DtMinefieldStatePdu& DtMinefieldStatePdu::operator=

(

const DtMinefieldStatePdu &

orig

)

Assignment operator.

virtual const DtTaitBryan& DtMinefieldStatePdu::orientation ( ) const

virtual

virtual int DtMinefieldStatePdu::perimeterPointRecordOffset ( int  recordIndex ) const

protectedvirtual

Returns a buffer offset to a perimeter point record.

virtual void DtMinefieldStatePdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

static void DtMinefieldStatePdu::removeCallback ( DtExerciseConn *  conn, DtMinefieldStatePduCb  cb, void *  usr  )

static

DtMinefieldStatePdu* DtMinefieldStatePdu::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 DtU16 DtMinefieldStatePdu::sequenceNumber ( ) const

virtual

virtual void DtMinefieldStatePdu::setAppearance ( DtU16  app )

virtual

Set/Get appearance (as a 16 bit integer).

virtual void DtMinefieldStatePdu::setAppearanceAttribute ( DtAppearAttribute  attr, DtAppearAttrVal  val  )

virtual

Set/Get appearance by attribute.

virtual void DtMinefieldStatePdu::setForceID ( DtForceType  force )

virtual

Set/Get the force ID.

virtual void DtMinefieldStatePdu::setLocation ( const DtVector &  coords )

virtual

Set/Get location of minefield.

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

virtual

Set/Get minefield ID.

virtual void DtMinefieldStatePdu::setMinefieldProtocolMode ( DtMinefieldProtocol  mode )

virtual

Set/Get which network protocol mode is being used in the minefield transmission.

virtual void DtMinefieldStatePdu::setMinefieldType ( const DtEntityType &  type )

virtual

Set/Get minefield type.

virtual bool DtMinefieldStatePdu::setMineType ( int  index, const DtEntityType &  init  )

virtual

Set/Get a mine type record.

Returns false if the index is out of range.

virtual bool DtMinefieldStatePdu::setNumMineTypes ( DtU16  num )

virtual

Set/Get the number of mine types.

virtual bool DtMinefieldStatePdu::setNumPerimeterPoints ( DtU8  num )

virtual

Set/Get the number of perimeter points.

virtual void DtMinefieldStatePdu::setOrientation ( const DtTaitBryan &  orientation )

virtual

Set/Get orientation.

virtual bool DtMinefieldStatePdu::setPerimeterPoint ( int  index, const DtMinefieldPerimeterRecord &  init  )

virtual

Set/Get a perimeter point coordinate record, returns false if the index is out of range.

virtual void DtMinefieldStatePdu::setSequenceNumber ( DtU16  field )

virtual

Set/Get minefield sequence number.

virtual char* DtMinefieldStatePdu::var ( ) const

protectedvirtual

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

Member Data Documentation

DtEntityIdentifier DtMinefieldStatePdu::myEntityID

protected

Temporary objects for reference returns.

DtEntityType DtMinefieldStatePdu::myEntityType

protected

DtTaitBryan DtMinefieldStatePdu::myEulerAngles

protected

DtMinefieldPerimeterRecord DtMinefieldStatePdu::myPerimeterRecord

protected

DtVector DtMinefieldStatePdu::myVector

protected

const int DtMinefieldStatePdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

---

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

• mineStatePdu.h