DtGriddedDataPdu Class Reference

Instances of DtGriddedDataPdu are used to communicate environmental data defined on a grid. More...

Inheritance diagram for DtGriddedDataPdu:

Collaboration diagram for DtGriddedDataPdu:

Public Member Functions
	DtGriddedDataPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtGriddedDataPdu (const DtNetGriddedDataPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	DtGriddedDataPdu (const DtGriddedDataPdu &orig)
virtual	~DtGriddedDataPdu ()
	destructor
DtGriddedDataPdu &	operator= (const DtGriddedDataPdu &orig)
	Assignment operator.
virtual void	setEnvSimAppID (const DtEntityIdentifier &app)
	Set/Get environmental simulation application identifier.
virtual const DtEntityIdentifier &	envSimAppID () const
virtual void	setFieldNumber (DtU16 field)
	Set/Get field number.
virtual DtU16	fieldNumber () const
virtual void	setPduNumber (DtU16 num)
	Set/Get the PDU index number.
virtual DtU16	pduNumber () const
virtual void	setPduTotal (DtU16 total)
	Set/Get total number of PDUs used to transmit the environmental data.
virtual DtU16	pduTotal () const
virtual void	setCoordSystem (DtU16 sys)
	Set/Get coordinate system.
virtual DtU16	coordSystem () const
virtual bool	setNumGridAxes (DtU8 axes)
	Set/Get number of grid axes.
virtual DtU8	numGridAxes () const
virtual void	setConstantGrid (DtU8 constant)
	Set/Get constant grid indicator.
virtual DtU8	constantGrid () const
virtual void	setEnvironmentType (const DtEnvironmentTypeRecord &type)
	Set/Get environment type.
virtual const DtEnvironmentTypeRecord &	environmentType () const
virtual void	setOrientation (const DtTaitBryan &orientation)
	Set/Get orientation.
virtual const DtTaitBryan &	orientation () const
virtual void	setSampleTime (int index, DtU32 time)
	Set/Get sample time.
virtual DtU32	sampleTime (int index) const
virtual void	setTotalValues (DtU32 total)
	Set/Get total values.
virtual DtU32	totalValues () const
virtual bool	setVectorDim (DtU8 dim)
	Set/Get vector dimension.
virtual DtU8	vectorDim () const
virtual DtGridAxisType	gridAxisRecordType (int index) const
	Get the grid axes record type for a particular record.
virtual bool	setGridAxisRecord (int index, const DtGridAxisRecordFixed &init)
	Set/Get the grid axis record type and values of record index to values specified by the initializer in the second argument.
virtual bool	getGridAxisRecord (int index, DtGridAxisRecordFixed &record) const
virtual bool	setGridAxisRecord (int index, const DtGridAxisRecordVariable &init)
virtual bool	getGridAxisRecord (int index, DtGridAxisRecordVariable &record) const
virtual DtGridDataRecType	gridDataRecordType (int index) const
	Get the grid data record type for a particular record.
virtual bool	setGridDataRecord (int index, const DtGridDataRecordType0 &init)
	Set/Get the grid data record type and values of record index to values specified by the initializer in the second argument.
virtual bool	getGridDataRecord (int index, DtGridDataRecordType0 &record) const
virtual bool	setGridDataRecord (int index, const DtGridDataRecordType1 &init)
virtual bool	getGridDataRecord (int index, DtGridDataRecordType1 &record) const
virtual bool	setGridDataRecord (int index, const DtGridDataRecordType2 &init)
virtual bool	getGridDataRecord (int index, DtGridDataRecordType2 &record) const
virtual void	printData () const
	Print the data contained by this PDU to DtInfo.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data contained by this PDU to the specified 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 void	setReceivedTime (DtTime t)
	absRealTime when PDU was received into buffer.
virtual DtTime	receivedTime () const
virtual void	setPduLength (unsigned int length)
	Set the PDU header's length.
virtual unsigned int	pduLength () const
	Return the length of the PDU, as indicated in the PDU header.
virtual void	setPduStatus (int)
	Set the PDU Status in the PDU header.
virtual int	pduStatus () const
	Returns the PDU Status from the PDU header.
virtual void	setTransferredEntityIndicator (bool difference)
	Set the Transferred Entity Indicator in the PDU header False is No Difference True is Difference.
virtual bool	transferredEntityIndicator () const
	Returns the Transferred Entity Indicator from the PDU header False is No Difference True is Difference.
virtual void	setLvcIndicator (DtPduStatusLVCIndicator lvcIndicator)
	Set the LVC Indicator in the PDU header.
virtual DtPduStatusLVCIndicator	lvcIndicator () const
	Returns the LVC Indicator from the PDU header.
virtual void	setCoupledExtensionIndicator (bool coupled)
	Set the Coupled Extension Indicator in the PDU Header False is Not Coupled True is Coupled.
virtual bool	coupledExtensionIndicator () const
	Returns the Coupled Extension Indicator from the PDU Header False is Not Coupled True is Coupled.
virtual void	setFireTypeIndicator (DtPduStatusFireTypeIndicator fireTypeIndicator)
	Set the Fire Type Indicator in the PDU header.
virtual DtPduStatusFireTypeIndicator	fireTypeIndicator () const
	Returns the Fire Type Indicator from the PDU header.
virtual void	setDetonationTypeIndicator (DtPduStatusDetonationTypeIndicator detonationTypeIndicator)
	Set the Detonation Type Indicator in the PDU header.
virtual DtPduStatusDetonationTypeIndicator	detonationTypeIndicator () const
	Returns the Detonation Type Indicator from the PDU header.
virtual void	setRadioAttachedIndicator (DtPduStatusRadioAttachedIndicator radioAttachedIndicator)
	Set the Radio Attached Indicator in the PDU header.
virtual DtPduStatusRadioAttachedIndicator	radioAttachedIndicator () const
	Returns the Radio Attached Indicator from the PDU header.
virtual void	setIntercomAttachedIndicator (DtPduStatusIntercomAttachedIndicator intercomAttachedIndicator)
	Set the Intercom Attached Indicator in the PDU header.
virtual DtPduStatusIntercomAttachedIndicator	intercomAttachedIndicator () const
	Returns the Intercom Attached Indicator from the PDU header.
virtual void	setIffSimulationMode (bool interactive)
	Set the IFF Simulation Mode in the PDU header.
virtual bool	iffSimulationMode () const
	Returns the IFF Simulation Mode from the PDU header.
virtual void	setActiveInterrogationIndicator (bool active)
	Set the Active Interrogation Indicator in the PDU header.
virtual bool	activeInterrogationIndicator () const
	Returns the Active Interrogation Indicator from the 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
virtual void	printPduInHexToStream (std::ostream &stream, unsigned int numberOfColumns) const
	Prints the entire PDU's internal buffer to the stream in Hex.
virtual void	encode ()
	Encode method.
virtual void	decode (DtPduFactory *pduFactory)
	Decode method.
virtual bool	isTransientPdu () const
	This method returns true if transient, false if state.
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.
	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	changeBufferSize (int size)
	Changes the size of the message buffer, but not the message itself.
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.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	Create a DtGriddedDataPdu.
static void	addCallback (DtExerciseConn *conn, DtGriddedDataPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtGriddedDataPduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetGriddedDataPdu *	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.
DtGriddedDataPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
virtual int	gridAxisRecordLength (DtNetGridAxisRecordFixed *rec) const
	Returns the length of a given grid axis record.
virtual int	gridDataRecordLength (DtNetGridDataRecord *rec) const
	Returns the length of a given grid data record.
virtual int	gridAxisRecordOffset (int recordIndex) const
	Returns a buffer offset to the given grid axis record.
virtual int	gridDataRecordOffset (int recordIndex) const
	Returns a buffer offset to the given grid data record.
virtual bool	resizeGridAxisRecord (DtNetGridAxisRecordFixed *rec, int newSize)
	Resizes a grid axis record.
virtual bool	resizeGridDataRecord (DtNetGridDataRecord *rec, int newSize)
	Resizes a grid data 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, DtPduFactory *pduFactory)
	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.
virtual bool	isTEIApplicable () const
	Returns whether a PDU Status is applicable to this PDU (based on PDU Type) These methods are only relevant in DIS 7 and greater.
virtual bool	isLVCApplicable () const
virtual bool	isCEIApplicable () const
virtual bool	isFTIApplicable () const
virtual bool	isDTIApplicable () const
virtual bool	isRAIApplicable () const
virtual bool	isIAIApplicable () const
virtual bool	isISMApplicable () const
virtual bool	isAIIApplicable () const
virtual bool	shouldAttributePduBeCoupled () const

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtEnvironmentTypeRecord	myEnvironmentType
DtTaitBryan	myEulerAngles
Protected Attributes inherited from DtPdu
DtPduEncoder *	myEncoder
DtPduDecoder *	myDecoder
int	myOKStatus
DtTime	myReceivedTime
Protected Attributes inherited from DtBaseMsg
void *	myNetMsg
void *	myInternalBuff
int	myIntBuffSize
int	myMsgSize
int	myNetworkMsgSize

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

Detailed Description

Instances of DtGriddedDataPdu are used to communicate environmental data defined on a grid.

Constructor & Destructor Documentation

DtGriddedDataPdu::DtGriddedDataPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtGriddedDataPdu::DtGriddedDataPdu	(	const DtNetGriddedDataPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER,
		DtPduFactory *	pduFactory = 0
	)

DtGriddedDataPdu::DtGriddedDataPdu

(

const DtGriddedDataPdu &

orig

)

virtual DtGriddedDataPdu::~DtGriddedDataPdu ( )

virtual

destructor

Member Function Documentation

static void DtGriddedDataPdu::addCallback ( DtExerciseConn *  conn, DtGriddedDataPduCb  cb, void *  usr  )

static

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

virtual DtU8 DtGriddedDataPdu::constantGrid ( ) const

virtual

virtual DtU16 DtGriddedDataPdu::coordSystem ( ) const

virtual

static DtPdu* DtGriddedDataPdu::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory *  pduFactory = 0  )

