DtMinefieldDataPdu Class Reference

Instances of DtMinefieldDataPdu are used to communicate minefield data information. More...

Inheritance diagram for DtMinefieldDataPdu:

Collaboration diagram for DtMinefieldDataPdu:

Public Member Functions
	DtMinefieldDataPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtMinefieldDataPdu (const DtNetMinefieldDataPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtMinefieldDataPdu (const DtMinefieldDataPdu &orig)
virtual	~DtMinefieldDataPdu ()
	destructor
DtMinefieldDataPdu &	operator= (const DtMinefieldDataPdu &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	setMinefieldSequenceNumber (DtU16 field)
	Set/Get minefield sequence number.
virtual DtU16	minefieldSequenceNumber () const
virtual void	setRequestID (DtU8 value)
	Set/Get the request ID.
virtual DtU8	requestID () const
virtual void	setPDU_SequenceNumber (DtU8 value)
	Set/Get the PDU sequence number.
virtual DtU8	PDU_SequenceNumber () const
virtual void	setNumberOfPdus (DtU8 value)
	Set/Get the number of PDUs.
virtual DtU8	numberOfPdus () const
virtual bool	setNumberOfMines (DtU8 value)
	Set/Get the number of mines (this call erases any data which was set in the variable length fields).
virtual DtU8	numberOfMines () const
virtual bool	setNumberOfSensorTypes (DtU8 value)
	Set/Get the number of sensor types (this call erases any data which was set in the variable length fields).
virtual DtU8	numberOfSensorTypes () const
virtual void	setDataFilter (DtU32 value)
	Set/Get the data filter as a 32-bit value (this call erases any data which was set in the variable length fields).
virtual DtU32	dataFilter () const
virtual void	setDataFilterBit (DtMinefieldDataFilterField field, bool value)
	Set/Get a data filter bit (this call erases any data which was set in the variable length fields).
virtual bool	dataFilterBit (DtMinefieldDataFilterField field) const
virtual void	setMineType (const DtEntityType &value)
	Set/Get the mine type record.
virtual const DtEntityType &	mineType () const
virtual bool	setSensorTypeCategory (int sensorIndex, DtSensorTypeCategory value)
	Set/Get a sensor type category.
virtual bool	getSensorTypeCategory (int sensorIndex, DtSensorTypeCategory &value) const
virtual bool	setSensorTypeSubcategory (int sensorIndex, DtU16 value)
	Set/Get a sensor type sub-category.
virtual bool	getSensorTypeSubcategory (int sensorIndex, DtU16 &value) const
virtual bool	setMineLocation (int mineIndex, const DtVector &value)
	Set/Get a mine location. Returns false if the index is out of range.
virtual bool	getMineLocation (int mineIndex, DtVector &value) const
virtual bool	setGroundBurialDepthOffset (int mineIndex, DtFloat32 value)
	Set/Get a ground burial depth offset.
virtual bool	getGroundBurialDepthOffset (int mineIndex, DtFloat32 &value) const
virtual bool	setWaterBurialDepthOffset (int mineIndex, DtFloat32 value)
	Set/Get a water burial depth offset.
virtual bool	getWaterBurialDepthOffset (int mineIndex, DtFloat32 &value) const
virtual bool	setSnowBurialDepthOffset (int mineIndex, DtFloat32 value)
	Set/Get a snow burial depth offset.
virtual bool	getSnowBurialDepthOffset (int mineIndex, DtFloat32 &value) const
virtual bool	setMineOrientation (int mineIndex, const DtTaitBryan &value)
	Set/Get mine orientation.
virtual bool	getMineOrientation (int mineIndex, DtTaitBryan &value) const
virtual bool	setThermalContrast (int mineIndex, DtFloat32 value)
	Set/Get a thermal contrast value.
virtual bool	getThermalContrast (int mineIndex, DtFloat32 &value) const
virtual bool	setReflectance (int mineIndex, DtFloat32 value)
	Set/Get a reflectance value.
virtual bool	getReflectance (int mineIndex, DtFloat32 &value) const
virtual bool	setMineEmplacementTime (int mineIndex, DtTime value)
	Set/Get a mine emplacement time.
virtual bool	getMineEmplacementTime (int mineIndex, DtTime &value) const
virtual bool	setMineEntityID (int mineIndex, DtU16 value)
	Set/Get a mine entity ID. Returns false if the index is out of range.
virtual bool	getMineEntityID (int mineIndex, DtU16 &value) const
virtual bool	setPrimaryFusing (int mineIndex, DtMinefieldFusing value)
	Set/Get primary fusing.
virtual bool	getPrimaryFusing (int mineIndex, DtMinefieldFusing &value) const
virtual bool	setSecondaryFusing (int mineIndex, DtMinefieldFusing value)
	Set/Get secondary fusing.
virtual bool	getSecondaryFusing (int mineIndex, DtMinefieldFusing &value) const
virtual bool	setAntiHandlingDevice (int mineIndex, DtMinefieldAntiHandlingDevice value)
	Set/Get anti-handling device.
virtual bool	getAntiHandlingDevice (int mineIndex, DtMinefieldAntiHandlingDevice &value) const
virtual bool	setScalarDetectionCoefficient (int sensorIndex, int mineIndex, DtU8 value)
	Set/Get scalar detection coefficient.
virtual bool	getScalarDetectionCoefficient (int sensorIndex, int mineIndex, DtU8 &value) const
virtual bool	setMinefieldAlgae (int mineIndex, DtMinefieldAlgae value)
	Set/Get minefield algae.
virtual bool	getMinefieldAlgae (int mineIndex, DtMinefieldAlgae &value) const
virtual bool	setPaintScheme (int mineIndex, DtMinefieldPaintScheme value)
	Set/Get paint scheme.
virtual bool	getPaintScheme (int mineIndex, DtMinefieldPaintScheme &value) const
virtual bool	setNumTripWires (int mineIndex, DtU8 num)
	Set/Get the number of trip/detonation wires.
virtual bool	getNumTripWires (int mineIndex, DtU8 &num) const
virtual bool	setNumVertices (int mineIndex, int wireIndex, DtU8 num)
	Set/Get the number of vertices.
virtual bool	getNumVertices (int mineIndex, int wireIndex, DtU8 &num) const
virtual bool	setVertex (int mineIndex, int wireIndex, int vertexIndex, const DtVector &value)
	Set/Get a vertex.
virtual bool	getVertex (int mineIndex, int wireIndex, int vertexIndex, DtVector &value) 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 DtMinefieldDataPdu.
static void	addCallback (DtExerciseConn *conn, DtMinefieldDataPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtMinefieldDataPduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetMinefieldDataPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtMinefieldDataPdu *	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	sensorTypeRecordOffset (int sensorIndex) const
	Returns a buffer offset to the sensor type records.
virtual int	sensorTypePaddingOffset () const
	Returns a buffer offset to the padding following sensor type information.
virtual int	sensorTypePaddingBytes () const
	Returns the number of padding bytes following sensor type information.
virtual int	mineLocationRecordOffset (int mineIndex) const
	Returns a buffer offset to the mine location records.
virtual int	groundBurialDepthRecordOffset (int mineIndex) const
	Returns a buffer offset to the ground burial depth records.
virtual int	waterBurialDepthRecordOffset (int mineIndex) const
	Returns a buffer offset to the water burial depth records.
virtual int	snowBurialDepthRecordOffset (int mineIndex) const
	Returns a buffer offset to the snow burial depth records.
virtual int	mineOrientationRecordOffset (int mineIndex) const
	Returns a buffer offset to the mine orientation records.
virtual int	thermalContrastRecordOffset (int mineIndex) const
	Returns a buffer offset to the thermal contrast records.
virtual int	reflectanceRecordOffset (int mineIndex) const
	Returns a buffer offset to the reflectance records.
virtual int	mineEmplacementTimeRecordOffset (int mineIndex) const
	Returns a buffer offset to the mine emplacement time records.
virtual int	mineEntityID_RecordOffset (int mineIndex) const
	Returns a buffer offset to the mine entity ID records.
virtual int	fusingRecordOffset (int mineIndex) const
	Returns a buffer offset to the fusing records.
virtual int	scalarDetectionCoefficientRecordOffset (int sensorIndex, int mineIndex) const
	Returns a buffer offset to the scalar detection coefficient records.
virtual int	paintSchemeRecordOffset (int mineIndex) const
	Returns a buffer offset to the paint scheme records.
virtual int	paintSchemePaddingOffset () const
	Returns a buffer offset to the padding following paint scheme records.
virtual int	paintSchemePaddingBytes () const
	Returns the number of padding bytes following paint scheme records.
virtual int	numberOfTripWiresRecordOffset (int mineIndex) const
	Returns a buffer offset to the number of wires records.
virtual int	numberOfTripWiresPaddingOffset () const
	Returns a buffer offset to the padding following number of wires records.
virtual int	numberOfTripWiresPaddingBytes () const
	Returns the number of padding bytes following number of wires records.
virtual int	variableDataLengthAfterReset () const
	Returns the length of the variable data section in the PDU after the variable data has been reset.
virtual int	numberOfVerticesRecordOffset (int mineIndex, int wireIndex) const
	Returns a buffer offset to the number of vertices records.
virtual int	numberOfVerticesPaddingOffset () const
	Returns a buffer offset to the padding following number of vertices records.
virtual int	numberOfVerticesPaddingBytes () const
	Returns the number of padding bytes following number of vertices records.
virtual int	vertexRecordOffset (int mineIndex, int wireIndex, int vertexIndex) const
	Returns a buffer offset to the vertex records.
virtual int	variableDataLength () const
	Returns the length of the variable data section in the PDU.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtEntityType	myEntityType

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

Detailed Description

Instances of DtMinefieldDataPdu are used to communicate minefield data information.

Constructor & Destructor Documentation

DtMinefieldDataPdu::DtMinefieldDataPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtMinefieldDataPdu::DtMinefieldDataPdu	(	const DtNetMinefieldDataPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtMinefieldDataPdu::DtMinefieldDataPdu

(

const DtMinefieldDataPdu &

orig

)

virtual DtMinefieldDataPdu::~DtMinefieldDataPdu ( )

virtual

destructor

Member Function Documentation

static void DtMinefieldDataPdu::addCallback ( DtExerciseConn *  conn, DtMinefieldDataPduCb  cb, void *  usr  )

static

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

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

static

Create a DtMinefieldDataPdu.

Caller is responsible for deletion.

virtual DtU32 DtMinefieldDataPdu::dataFilter ( ) const

virtual

virtual bool DtMinefieldDataPdu::dataFilterBit ( DtMinefieldDataFilterField  field ) const

virtual

virtual int DtMinefieldDataPdu::fusingRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the fusing records.

virtual bool DtMinefieldDataPdu::getAntiHandlingDevice ( int  mineIndex, DtMinefieldAntiHandlingDevice &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getGroundBurialDepthOffset ( int  mineIndex, DtFloat32 &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getMineEmplacementTime ( int  mineIndex, DtTime &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getMineEntityID ( int  mineIndex, DtU16 &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getMinefieldAlgae ( int  mineIndex, DtMinefieldAlgae &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getMineLocation ( int  mineIndex, DtVector &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getMineOrientation ( int  mineIndex, DtTaitBryan &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getNumTripWires ( int  mineIndex, DtU8 &  num  ) const

virtual

virtual bool DtMinefieldDataPdu::getNumVertices ( int  mineIndex, int  wireIndex, DtU8 &  num  ) const

virtual

virtual bool DtMinefieldDataPdu::getPaintScheme ( int  mineIndex, DtMinefieldPaintScheme &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getPrimaryFusing ( int  mineIndex, DtMinefieldFusing &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getReflectance ( int  mineIndex, DtFloat32 &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getScalarDetectionCoefficient ( int  sensorIndex, int  mineIndex, DtU8 &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getSecondaryFusing ( int  mineIndex, DtMinefieldFusing &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getSensorTypeCategory ( int  sensorIndex, DtSensorTypeCategory &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getSensorTypeSubcategory ( int  sensorIndex, DtU16 &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getSnowBurialDepthOffset ( int  mineIndex, DtFloat32 &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getThermalContrast ( int  mineIndex, DtFloat32 &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getVertex ( int  mineIndex, int  wireIndex, int  vertexIndex, DtVector &  value  ) const

virtual

virtual bool DtMinefieldDataPdu::getWaterBurialDepthOffset ( int  mineIndex, DtFloat32 &  value  ) const

virtual

virtual int DtMinefieldDataPdu::groundBurialDepthRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the ground burial depth records.

virtual DtPduKind DtMinefieldDataPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual int DtMinefieldDataPdu::mineEmplacementTimeRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the mine emplacement time records.

virtual int DtMinefieldDataPdu::mineEntityID_RecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the mine entity ID records.

virtual const DtEntityIdentifier& DtMinefieldDataPdu::minefieldID ( ) const

virtual

virtual DtU16 DtMinefieldDataPdu::minefieldSequenceNumber ( ) const

virtual

virtual int DtMinefieldDataPdu::mineLocationRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the mine location records.

virtual int DtMinefieldDataPdu::mineOrientationRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the mine orientation records.

virtual const DtEntityType& DtMinefieldDataPdu::mineType ( ) const

virtual

virtual DtNetMinefieldDataPdu* DtMinefieldDataPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual DtU8 DtMinefieldDataPdu::numberOfMines ( ) const

virtual

virtual DtU8 DtMinefieldDataPdu::numberOfPdus ( ) const

virtual

virtual DtU8 DtMinefieldDataPdu::numberOfSensorTypes ( ) const

virtual

virtual int DtMinefieldDataPdu::numberOfTripWiresPaddingBytes ( ) const

protectedvirtual

Returns the number of padding bytes following number of wires records.

virtual int DtMinefieldDataPdu::numberOfTripWiresPaddingOffset ( ) const

protectedvirtual

Returns a buffer offset to the padding following number of wires records.

virtual int DtMinefieldDataPdu::numberOfTripWiresRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the number of wires records.

virtual int DtMinefieldDataPdu::numberOfVerticesPaddingBytes ( ) const

protectedvirtual

Returns the number of padding bytes following number of vertices records.

virtual int DtMinefieldDataPdu::numberOfVerticesPaddingOffset ( ) const

protectedvirtual

Returns a buffer offset to the padding following number of vertices records.

virtual int DtMinefieldDataPdu::numberOfVerticesRecordOffset ( int  mineIndex, int  wireIndex  ) const

protectedvirtual

Returns a buffer offset to the number of vertices records.

DtMinefieldDataPdu& DtMinefieldDataPdu::operator=

(

const DtMinefieldDataPdu &

orig

)

Assignment operator.

virtual int DtMinefieldDataPdu::paintSchemePaddingBytes ( ) const

protectedvirtual

Returns the number of padding bytes following paint scheme records.

virtual int DtMinefieldDataPdu::paintSchemePaddingOffset ( ) const

protectedvirtual

Returns a buffer offset to the padding following paint scheme records.

virtual int DtMinefieldDataPdu::paintSchemeRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the paint scheme records.

virtual DtU8 DtMinefieldDataPdu::PDU_SequenceNumber ( ) const

virtual

virtual void DtMinefieldDataPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

virtual int DtMinefieldDataPdu::reflectanceRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the reflectance records.

static void DtMinefieldDataPdu::removeCallback ( DtExerciseConn *  conn, DtMinefieldDataPduCb  cb, void *  usr  )

static

virtual DtU8 DtMinefieldDataPdu::requestID ( ) const

virtual

virtual const DtEntityIdentifier& DtMinefieldDataPdu::requestingEntityID ( ) const

virtual

virtual int DtMinefieldDataPdu::scalarDetectionCoefficientRecordOffset ( int  sensorIndex, int  mineIndex  ) const

protectedvirtual

Returns a buffer offset to the scalar detection coefficient records.

DtMinefieldDataPdu* DtMinefieldDataPdu::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 int DtMinefieldDataPdu::sensorTypePaddingBytes ( ) const

protectedvirtual

Returns the number of padding bytes following sensor type information.

virtual int DtMinefieldDataPdu::sensorTypePaddingOffset ( ) const

protectedvirtual

Returns a buffer offset to the padding following sensor type information.

virtual int DtMinefieldDataPdu::sensorTypeRecordOffset ( int  sensorIndex ) const

protectedvirtual

Returns a buffer offset to the sensor type records.

virtual bool DtMinefieldDataPdu::setAntiHandlingDevice ( int  mineIndex, DtMinefieldAntiHandlingDevice  value  )

virtual

Set/Get anti-handling device.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual void DtMinefieldDataPdu::setDataFilter ( DtU32  value )

virtual

Set/Get the data filter as a 32-bit value (this call erases any data which was set in the variable length fields).

virtual void DtMinefieldDataPdu::setDataFilterBit ( DtMinefieldDataFilterField  field, bool  value  )

virtual

Set/Get a data filter bit (this call erases any data which was set in the variable length fields).

virtual bool DtMinefieldDataPdu::setGroundBurialDepthOffset ( int  mineIndex, DtFloat32  value  )

virtual

Set/Get a ground burial depth offset.

Returns false if the index is out of range or if an appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setMineEmplacementTime ( int  mineIndex, DtTime  value  )

virtual

Set/Get a mine emplacement time.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setMineEntityID ( int  mineIndex, DtU16  value  )

virtual

Set/Get a mine entity ID. Returns false if the index is out of range.

virtual bool DtMinefieldDataPdu::setMinefieldAlgae ( int  mineIndex, DtMinefieldAlgae  value  )

virtual

Set/Get minefield algae.

Returns false if the index is out of range or if the appropriate flag bit is not set.

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

virtual

Set/Get minefield ID.

virtual void DtMinefieldDataPdu::setMinefieldSequenceNumber ( DtU16  field )

virtual

Set/Get minefield sequence number.

virtual bool DtMinefieldDataPdu::setMineLocation ( int  mineIndex, const DtVector &  value  )

virtual

Set/Get a mine location. Returns false if the index is out of range.

virtual bool DtMinefieldDataPdu::setMineOrientation ( int  mineIndex, const DtTaitBryan &  value  )

virtual

Set/Get mine orientation.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual void DtMinefieldDataPdu::setMineType ( const DtEntityType &  value )

virtual

Set/Get the mine type record.

virtual bool DtMinefieldDataPdu::setNumberOfMines ( DtU8  value )

virtual

Set/Get the number of mines (this call erases any data which was set in the variable length fields).

virtual void DtMinefieldDataPdu::setNumberOfPdus ( DtU8  value )

virtual

Set/Get the number of PDUs.

virtual bool DtMinefieldDataPdu::setNumberOfSensorTypes ( DtU8  value )

virtual

Set/Get the number of sensor types (this call erases any data which was set in the variable length fields).

virtual bool DtMinefieldDataPdu::setNumTripWires ( int  mineIndex, DtU8  num  )

virtual

Set/Get the number of trip/detonation wires.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setNumVertices ( int  mineIndex, int  wireIndex, DtU8  num  )

virtual

Set/Get the number of vertices.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setPaintScheme ( int  mineIndex, DtMinefieldPaintScheme  value  )

virtual

Set/Get paint scheme.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual void DtMinefieldDataPdu::setPDU_SequenceNumber ( DtU8  value )

virtual

Set/Get the PDU sequence number.

virtual bool DtMinefieldDataPdu::setPrimaryFusing ( int  mineIndex, DtMinefieldFusing  value  )

virtual

Set/Get primary fusing.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setReflectance ( int  mineIndex, DtFloat32  value  )

virtual

Set/Get a reflectance value.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual void DtMinefieldDataPdu::setRequestID ( DtU8  value )

virtual

Set/Get the request ID.

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

virtual

Set/Get requesting entity ID.

virtual bool DtMinefieldDataPdu::setScalarDetectionCoefficient ( int  sensorIndex, int  mineIndex, DtU8  value  )

virtual

Set/Get scalar detection coefficient.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setSecondaryFusing ( int  mineIndex, DtMinefieldFusing  value  )

virtual

Set/Get secondary fusing.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setSensorTypeCategory ( int  sensorIndex, DtSensorTypeCategory  value  )

virtual

Set/Get a sensor type category.

Returns false if the index is out of range.

virtual bool DtMinefieldDataPdu::setSensorTypeSubcategory ( int  sensorIndex, DtU16  value  )

virtual

Set/Get a sensor type sub-category.

Returns false if the index is out of range.

virtual bool DtMinefieldDataPdu::setSnowBurialDepthOffset ( int  mineIndex, DtFloat32  value  )

virtual

Set/Get a snow burial depth offset.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setThermalContrast ( int  mineIndex, DtFloat32  value  )

virtual

Set/Get a thermal contrast value.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setVertex ( int  mineIndex, int  wireIndex, int  vertexIndex, const DtVector &  value  )

virtual

Set/Get a vertex.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual bool DtMinefieldDataPdu::setWaterBurialDepthOffset ( int  mineIndex, DtFloat32  value  )

virtual

Set/Get a water burial depth offset.

Returns false if the index is out of range or if the appropriate flag bit is not set.

virtual int DtMinefieldDataPdu::snowBurialDepthRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the snow burial depth records.

virtual int DtMinefieldDataPdu::thermalContrastRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the thermal contrast records.

virtual char* DtMinefieldDataPdu::var ( ) const

protectedvirtual

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

virtual int DtMinefieldDataPdu::variableDataLength ( ) const

protectedvirtual

Returns the length of the variable data section in the PDU.

virtual int DtMinefieldDataPdu::variableDataLengthAfterReset ( ) const

protectedvirtual

Returns the length of the variable data section in the PDU after the variable data has been reset.

For each mine, the number of trip wires has been set to zero so there is no variable length data following.

virtual int DtMinefieldDataPdu::vertexRecordOffset ( int  mineIndex, int  wireIndex, int  vertexIndex  ) const

protectedvirtual

Returns a buffer offset to the vertex records.

virtual int DtMinefieldDataPdu::waterBurialDepthRecordOffset ( int  mineIndex ) const

protectedvirtual

Returns a buffer offset to the water burial depth records.

Member Data Documentation

DtEntityIdentifier DtMinefieldDataPdu::myEntityID

protected

Temporary objects for reference returns.

DtEntityType DtMinefieldDataPdu::myEntityType

protected

const int DtMinefieldDataPdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

---

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

• mineDataPdu.h