 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
This class represents the data gathered by a sensor about a particular single sensor contact. More...
Public Member Functions | |
| DtRwSensorContactInfo () | |
| DtRwSensorContactInfo (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwSensorContactInfo (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| DtRwSensorContactInfo (const DtRwSensorContactInfo &orig, DtReaderWriterRegistry *const parentRegistry=NULL) | |
| virtual | ~DtRwSensorContactInfo () |
| DtRwSensorContactInfo & | operator= (const DtRwSensorContactInfo &orig) |
| virtual const DtNLengthIntegerVector & | contactSources () const |
| The list of sources for the contact, ie infrared sensor, visual sensor, spot report... | |
| virtual void | setContactSources (const DtNLengthIntegerVector &sources) |
| virtual bool | addContactSource (int source) |
| Add a contact source. | |
| virtual bool | addContactSources (const DtNLengthIntegerVector &sources) |
| Add multiple contact sources. | |
| virtual DtRwSensorContactInfo * | clone () const |
| Returns a newly created clone of this class. | |
| virtual const DtEntityIdentifier & | id () const |
| Entity identifier for the contact. | |
| virtual void | setId (const DtEntityIdentifier &id) |
| Entity identifier for the contact. | |
| virtual double | originalDetectionTime () const |
| First time the contact was spotted by the sensor. | |
| virtual void | setOriginalDetectionTime (DtReal origTime) |
| First time the contact was spotted by the sensor. | |
| virtual void | setLastTimeOfDetection (double time) |
| The most recent time this contact was spotted by the sensor. | |
| virtual double | lastDetectionTime () const |
| The most recent time this contact was spotted by the sensor. | |
| virtual DtString | contactName () const |
| The object name of the sensor contact. | |
| virtual void | setContactName (const DtString &name) |
| The object name of the sensor contact. | |
| virtual int | combatIdentificationLevel () const |
| The combat Identification level associated with this sensor contact. | |
| virtual void | setCombatIdentificationLevel (int level) |
| The combat Identification level associated with this sensor contact. | |
| virtual double | detectionError () const |
| The quality of the physical characteristics associated with this sensor contact. | |
| virtual void | setDetectionError (double level) |
| The quality of the physical characteristics associated with this sensor contact. | |
| virtual void | setContactPosition (const DtVector &vector) |
| The perceived location of the contact. | |
| virtual DtVector | contactPosition () const |
| The perceived location of the contact. | |
| virtual void | setContactOrientation (const DtTaitBryan &orientation) |
| The perceived orientation of the contact. | |
| virtual DtTaitBryan | contactOrientation () const |
| The perceived orientation of the contact. | |
| virtual void | setContactVelocity (const DtVector &velocity) |
| The perceived velocity of the contact. | |
| virtual DtVector | contactVelocity () const |
| The perceived velocity of the contact. | |
| virtual void | setContactType (const DtObjectType &type) |
| The perceived type of the contact being reported. | |
| virtual DtObjectType | contactType () const |
| The perceived type of the contact being reported. | |
| virtual void | setContactForce (const DtForceType &force) |
| The perceived force of the contact being detected. | |
| virtual DtForceType | contactForce () const |
| The perceived force of the contact being detected. | |
| virtual void | setContactFormation (const DtAggregateFormation formation) |
| The perceived formation of the contact. | |
| virtual DtAggregateFormation | contactFormation () const |
| The perceived formation of the contact. | |
| virtual DtString | contactFormationString () const |
| The perceived formation of the contact. | |
| virtual void | setContactActivity (DtU32 activityEnum) |
| The perceived activity of the contact. | |
| virtual DtU32 | contactActivity () const |
| The perceived activity of the contact. | |
| virtual void | setContactAppearance (const DtAppearance &app) |
| The appearance of the contact--alive or dead, lights on.... | |
| virtual const DtAppearance & | contactAppearance () const |
| The appearance of the contact--alive or dead, lights on.... | |
| virtual DtAppearance & | contactAppearance () |
| The appearance of the contact--alive or dead, lights on.... | |
| virtual void | removeContactSource (int source) |
| Remove a contact source. | |
| virtual int | findContactSource (int source) |
| Returns index of the source type if found If not found returns -1. | |
Protected Attributes | |
| DtRwString | myContactName |
| DtEntityIdentifier | myId |
| DtRwReal | myOriginalTimeOfDetection |
| DtRwReal | myLastTimeOfDetection |
| DtRwInt | myCombatIdentificationLevel |
| DtRwReal | myDetectionError |
| Describes how well known the position and velocity are. | |
| DtRwVector | myContactPosition |
| In world reference frame. (Geocentric) | |
| DtRwTaitBryan | myContactOrientation |
| In world reference frame. (Geocentric) | |
| DtRwVector | myContactVelocity |
| In world reference frame. (Geocentric) | |
| DtRwObjectType | myContactType |
| DtRwForceType | myContactForce |
| DtNLengthIntegerVector | myContactSourceTypes |
| DtRwFormationType | myContactFormation |
| Not currently used. | |
| DtRwInt | myContactActivity |
| DtRwAppearance | myContactAppearance |
This class represents the data gathered by a sensor about a particular single sensor contact.
The DtRwSensorContactInfo class is a readable/writable class that can store itself and read itself from a file. Note that the entity ID is not written or read, since these change between scenario runs. The using code must manage the setting of entity IDs when loaded from a file.
| DtRwSensorContactInfo::DtRwSensorContactInfo | ( | const DtString & | name, |
| DtReaderWriterRegistry *const | parentRegistry = NULL |
||
| ) |
| DtRwSensorContactInfo::DtRwSensorContactInfo | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry *const | parentRegistry = NULL |
||
| ) |
| DtRwSensorContactInfo::DtRwSensorContactInfo | ( | const DtRwSensorContactInfo & | orig, |
| DtReaderWriterRegistry *const | parentRegistry = NULL |
||
| ) |
| virtual DtRwSensorContactInfo::~DtRwSensorContactInfo | ( | ) | [virtual] |
| DtRwSensorContactInfo& DtRwSensorContactInfo::operator= | ( | const DtRwSensorContactInfo & | orig | ) |
| virtual const DtEntityIdentifier& DtRwSensorContactInfo::id | ( | ) | const [inline, virtual] |
Entity identifier for the contact.
It is preferred to use contactName() instead.
| virtual void DtRwSensorContactInfo::setId | ( | const DtEntityIdentifier & | id | ) | [inline, virtual] |
Entity identifier for the contact.
It is preferred to use contactName() instead.
| virtual double DtRwSensorContactInfo::originalDetectionTime | ( | ) | const [inline, virtual] |
First time the contact was spotted by the sensor.
| virtual void DtRwSensorContactInfo::setOriginalDetectionTime | ( | DtReal | origTime | ) | [inline, virtual] |
First time the contact was spotted by the sensor.
| virtual void DtRwSensorContactInfo::setLastTimeOfDetection | ( | double | time | ) | [inline, virtual] |
The most recent time this contact was spotted by the sensor.
| virtual double DtRwSensorContactInfo::lastDetectionTime | ( | ) | const [inline, virtual] |
The most recent time this contact was spotted by the sensor.
| virtual DtString DtRwSensorContactInfo::contactName | ( | ) | const [inline, virtual] |
The object name of the sensor contact.
| virtual void DtRwSensorContactInfo::setContactName | ( | const DtString & | name | ) | [inline, virtual] |
The object name of the sensor contact.
References DtReaderWriter::name().
| virtual int DtRwSensorContactInfo::combatIdentificationLevel | ( | ) | const [inline, virtual] |
The combat Identification level associated with this sensor contact.
| virtual void DtRwSensorContactInfo::setCombatIdentificationLevel | ( | int | level | ) | [inline, virtual] |
The combat Identification level associated with this sensor contact.
| virtual double DtRwSensorContactInfo::detectionError | ( | ) | const [inline, virtual] |
The quality of the physical characteristics associated with this sensor contact.
I.e percentage of error associated with this information.
| virtual void DtRwSensorContactInfo::setDetectionError | ( | double | level | ) | [inline, virtual] |
The quality of the physical characteristics associated with this sensor contact.
I.e percentage of error associated with this information.
| virtual void DtRwSensorContactInfo::setContactPosition | ( | const DtVector & | vector | ) | [virtual] |
The perceived location of the contact.
Specified in geocentric coordinates.
| virtual DtVector DtRwSensorContactInfo::contactPosition | ( | ) | const [virtual] |
The perceived location of the contact.
Specified in geocentric coordinates.
| virtual void DtRwSensorContactInfo::setContactOrientation | ( | const DtTaitBryan & | orientation | ) | [virtual] |
The perceived orientation of the contact.
Specified in the geocentric reference frame.
| virtual DtTaitBryan DtRwSensorContactInfo::contactOrientation | ( | ) | const [virtual] |
The perceived orientation of the contact.
Specified in the geocentric reference frame.
| virtual void DtRwSensorContactInfo::setContactVelocity | ( | const DtVector & | velocity | ) | [virtual] |
The perceived velocity of the contact.
Specified in the geocentric reference frame.
| virtual DtVector DtRwSensorContactInfo::contactVelocity | ( | ) | const [virtual] |
The perceived velocity of the contact.
Specified in the geocentric reference frame.
| virtual void DtRwSensorContactInfo::setContactType | ( | const DtObjectType & | type | ) | [virtual] |
The perceived type of the contact being reported.
Types may be only partially filled in, using -1 for fields that are unknown. So if we have a very low level of identification the type may only reflect a ground vehicle (1 (1 1 -1 -1 -1 -1 -1))
| virtual DtObjectType DtRwSensorContactInfo::contactType | ( | ) | const [virtual] |
The perceived type of the contact being reported.
Types may be only partially filled in, using -1 for fields that are unknown. So if we have a very low level of identification the type may only reflect a ground vehicle (1 (1 1 -1 -1 -1 -1 -1))
| virtual void DtRwSensorContactInfo::setContactForce | ( | const DtForceType & | force | ) | [virtual] |
The perceived force of the contact being detected.
Defaults to DtForceOther
| virtual DtForceType DtRwSensorContactInfo::contactForce | ( | ) | const [virtual] |
The perceived force of the contact being detected.
Defaults to DtForceOther
| virtual void DtRwSensorContactInfo::setContactFormation | ( | const DtAggregateFormation | formation | ) | [virtual] |
The perceived formation of the contact.
Uses OtherFormation to indicate unknown formation. (the default)
| virtual DtAggregateFormation DtRwSensorContactInfo::contactFormation | ( | ) | const [virtual] |
The perceived formation of the contact.
Uses OtherFormation to indicate unknown formation. (the default)
| virtual DtString DtRwSensorContactInfo::contactFormationString | ( | ) | const [virtual] |
The perceived formation of the contact.
Uses OtherFormation to indicate unknown formation. (the default)
| virtual void DtRwSensorContactInfo::setContactActivity | ( | DtU32 | activityEnum | ) | [virtual] |
The perceived activity of the contact.
This value is an enumeration of activities. Not currently used by VR-Forces, but still transmitted with the message. Defaults to DtActivityUnknown.
| virtual DtU32 DtRwSensorContactInfo::contactActivity | ( | ) | const [virtual] |
The perceived activity of the contact.
This value is an enumeration of activities. Not currently used by VR-Forces, but still transmitted with the message. Defaults to DtActivityUnknown.
| virtual void DtRwSensorContactInfo::setContactAppearance | ( | const DtAppearance & | app | ) | [virtual] |
The appearance of the contact--alive or dead, lights on....
| virtual const DtAppearance& DtRwSensorContactInfo::contactAppearance | ( | ) | const [virtual] |
The appearance of the contact--alive or dead, lights on....
| virtual DtAppearance& DtRwSensorContactInfo::contactAppearance | ( | ) | [virtual] |
The appearance of the contact--alive or dead, lights on....
| virtual const DtNLengthIntegerVector& DtRwSensorContactInfo::contactSources | ( | ) | const [virtual] |
The list of sources for the contact, ie infrared sensor, visual sensor, spot report...
| virtual void DtRwSensorContactInfo::setContactSources | ( | const DtNLengthIntegerVector & | sources | ) | [virtual] |
| virtual bool DtRwSensorContactInfo::addContactSource | ( | int | source | ) | [virtual] |
Add a contact source.
| virtual bool DtRwSensorContactInfo::addContactSources | ( | const DtNLengthIntegerVector & | sources | ) | [virtual] |
Add multiple contact sources.
| virtual void DtRwSensorContactInfo::removeContactSource | ( | int | source | ) | [virtual] |
Remove a contact source.
| virtual int DtRwSensorContactInfo::findContactSource | ( | int | source | ) | [virtual] |
Returns index of the source type if found If not found returns -1.
| virtual DtRwSensorContactInfo* DtRwSensorContactInfo::clone | ( | ) | const [virtual] |
Returns a newly created clone of this class.
DtRwString DtRwSensorContactInfo::myContactName [protected] |
DtEntityIdentifier DtRwSensorContactInfo::myId [protected] |
DtRwReal DtRwSensorContactInfo::myLastTimeOfDetection [protected] |
DtRwReal DtRwSensorContactInfo::myDetectionError [protected] |
Describes how well known the position and velocity are.
Determined by the sensor and it's associated errors in detecting.
DtRwVector DtRwSensorContactInfo::myContactPosition [protected] |
In world reference frame. (Geocentric)
In world reference frame. (Geocentric)
DtRwVector DtRwSensorContactInfo::myContactVelocity [protected] |
In world reference frame. (Geocentric)
DtRwObjectType DtRwSensorContactInfo::myContactType [protected] |
DtRwForceType DtRwSensorContactInfo::myContactForce [protected] |
Not currently used.
DtRwInt DtRwSensorContactInfo::myContactActivity [protected] |