static

Create a DtGriddedDataPdu.

Caller is responsible for deletion.

virtual const DtEnvironmentTypeRecord& DtGriddedDataPdu::environmentType ( ) const

virtual

virtual const DtEntityIdentifier& DtGriddedDataPdu::envSimAppID ( ) const

virtual

virtual DtU16 DtGriddedDataPdu::fieldNumber ( ) const

virtual

virtual bool DtGriddedDataPdu::getGridAxisRecord ( int  index, DtGridAxisRecordFixed &  record  ) const

virtual

virtual bool DtGriddedDataPdu::getGridAxisRecord ( int  index, DtGridAxisRecordVariable &  record  ) const

virtual

virtual bool DtGriddedDataPdu::getGridDataRecord ( int  index, DtGridDataRecordType0 &  record  ) const

virtual

virtual bool DtGriddedDataPdu::getGridDataRecord ( int  index, DtGridDataRecordType1 &  record  ) const

virtual

virtual bool DtGriddedDataPdu::getGridDataRecord ( int  index, DtGridDataRecordType2 &  record  ) const

virtual

virtual int DtGriddedDataPdu::gridAxisRecordLength ( DtNetGridAxisRecordFixed *  rec ) const

protectedvirtual

Returns the length of a given grid axis record.

virtual int DtGriddedDataPdu::gridAxisRecordOffset ( int  recordIndex ) const

