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)
	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 DtStateMsg
	DtStateMsg ()
	default constructor
virtual	~DtStateMsg ()
	destructor
	DtStateMsg (const DtStateMsg &orig)
	copy constructor
DtStateMsg &	operator= (const DtStateMsg &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 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 Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtEnvironmentTypeRecord	myEnvironmentType
DtTaitBryan	myEulerAngles

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`
	)

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`
	)

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:

gridDataPdu.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation