Instances of DtEnvironmentalProcessPdu are used to send information about environmental effects and processes. More...

Inheritance diagram for DtEnvironmentalProcessPdu:

Collaboration diagram for DtEnvironmentalProcessPdu:

Public Member Functions
	DtEnvironmentalProcessPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtEnvironmentalProcessPdu (const DtNetEnvironmentalProcessPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtEnvironmentalProcessPdu (const DtEnvironmentalProcessPdu &orig)
virtual	~DtEnvironmentalProcessPdu ()
	destructor
DtEnvironmentalProcessPdu &	operator= (const DtEnvironmentalProcessPdu &orig)
	Assignment operator.
virtual void	setEnvironmentalProcessID (const DtEntityIdentifier &entity)
	Set/Get originating environmental process ID.
virtual const DtEntityIdentifier &	environmentalProcessID () const
virtual void	setEnvironmentType (const DtEnvironmentTypeRecord &type)
	Set/Get environment type.
virtual const DtEnvironmentTypeRecord &	environmentType () const
virtual void	setModelType (DtEnvironmentalModelType value)
	Set/Get the model type.
virtual DtEnvironmentalModelType	modelType () const
virtual void	setEnvironmentalStatus (DtU8 value)
	Set/Get the environmental status (as an 8-bit value).
virtual DtU8	environmentalStatus () const
virtual void	setEnvironmentalStatusBit (DtEnvironmentalStatusBit bit, bool value)
	Set/Get an environmental status bit.
virtual bool	environmentalStatusBit (DtEnvironmentalStatusBit bit) const
virtual bool	setNumberOfEnvironmentalRecords (DtU16 newNumberOfRecords)
	Set/Get number of environment records.
virtual DtU16	numberOfEnvironmentalRecords () const
virtual void	setSequenceNumber (DtU16 value)
	Set/Get sequence number.
virtual DtU16	sequenceNumber () const
virtual bool	setRecordBitSize (int recordIndex, int newRecordBitSize)
	Set the size of an environmental record (in bits).
virtual DtNetEnvironmentalRecord *	recordPointer (int recordIndex) const
	Get a pointer to an environmental record.
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
virtual int	numberOfGeometryRecords () const
	New accessors and mutators based on assumptions about what types of environment records we'll have.
virtual DtEnvironmentalRecordType	geometryRecordType (int index) const
	This returns the type of the geometry record with the index specified.
virtual DtEnvironmentalRecordType	stateRecordType (int index) const
	This returns the type of the state record associated with the geometry record with the index specified.
virtual bool	getGeometryRecord (int index, DtEnvironmentalGeometryRecord &geometryRecord) const
	This returns a reference to the nth geometry record.
virtual bool	getStateRecord (int index, DtEnvironmentalRecord &stateRecord) const
	This returns a reference to the state record associated with the nth geometry record.
virtual void	setEnvironmentalRecord (int index, const DtEnvironmentalRecord &envRecord)
	This sets the index'th record to the values in the envRecord supplied.
Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create a DtEnvironmentalProcessPdu.
static void	addCallback (DtExerciseConn conn, DtEnvironmentalProcessPduCb cb, void usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn conn, DtEnvironmentalProcessPduCb cb, void usr)
static void	setLengthIsWholeEnvRec (bool lengthMode)
	Methods to set the static variable theLengthIsWholeRec.
static bool	lengthIsWholeEnvRec ()
Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
DtNetEnvironmentalProcessPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtEnvironmentalProcessPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.
virtual int	recordOffset (int recordIndex) const
	Returns an offset in bytes from the beginning of the variable length data region to the beginning of a particular record.
virtual void	invalidateCache ()
void	verifyRecDataSize ()
	Checks the size of the stated length of all environment records, and compares it with the actual length of the PDU, to check for the incorrect lengths of records.
Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtEnvironmentTypeRecord	myEnvironmentType
std::vector< int >	myOffsetCache
Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero data bytes.
static bool	theLengthIsWholeRec

Detailed Description

Instances of DtEnvironmentalProcessPdu are used to send information about environmental effects and processes.

Constructor & Destructor Documentation

DtEnvironmentalProcessPdu::DtEnvironmentalProcessPdu ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

DtEnvironmentalProcessPdu::DtEnvironmentalProcessPdu	(	const DtNetEnvironmentalProcessPdu *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

DtEnvironmentalProcessPdu::DtEnvironmentalProcessPdu ( const DtEnvironmentalProcessPdu & orig )

virtual DtEnvironmentalProcessPdu::~DtEnvironmentalProcessPdu ( ) [virtual]

destructor

Member Function Documentation

static void DtEnvironmentalProcessPdu::addCallback	(	DtExerciseConn *	conn,
		DtEnvironmentalProcessPduCb	cb,
		void *	usr
	)		`[static]`

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

static DtPdu* DtEnvironmentalProcessPdu::create	(	const DtNetPacket *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)		`[static]`

Create a DtEnvironmentalProcessPdu.

Caller is responsible for deletion.

virtual const DtEntityIdentifier& DtEnvironmentalProcessPdu::environmentalProcessID ( ) const [virtual]

virtual DtU8 DtEnvironmentalProcessPdu::environmentalStatus ( ) const [virtual]

virtual bool DtEnvironmentalProcessPdu::environmentalStatusBit ( DtEnvironmentalStatusBit bit ) const [virtual]

virtual const DtEnvironmentTypeRecord& DtEnvironmentalProcessPdu::environmentType ( ) const [virtual]

virtual DtEnvironmentalRecordType DtEnvironmentalProcessPdu::geometryRecordType ( int index ) const [virtual]

This returns the type of the geometry record with the index specified.

virtual bool DtEnvironmentalProcessPdu::getGeometryRecord	(	int	index,
		DtEnvironmentalGeometryRecord &	geometryRecord
	)		const `[virtual]`

This returns a reference to the nth geometry record.

The user must supply a DtEnvironmentalRecord of the correct type (use geometryRecordType() first(!)) because it is that class that knows how to convert the network representation in the PDU into the DtEnvironmentalRecord (host) representation,

virtual bool DtEnvironmentalProcessPdu::getStateRecord	(	int	index,
		DtEnvironmentalRecord &	stateRecord
	)		const `[virtual]`

This returns a reference to the state record associated with the nth geometry record.

The user must supply a DtEnvironmentalRecord of the correct type (use stateRecordType() first(!)) because it is that class that knows how to convert the network representation in the PDU into the DtEnvironmentalRecord (host) representation,

virtual DtPduKind DtEnvironmentalProcessPdu::internalGetPduKind ( ) const [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual void DtEnvironmentalProcessPdu::invalidateCache ( ) [protected, virtual]

static bool DtEnvironmentalProcessPdu::lengthIsWholeEnvRec ( ) [static]

virtual DtEnvironmentalModelType DtEnvironmentalProcessPdu::modelType ( ) const [virtual]

DtNetEnvironmentalProcessPdu* DtEnvironmentalProcessPdu::netPduStruct ( ) const [protected]

Casts the netPdu element to our network struct.

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

virtual DtU16 DtEnvironmentalProcessPdu::numberOfEnvironmentalRecords ( ) const [virtual]

virtual int DtEnvironmentalProcessPdu::numberOfGeometryRecords ( ) const [virtual]

New accessors and mutators based on assumptions about what types of environment records we'll have.

The enumeration document establishes the convention that geometry types use the high order 2 bytes of the type field, while state types use the lower two. Assuming that convention is followed, this returns the number of geometry records in the PDU

DtEnvironmentalProcessPdu& DtEnvironmentalProcessPdu::operator= ( const DtEnvironmentalProcessPdu & orig )

Assignment operator.

virtual void DtEnvironmentalProcessPdu::printData ( ) const [virtual]

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtEnvironmentalProcessPdu::printDataToStream ( std::ostream & stream ) const [virtual]

Reimplemented from DtPdu.

virtual int DtEnvironmentalProcessPdu::recordOffset ( int recordIndex ) const [protected, virtual]

Returns an offset in bytes from the beginning of the variable length data region to the beginning of a particular record.

virtual DtNetEnvironmentalRecord* DtEnvironmentalProcessPdu::recordPointer ( int recordIndex ) const [virtual]

Get a pointer to an environmental record.

Returns false if the record index is out of range.

static void DtEnvironmentalProcessPdu::removeCallback	(	DtExerciseConn *	conn,
		DtEnvironmentalProcessPduCb	cb,
		void *	usr
	)		`[static]`

DtEnvironmentalProcessPdu* DtEnvironmentalProcessPdu::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 DtEnvironmentalProcessPdu::sequenceNumber ( ) const [virtual]

virtual void DtEnvironmentalProcessPdu::setEnvironmentalProcessID ( const DtEntityIdentifier & entity ) [virtual]

Set/Get originating environmental process ID.

virtual void DtEnvironmentalProcessPdu::setEnvironmentalRecord	(	int	index,
		const DtEnvironmentalRecord &	envRecord
	)		`[virtual]`

This sets the index'th record to the values in the envRecord supplied.

virtual void DtEnvironmentalProcessPdu::setEnvironmentalStatus ( DtU8 value ) [virtual]

Set/Get the environmental status (as an 8-bit value).

virtual void DtEnvironmentalProcessPdu::setEnvironmentalStatusBit	(	DtEnvironmentalStatusBit	bit,
		bool	value
	)		`[virtual]`

Set/Get an environmental status bit.

virtual void DtEnvironmentalProcessPdu::setEnvironmentType ( const DtEnvironmentTypeRecord & type ) [virtual]

Set/Get environment type.

static void DtEnvironmentalProcessPdu::setLengthIsWholeEnvRec ( bool lengthMode ) [static]

Methods to set the static variable theLengthIsWholeRec.

If theLengthIsWholeRec = false, then DtNetEnviornmentalRecord.myLength will contain the length (in bits) of the entire DtNetEnvironmentalRecord. If theLengthIsWholeRec = true, the DtNetEnvironmentalRecord.myLength will contain the length (in bits) of the VariantData part of DtNetEnvironmentalRecord.

theLengthIsWholeRec = false by default

virtual void DtEnvironmentalProcessPdu::setModelType ( DtEnvironmentalModelType value ) [virtual]

Set/Get the model type.

virtual bool DtEnvironmentalProcessPdu::setNumberOfEnvironmentalRecords ( DtU16 newNumberOfRecords ) [virtual]

Set/Get number of environment records.

virtual bool DtEnvironmentalProcessPdu::setRecordBitSize	(	int	recordIndex,
		int	newRecordBitSize
	)		`[virtual]`

Set the size of an environmental record (in bits).

Returns false if the size is invalid.

virtual void DtEnvironmentalProcessPdu::setSequenceNumber ( DtU16 value ) [virtual]

Set/Get sequence number.

virtual DtEnvironmentalRecordType DtEnvironmentalProcessPdu::stateRecordType ( int index ) const [virtual]

This returns the type of the state record associated with the geometry record with the index specified.

0 is returned if there is no state record associated with the index'th geometry record.

virtual char* DtEnvironmentalProcessPdu::var ( ) const [protected, virtual]

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

void DtEnvironmentalProcessPdu::verifyRecDataSize ( ) [protected]

Checks the size of the stated length of all environment records, and compares it with the actual length of the PDU, to check for the incorrect lengths of records.

It will set the static of the PDU to "Not OK" if a mismatch is detected. This method is not virtual as it is called from the constructor.