protectedvirtual

Returns a buffer offset to the given grid axis record.

virtual DtGridAxisType DtGriddedDataPdu::gridAxisRecordType ( int  index ) const

virtual

Get the grid axes record type for a particular record.

virtual int DtGriddedDataPdu::gridDataRecordLength ( DtNetGridDataRecord *  rec ) const

protectedvirtual

Returns the length of a given grid data record.

virtual int DtGriddedDataPdu::gridDataRecordOffset ( int  recordIndex ) const

protectedvirtual

Returns a buffer offset to the given grid data record.

virtual DtGridDataRecType DtGriddedDataPdu::gridDataRecordType ( int  index ) const

virtual

Get the grid data record type for a particular record.

virtual DtPduKind DtGriddedDataPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNetGriddedDataPdu* DtGriddedDataPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual DtU8 DtGriddedDataPdu::numGridAxes ( ) const

virtual

DtGriddedDataPdu& DtGriddedDataPdu::operator=

(

const DtGriddedDataPdu &

orig

)

Assignment operator.

virtual const DtTaitBryan& DtGriddedDataPdu::orientation ( ) const

virtual

virtual DtU16 DtGriddedDataPdu::pduNumber ( ) const

virtual

virtual DtU16 DtGriddedDataPdu::pduTotal ( ) const

virtual

virtual void DtGriddedDataPdu::printData ( ) const

virtual

Print the data contained by this PDU to DtInfo.

Reimplemented from DtPdu.

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

