DtMinefieldQueryPdu Class Reference

Instances of DtMinefieldQueryPdu are used to communicate minefield state information. More...

Inheritance diagram for DtMinefieldQueryPdu:

Collaboration diagram for DtMinefieldQueryPdu:

List of all members.

Public Member Functions
	DtMinefieldQueryPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtMinefieldQueryPdu (const DtNetMinefieldQueryPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtMinefieldQueryPdu (const DtMinefieldQueryPdu &orig)
virtual	~DtMinefieldQueryPdu ()
	destructor
DtMinefieldQueryPdu &	operator= (const DtMinefieldQueryPdu &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	setRequestID (DtU8 id)
	Set/Get request ID.
virtual DtU8	requestID () const
virtual bool	setNumPerimeterPoints (DtU8 num)
	Set/Get the number of perimeter points.
virtual DtU8	numPerimeterPoints () const
virtual bool	setNumSensorTypes (DtU8 num)
	Set/Get the number of sensor types.
virtual DtU8	numSensorTypes () const
virtual void	setDataFilter (DtU32 value)
	Set/Get the data filter (as a 32-bit integer).
virtual DtU32	dataFilter () const
virtual void	setDataFilterField (DtMinefieldDataFilterField field, bool value)
	Set/Get data filter attributes.
virtual bool	getDataFilterField (DtMinefieldDataFilterField field)
virtual void	setRequestedMineType (const DtEntityType &type)
	Set/Get requested mine type.
virtual const DtEntityType &	requestedMineType () const
virtual bool	setPerimeterPoint (int index, const DtMinefieldPerimeterRecord &init)
	Set/Get a perimeter point coordinate record.
virtual bool	getPerimeterPoint (int index, DtMinefieldPerimeterRecord &record) const
virtual bool	getSensorTypeCategory (int index, DtSensorTypeCategory &value)
	Get the sensor type category for a record.
virtual bool	setSensorTypeSubcategory (int index, DtOpticalSensorTypeSubcategory value)
	Set a sensor type subcategory for a record.
virtual bool	setSensorTypeSubcategory (int index, DtFLIR_SensorTypeSubcategory value)
virtual bool	setSensorTypeSubcategory (int index, DtRADAR_SensorTypeSubcategory value)
virtual bool	setSensorTypeSubcategory (int index, DtMagneticSensorTypeSubcategory value)
virtual bool	setSensorTypeSubcategory (int index, DtLaserSensorTypeSubcategory value)
virtual bool	setSensorTypeSubcategory (int index, DtSONARSensorTypeSubcategory value)
virtual bool	setSensorTypeSubcategory (int index, DtPhysicalSensorTypeSubcategory value)
virtual bool	setSensorTypeSubcategory (int index, DtMultispectralSensorTypeSubcategory value)
virtual bool	getSensorTypeSubcategory (int index, DtOpticalSensorTypeSubcategory &value)
	Get a sensor type subcategory for a record.
virtual bool	getSensorTypeSubcategory (int index, DtFLIR_SensorTypeSubcategory &value)
virtual bool	getSensorTypeSubcategory (int index, DtRADAR_SensorTypeSubcategory &value)
virtual bool	getSensorTypeSubcategory (int index, DtMagneticSensorTypeSubcategory &value)
virtual bool	getSensorTypeSubcategory (int index, DtLaserSensorTypeSubcategory &value)
virtual bool	getSensorTypeSubcategory (int index, DtSONARSensorTypeSubcategory &value)
virtual bool	getSensorTypeSubcategory (int index, DtPhysicalSensorTypeSubcategory &value)
virtual bool	getSensorTypeSubcategory (int index, DtMultispectralSensorTypeSubcategory &value)
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data to a stream.
Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create a DtMinefieldQueryPdu.
static void	addCallback (DtExerciseConn *conn, DtMinefieldQueryPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtMinefieldQueryPduCb cb, void *usr)
Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetMinefieldQueryPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtMinefieldQueryPdu *	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	perimeterPointRecordOffset (int recordIndex) const
	Returns a buffer offset to a perimeter point record.
virtual int	sensorTypeRecordOffset (int recordIndex) const
	Returns a buffer offset to a sensor type record.
virtual void	setSensorType (int index, DtU16 value)
	Set/Get the sensor type. (As a 16-bit integer.)
virtual DtU16	sensorType (int index) const
Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtEntityType	myEntityType
DtMinefieldPerimeterRecord	myPerimeterRecord
Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero parameter records.

---

Detailed Description

Instances of DtMinefieldQueryPdu are used to communicate minefield state information.

---

Constructor & Destructor Documentation

DtMinefieldQueryPdu::DtMinefieldQueryPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtMinefieldQueryPdu::DtMinefieldQueryPdu	(	const DtNetMinefieldQueryPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtMinefieldQueryPdu::DtMinefieldQueryPdu

(

const DtMinefieldQueryPdu &

orig

)

virtual DtMinefieldQueryPdu::~DtMinefieldQueryPdu

(

)

[virtual]

destructor

---

Member Function Documentation

static void DtMinefieldQueryPdu::addCallback	(	DtExerciseConn *	conn,
		DtMinefieldQueryPduCb	cb,
		void *	usr
	)		[static]

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

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

Create a DtMinefieldQueryPdu.

Caller is responsible for deletion.

virtual DtU32 DtMinefieldQueryPdu::dataFilter

(

)

const [virtual]

virtual bool DtMinefieldQueryPdu::getDataFilterField

(

DtMinefieldDataFilterField

field

)

[virtual]

virtual bool DtMinefieldQueryPdu::getPerimeterPoint	(	int	index,
		DtMinefieldPerimeterRecord &	record
	)		const [virtual]

virtual bool DtMinefieldQueryPdu::getSensorTypeCategory	(	int	index,
		DtSensorTypeCategory &	value
	)		[virtual]

Get the sensor type category for a record.

Returns false if the index is out of range. The category is set by setSensorTypeRecord.

virtual bool DtMinefieldQueryPdu::getSensorTypeSubcategory	(	int	index,
		DtOpticalSensorTypeSubcategory &	value
	)		[virtual]

Get a sensor type subcategory for a record.

false is returned if the index is out of range or if the category of the record does not match the category indicated by the type of the enumeration in the argument list.

virtual bool DtMinefieldQueryPdu::getSensorTypeSubcategory	(	int	index,
		DtFLIR_SensorTypeSubcategory &	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::getSensorTypeSubcategory	(	int	index,
		DtRADAR_SensorTypeSubcategory &	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::getSensorTypeSubcategory	(	int	index,
		DtMagneticSensorTypeSubcategory &	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::getSensorTypeSubcategory	(	int	index,
		DtLaserSensorTypeSubcategory &	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::getSensorTypeSubcategory	(	int	index,
		DtSONARSensorTypeSubcategory &	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::getSensorTypeSubcategory	(	int	index,
		DtPhysicalSensorTypeSubcategory &	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::getSensorTypeSubcategory	(	int	index,
		DtMultispectralSensorTypeSubcategory &	value
	)		[virtual]

virtual DtPduKind DtMinefieldQueryPdu::internalGetPduKind

(

)

const [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual const DtEntityIdentifier& DtMinefieldQueryPdu::minefieldID

(

)

const [virtual]

virtual DtNetMinefieldQueryPdu* DtMinefieldQueryPdu::netPduStruct

(

)

const [protected, virtual]

Casts the netPdu element to our network struct.

virtual DtU8 DtMinefieldQueryPdu::numPerimeterPoints

(

)

const [virtual]

virtual DtU8 DtMinefieldQueryPdu::numSensorTypes

(

)

const [virtual]

DtMinefieldQueryPdu& DtMinefieldQueryPdu::operator=

(

const DtMinefieldQueryPdu &

orig

)

Assignment operator.

virtual int DtMinefieldQueryPdu::perimeterPointRecordOffset

(

int

recordIndex

)

const [protected, virtual]

Returns a buffer offset to a perimeter point record.

virtual void DtMinefieldQueryPdu::printData

(

)

const [virtual]

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtMinefieldQueryPdu::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the data to a stream.

Reimplemented from DtPdu.

static void DtMinefieldQueryPdu::removeCallback	(	DtExerciseConn *	conn,
		DtMinefieldQueryPduCb	cb,
		void *	usr
	)		[static]

virtual const DtEntityType& DtMinefieldQueryPdu::requestedMineType

(

)

const [virtual]

virtual DtU8 DtMinefieldQueryPdu::requestID

(

)

const [virtual]

virtual const DtEntityIdentifier& DtMinefieldQueryPdu::requestingEntityID

(

)

const [virtual]

DtMinefieldQueryPdu* DtMinefieldQueryPdu::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 DtMinefieldQueryPdu::sensorType

(

int

index

)

const [protected, virtual]

virtual int DtMinefieldQueryPdu::sensorTypeRecordOffset

(

int

recordIndex

)

const [protected, virtual]

Returns a buffer offset to a sensor type record.

virtual void DtMinefieldQueryPdu::setDataFilter

(

DtU32

value

)

[virtual]

Set/Get the data filter (as a 32-bit integer).

virtual void DtMinefieldQueryPdu::setDataFilterField	(	DtMinefieldDataFilterField	field,
		bool	value
	)		[virtual]

Set/Get data filter attributes.

(true indicates that the data for that field is requested, false indicates that the data for that field is not requested.)

virtual void DtMinefieldQueryPdu::setMinefieldID

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get minefield ID.

virtual bool DtMinefieldQueryPdu::setNumPerimeterPoints

(

DtU8

num

)

[virtual]

Set/Get the number of perimeter points.

virtual bool DtMinefieldQueryPdu::setNumSensorTypes

(

DtU8

num

)

[virtual]

Set/Get the number of sensor types.

virtual bool DtMinefieldQueryPdu::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 DtMinefieldQueryPdu::setRequestedMineType

(

const DtEntityType &

type

)

[virtual]

Set/Get requested mine type.

virtual void DtMinefieldQueryPdu::setRequestID

(

DtU8

id

)

[virtual]

Set/Get request ID.

virtual void DtMinefieldQueryPdu::setRequestingEntityID

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get requesting entity ID.

virtual void DtMinefieldQueryPdu::setSensorType	(	int	index,
		DtU16	value
	)		[protected, virtual]

Set/Get the sensor type. (As a 16-bit integer.)

virtual bool DtMinefieldQueryPdu::setSensorTypeSubcategory	(	int	index,
		DtOpticalSensorTypeSubcategory	value
	)		[virtual]

Set a sensor type subcategory for a record.

The correct category is automatically set by this function according to type of the enumeration in the argument list. false is returned if the index is out of range.

virtual bool DtMinefieldQueryPdu::setSensorTypeSubcategory	(	int	index,
		DtFLIR_SensorTypeSubcategory	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::setSensorTypeSubcategory	(	int	index,
		DtRADAR_SensorTypeSubcategory	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::setSensorTypeSubcategory	(	int	index,
		DtMagneticSensorTypeSubcategory	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::setSensorTypeSubcategory	(	int	index,
		DtLaserSensorTypeSubcategory	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::setSensorTypeSubcategory	(	int	index,
		DtSONARSensorTypeSubcategory	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::setSensorTypeSubcategory	(	int	index,
		DtPhysicalSensorTypeSubcategory	value
	)		[virtual]

virtual bool DtMinefieldQueryPdu::setSensorTypeSubcategory	(	int	index,
		DtMultispectralSensorTypeSubcategory	value
	)		[virtual]

virtual char* DtMinefieldQueryPdu::var

(

)

const [protected, virtual]

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

---

Member Data Documentation

DtEntityIdentifier DtMinefieldQueryPdu::myEntityID [protected]

Temporary objects for reference returns.

DtEntityType DtMinefieldQueryPdu::myEntityType [protected]

DtMinefieldPerimeterRecord DtMinefieldQueryPdu::myPerimeterRecord [protected]

const int DtMinefieldQueryPdu::theStaticSize [static, protected]

Size of PDU with zero parameter records.

---

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

• mineQueryPdu.h