VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtMinefieldQueryPdu Class Reference

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

+ Inheritance diagram for DtMinefieldQueryPdu:
+ Collaboration diagram for DtMinefieldQueryPdu:

Public Member Functions

 DtMinefieldQueryPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors. More...
 
 DtMinefieldQueryPdu (const DtNetMinefieldQueryPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 
 DtMinefieldQueryPdu (const DtMinefieldQueryPdu &orig)
 
virtual ~DtMinefieldQueryPdu ()
 destructor More...
 
DtMinefieldQueryPduoperator= (const DtMinefieldQueryPdu &orig)
 Assignment operator. More...
 
virtual void setMinefieldID (const DtEntityIdentifier &id)
 Set/Get minefield ID. More...
 
virtual const DtEntityIdentifierminefieldID () const
 
virtual void setRequestingEntityID (const DtEntityIdentifier &id)
 Set/Get requesting entity ID. More...
 
virtual const DtEntityIdentifierrequestingEntityID () const
 
virtual void setRequestID (DtU8 id)
 Set/Get request ID. More...
 
virtual DtU8 requestID () const
 
virtual bool setNumPerimeterPoints (DtU8 num)
 Set/Get the number of perimeter points. More...
 
virtual DtU8 numPerimeterPoints () const
 
virtual bool setNumSensorTypes (DtU8 num)
 Set/Get the number of sensor types. More...
 
virtual DtU8 numSensorTypes () const
 
virtual void setDataFilter (DtU32 value)
 Set/Get the data filter (as a 32-bit integer). More...
 
virtual DtU32 dataFilter () const
 
virtual void setDataFilterField (DtMinefieldDataFilterField field, bool value)
 Set/Get data filter attributes. More...
 
virtual bool getDataFilterField (DtMinefieldDataFilterField field)
 
virtual void setRequestedMineType (const DtEntityType &type)
 Set/Get requested mine type. More...
 
virtual const DtEntityTyperequestedMineType () const
 
virtual bool setPerimeterPoint (int index, const DtMinefieldPerimeterRecord &init)
 Set/Get a perimeter point coordinate record. More...
 
virtual bool getPerimeterPoint (int index, DtMinefieldPerimeterRecord &record) const
 
virtual bool getSensorTypeCategory (int index, DtSensorTypeCategory &value)
 Get the sensor type category for a record. More...
 
virtual bool setSensorTypeSubcategory (int index, DtOpticalSensorTypeSubcategory value)
 Set a sensor type subcategory for a record. More...
 
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. More...
 
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. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print the data to a stream. More...
 
- Public Member Functions inherited from DtInteraction
 DtInteraction ()
 default constructor More...
 
virtual ~DtInteraction ()
 destructor More...
 
 DtInteraction (const DtInteraction &orig)
 copy constructor More...
 
DtInteractionoperator= (const DtInteraction &orig)
 assignment operator More...
 
- Public Member Functions inherited from DtPduWithAttributeRecordSets
 DtPduWithAttributeRecordSets ()
 Constructor. More...
 
 DtPduWithAttributeRecordSets (const DtPduWithAttributeRecordSets &orig)
 Constructor. More...
 
DtPduWithAttributeRecordSetsoperator= (const DtPduWithAttributeRecordSets &other)
 Assignment operator. More...
 
virtual ~DtPduWithAttributeRecordSets ()
 Destructor. More...
 
virtual void printToStream (std::ostream &stream) const
 Print the contents of the PDU. This will call DtPdu's printToStream and also call printRecordSets() More...
 
virtual void printRecordSets (bool printEntityObjectId=false) const
 Prints the Record Sets to DtInfo. More...
 
virtual void printRecordSetsToStream (std::ostream &stream, bool printEntityObjectId=false) const
 Prints the Record Sets to the specified stream. More...
 
virtual void addRecord (std::auto_ptr< DtStandardVariableRecord > record, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Adds a Record. More...
 
virtual void removeRecord (unsigned int index, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Removes a Record. More...
 
virtual void clearRecordSet (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Removes all Records and deletes the recordSet for the given Entity/Object Identifier. More...
 
virtual void clearAllRecordSets ()
 Removes all RecordSets. More...
 
virtual std::vector
< DtEntityIdentifier
recordSetIdentifiers () const
 Returns a vector of Entity/Object Identifiers. These are the Identifiers for the Record Sets. More...
 
virtual void getRecordSetIdentifiers (std::vector< DtEntityIdentifier > &entityIdVector) const
 Returns by reference the vector of Entity/Object Identifiers. More...
 
virtual const
DtStandardVariableRecordPtrVector
records (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const
 This will return the Records for a given Entity/Object Identifier. More...
 
virtual const
DtAttributeRecordSet
recordSet (const DtEntityIdentifier &id) const
 This will return the Record Set for a given Entity/Object Identifier. More...
 
virtual const
DtStandardVariableRecordPtrVector 
allRecords () const
 This will return the Records of all Record Sets. More...
 
virtual unsigned int numberOfRecords () const
 Returns the number of records for all Record Sets. More...
 
virtual unsigned int numberOfRecords (const DtEntityIdentifier &id) const
 Returns the number of records in the Record Set for the given Entity/Object Identifier. More...
 
virtual bool containsStandardRecordSets () const
 Returns if this PDU contains Standard Record Sets. (This is only applicable to DIS 7 and higher). More...
 
virtual const DtSimulationAddressattributePduSimulationAddress () const
 Returns the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists. More...
 
virtual void setAttributePduSimulationAddress (const DtSimulationAddress &addr)
 Sets the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists. More...
 
virtual void encode ()
 Encode method. More...
 
virtual void decode (DtPduFactory *pduFactory=0)
 Decode method. More...
 
virtual unsigned int attributeRecordSetsNetSize () const
 Network Size of the all Attribute Record Sets. More...
 
virtual unsigned int recordSetsNetSize () const
 Network Size of the all Record Sets. More...
 
virtual void setStandardVariableRecordFactory (DtStandardVariableRecordFactory *factory)
 Sets/gets the Standard Variable Record Factory used for decoding. More...
 
virtual
DtStandardVariableRecordFactory
standardVariableRecordFactory () const
 
virtual unsigned int numberOfRecordSets () const
 Gets the number of Attribute Record Sets. More...
 
virtual const
DtAttributeRecordSetMap
attributeRecordSetMap () const
 Get the AttributeRecordSet Map. More...
 
virtual int computeMasterAttributeRecordType () const
 Get the Master Attribute Record Type (if applicable, this will return MULTIPLES_PRESENT if not) More...
 
virtual void setAttributeStrategy (DtAttributePduStrategy strat)
 
virtual DtAttributePduStrategy attributePduStrategy () const
 
virtual bool shouldAttributePduBeCoupled () const
 
- Public Member Functions inherited from DtPdu
virtual ~DtPdu ()
 Destructor. More...
 
 DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor. More...
 
DtPduoperator= (const DtPdu &pdu)
 Assignment operator. More...
 
virtual void * packet () const
 Older function that returns a pointer to the network representation. More...
 
virtual int status () const
 Get PDU status. More...
 
virtual void setVersion (int vers)
 Set/Get protocol version from PDU header. More...
 
virtual int protocolVersion () const
 
virtual void setExerciseId (int id)
 Set/Get exerciseID in PDU header. More...
 
virtual int exerciseId () const
 
virtual DtPduKind kind () const
 Returns PDU kind from PDU header. More...
 
virtual DtProtocolFamily protocolFamily () const
 Returns protocol family from PDU header. More...
 
virtual void setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
 Set the PDU header's time stamp to reflect time and type. More...
 
virtual DtTime timeStamp () const
 Return the time (in seconds past an hour) encoded in the PDU header's time stamp. More...
 
virtual DtTimeStampType timeStampType () const
 Return the type of the time stamp, as indicated in PDU header. More...
 
virtual void setReceivedTime (DtTime t)
 absRealTime when PDU was received into buffer. More...
 
virtual DtTime receivedTime () const
 
virtual void setPduLength (unsigned int length)
 Set the PDU header's length. More...
 
virtual unsigned int pduLength () const
 Return the length of the PDU, as indicated in the PDU header. More...
 
virtual void setPduStatus (int)
 Set the PDU Status in the PDU header. More...
 
virtual int pduStatus () const
 Returns the PDU Status from the PDU header. More...
 
virtual void setTransferredEntityIndicator (bool difference)
 Set the Transferred Entity Indicator in the PDU header False is No Difference True is Difference. More...
 
virtual bool transferredEntityIndicator () const
 Returns the Transferred Entity Indicator from the PDU header False is No Difference True is Difference. More...
 
virtual void setLvcIndicator (DtPduStatusLVCIndicator lvcIndicator)
 Set the LVC Indicator in the PDU header. More...
 
virtual DtPduStatusLVCIndicator lvcIndicator () const
 Returns the LVC Indicator from the PDU header. More...
 
virtual void setCoupledExtensionIndicator (bool coupled)
 Set the Coupled Extension Indicator in the PDU Header False is Not Coupled True is Coupled. More...
 
virtual bool coupledExtensionIndicator () const
 Returns the Coupled Extension Indicator from the PDU Header False is Not Coupled True is Coupled. More...
 
virtual void setFireTypeIndicator (DtPduStatusFireTypeIndicator fireTypeIndicator)
 Set the Fire Type Indicator in the PDU header. More...
 
virtual
DtPduStatusFireTypeIndicator 
fireTypeIndicator () const
 Returns the Fire Type Indicator from the PDU header. More...
 
virtual void setDetonationTypeIndicator (DtPduStatusDetonationTypeIndicator detonationTypeIndicator)
 Set the Detonation Type Indicator in the PDU header. More...
 
virtual
DtPduStatusDetonationTypeIndicator 
detonationTypeIndicator () const
 Returns the Detonation Type Indicator from the PDU header. More...
 
virtual void setRadioAttachedIndicator (DtPduStatusRadioAttachedIndicator radioAttachedIndicator)
 Set the Radio Attached Indicator in the PDU header. More...
 
virtual
DtPduStatusRadioAttachedIndicator 
radioAttachedIndicator () const
 Returns the Radio Attached Indicator from the PDU header. More...
 
virtual void setIntercomAttachedIndicator (DtPduStatusIntercomAttachedIndicator intercomAttachedIndicator)
 Set the Intercom Attached Indicator in the PDU header. More...
 
virtual
DtPduStatusIntercomAttachedIndicator 
intercomAttachedIndicator () const
 Returns the Intercom Attached Indicator from the PDU header. More...
 
virtual void setIffSimulationMode (bool interactive)
 Set the IFF Simulation Mode in the PDU header. More...
 
virtual bool iffSimulationMode () const
 Returns the IFF Simulation Mode from the PDU header. More...
 
virtual void setActiveInterrogationIndicator (bool active)
 Set the Active Interrogation Indicator in the PDU header. More...
 
virtual bool activeInterrogationIndicator () const
 Returns the Active Interrogation Indicator from the PDU header. More...
 
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. More...
 
virtual DtNetPduHeadernetHeader () const
 Returns a pointer to the PDU's header. More...
 
virtual void print () const
 Print the contents of the PDU by calling printToStream(DtInfo). More...
 
virtual void printHeader () const
 Print the PDU's header. This calls printHeaderToStream(DtInfo). More...
 
virtual void printHeaderToStream (std::ostream &stream) const
 Print the PDU's header to a stream. More...
 
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. More...
 
virtual bool isTransientPdu () const
 This method returns true if transient, false if state. More...
 
- Public Member Functions inherited from DtBaseMsg
virtual ~DtBaseMsg ()
 Destructor. More...
 
 DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor. More...
 
DtBaseMsgoperator= (const DtBaseMsg &msg)
 Assignment. More...
 
virtual const char * netRep () const
 Get network representation. More...
 
virtual int length () const
 Get size of message. More...
 
 DtBaseMsg ()
 Constructor Object is not fully constructed until initMsg is called. More...
 
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. More...
 
virtual void changeBufferSize (int size)
 Changes the size of the message buffer, but not the message itself. More...
 
virtual void insertBytes (int offset, int numBytes)
 Inserts numBytes zeroed-out bytes at the indicated offset into the net rep. More...
 
virtual void insertBytes (void *address, int numBytes)
 Inserts numBytes zeroed-out bytes at the indicated address. More...
 
virtual void deleteBytes (int offset, int numBytes)
 Deletes numBytes bytes at the indicated offset in the net rep. More...
 
virtual void deleteBytes (void *address, int numBytes)
 Deletes numBytes bytes starting at the indicated address. More...
 
virtual void clearAll ()
 Zeros out all bytes in the network representation. More...
 
virtual void * newInternalBuffer (int size)
 Sets myInternalBuff to point to a malloc'ed buffer of size bytes. More...
 

Static Public Member Functions

static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 Create a DtMinefieldQueryPdu. More...
 
static void addCallback (DtExerciseConn *conn, DtMinefieldQueryPduCb cb, void *usr)
 Add (register)/Remove (deregister) function to be called when pdu is received. More...
 
static void removeCallback (DtExerciseConn *conn, DtMinefieldQueryPduCb cb, void *usr)
 

Protected Member Functions

virtual DtPduKind internalGetPduKind () const
 Returns the internal PDU kind. More...
 
virtual DtNetMinefieldQueryPdunetPduStruct () const
 Casts the netPdu element to our network struct. More...
 
DtMinefieldQueryPduself () const
 Casts the 'this' pointer for changing elements in a const function. More...
 
virtual char * var () const
 Returns a pointer to the first byte of variable length data. More...
 
virtual int perimeterPointRecordOffset (int recordIndex) const
 Returns a buffer offset to a perimeter point record. More...
 
virtual int sensorTypeRecordOffset (int recordIndex) const
 Returns a buffer offset to a sensor type record. More...
 
virtual void setSensorType (int index, DtU16 value)
 Set/Get the sensor type. (As a 16-bit integer.) More...
 
virtual DtU16 sensorType (int index) const
 
- Protected Member Functions inherited from DtPduWithAttributeRecordSets
virtual void deepAttributeRecordSetMapCopy (const DtAttributeRecordSetMap &orig)
 Performs a deep copy. More...
 
virtual void printRecordSetToStream (const DtEntityIdentifier &id, std::ostream &stream) const
 
- Protected Member Functions inherited from DtPdu
 DtPdu ()
 Constructor. More...
 
virtual void setStatus (int okStatus)
 Sets the PDU's status to okStatus. More...
 
virtual void initPdu (int size, DtBufferPtr buffer)
 Must be called after default ctor before PDU is completely constructed. More...
 
virtual void initPdu (const void *initial, DtBufferPtr buffer, DtPduFactory *pduFactory)
 Called by from-net-rep ctor. Initializes DtBaseMsg. More...
 
virtual DtProtocolFamily kindToFamily (DtPduKind kind) const
 Maps PDU kind to ProtocolFamily. More...
 
virtual void sizeChanged (int size)
 Called by changeSize. Sets the size in the header to size. More...
 
virtual void clearData ()
 zeros out all bytes after the PDU header. More...
 
virtual void initHeader (DtPduKind kind, int size)
 Initializes PDU header. Called by initPdu. More...
 
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. More...
 
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
 

Protected Attributes

DtEntityIdentifier myEntityID
 Temporary objects for reference returns. More...
 
DtEntityType myEntityType
 
DtMinefieldPerimeterRecord myPerimeterRecord
 
- Protected Attributes inherited from DtPduWithAttributeRecordSets
DtAttributeRecordSetMap myAttributeRecordSetMap
 The Map which holds the Record Sets (Set of Record Sets) where the Entity Identifier is the key. More...
 
bool isRecordSetOwned
 
bool isPduExtending
 
DtStandardVariableRecordFactorymySVRFactory
 
DtPduDecodermyAttributeDecoder
 
DtPduEncodermyAttributeEncoder
 
DtSimulationAddress myAttributePduOriginatingSimulationAddress
 
DtAttributePduStrategy myAttributePduStrategy
 
- Protected Attributes inherited from DtPdu
DtPduEncodermyEncoder
 
DtPduDecodermyDecoder
 
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. More...
 
- Static Protected Attributes inherited from DtPduWithAttributeRecordSets
static const DtAttributeRecordSet theEmptyAttributeRecordSet
 

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,
DtPduFactory pduFactory = 0 
)
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,
DtPduFactory pduFactory = 0 
)
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
protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual const DtEntityIdentifier& DtMinefieldQueryPdu::minefieldID ( ) const
virtual
virtual DtNetMinefieldQueryPdu* DtMinefieldQueryPdu::netPduStruct ( ) const
protectedvirtual

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
protectedvirtual

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
protectedvirtual
virtual int DtMinefieldQueryPdu::sensorTypeRecordOffset ( int  recordIndex) const
protectedvirtual

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

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
protectedvirtual

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
staticprotected

Size of PDU with zero parameter records.


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

Document ID: Generated on Tue Feb 2 21:02:17 EST 2021 from SVN revision 223668
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)