virtual

Print the data contained by this PDU to the specified stream.

Reimplemented from DtPdu.

static void DtGriddedDataPdu::removeCallback ( DtExerciseConn *  conn, DtGriddedDataPduCb  cb, void *  usr  )

static

virtual bool DtGriddedDataPdu::resizeGridAxisRecord ( DtNetGridAxisRecordFixed *  rec, int  newSize  )

protectedvirtual

Resizes a grid axis record.

virtual bool DtGriddedDataPdu::resizeGridDataRecord ( DtNetGridDataRecord *  rec, int  newSize  )

protectedvirtual

Resizes a grid data record.

virtual DtU32 DtGriddedDataPdu::sampleTime ( int  index ) const

virtual

DtGriddedDataPdu* DtGriddedDataPdu::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 DtGriddedDataPdu::setConstantGrid ( DtU8  constant )

virtual

Set/Get constant grid indicator.

virtual void DtGriddedDataPdu::setCoordSystem ( DtU16  sys )

virtual

Set/Get coordinate system.

virtual void DtGriddedDataPdu::setEnvironmentType ( const DtEnvironmentTypeRecord &  type )

virtual

Set/Get environment type.

virtual void DtGriddedDataPdu::setEnvSimAppID ( const DtEntityIdentifier &  app )

virtual

Set/Get environmental simulation application identifier.

virtual void DtGriddedDataPdu::setFieldNumber ( DtU16  field )

virtual

Set/Get field number.

virtual bool DtGriddedDataPdu::setGridAxisRecord ( int  index, const DtGridAxisRecordFixed &  init  )

virtual

Set/Get the grid axis record type and values of record index to values specified by the initializer in the second argument.

If index is out of bounds, or if the record type at the specified index does not match the parameter record type (for a get), then false is returned. If the space would exceed the maximum space permitted for a PDU (for a set) then false may be returned.

virtual bool DtGriddedDataPdu::setGridAxisRecord ( int  index, const DtGridAxisRecordVariable &  init  )

virtual

virtual bool DtGriddedDataPdu::setGridDataRecord ( int  index, const DtGridDataRecordType0 &  init  )

virtual

Set/Get the grid data record type and values of record index to values specified by the initializer in the second argument.

If index is out of bounds, or if the record type at the specified index does not match the parameter record type (for a get), then false is returned. If the space would exceed the maximum space permitted for a PDU (for a set) then false may be returned.

virtual bool DtGriddedDataPdu::setGridDataRecord ( int  index, const DtGridDataRecordType1 &  init  )

virtual

virtual bool DtGriddedDataPdu::setGridDataRecord ( int  index, const DtGridDataRecordType2 &  init  )

virtual

virtual bool DtGriddedDataPdu::setNumGridAxes ( DtU8  axes )

virtual

Set/Get number of grid axes.

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

virtual

Set/Get orientation.

virtual void DtGriddedDataPdu::setPduNumber ( DtU16  num )

virtual

Set/Get the PDU index number.

virtual void DtGriddedDataPdu::setPduTotal ( DtU16  total )

virtual

Set/Get total number of PDUs used to transmit the environmental data.

virtual void DtGriddedDataPdu::setSampleTime ( int  index, DtU32  time  )

virtual

Set/Get sample time.

This is a 64-bit quantity. The argument index selects between the most significant 32-bit word (0) and least significant 32-bit word (1) of the complete 64-bit value.

virtual void DtGriddedDataPdu::setTotalValues ( DtU32  total )

virtual

Set/Get total values.

virtual bool DtGriddedDataPdu::setVectorDim ( DtU8  dim )

virtual

Set/Get vector dimension.

setVectorDim may return false if the PDU size exceeds the maximum allowable size for a PDU.

virtual DtU32 DtGriddedDataPdu::totalValues ( ) const

virtual

virtual char* DtGriddedDataPdu::var ( ) const

protectedvirtual

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

virtual DtU8 DtGriddedDataPdu::vectorDim ( ) const

virtual

Member Data Documentation

DtEntityIdentifier DtGriddedDataPdu::myEntityID

protected

Temporary objects for reference returns.

DtEnvironmentTypeRecord DtGriddedDataPdu::myEnvironmentType

protected

DtTaitBryan DtGriddedDataPdu::myEulerAngles

protected

const int DtGriddedDataPdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

---

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

• griddedDataPdu.h