 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
DtSpotReport; subclass of DtSimReport. More...
Public Member Functions | |
| DtSpotReport (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=0) | |
| DtSpotReport (const DtString &rwName, const DtSpotReport &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtSpotReport () |
| const DtSpotReport & | operator= (const DtSpotReport &orig) |
| virtual int | type () const |
| What kind of report am I? Returns a character string representing the kind of report. | |
| virtual DtSimReport * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| make a copy of this report | |
| virtual int | netRepSize () const |
| Adds current size of this message to size reported by base class. | |
| virtual bool | setFromNet (const char *networkBuffer, unsigned contentSize) |
| Extracts elements of this report from the network buffer. | |
| virtual bool | setToNet () |
| Encodes contents of this report into the network buffer. | |
| virtual DtString | stringRep () const |
| virtual void | setContactLocation (const DtVector &vector) |
| The perceived location of the contact being reported. | |
| virtual DtVector | contactLocation () const |
| The perceived location of the contact being reported. | |
| virtual void | setContactOrientation (const DtTaitBryan &orientation) |
| The perceived orientation of the contact being reported. | |
| virtual DtTaitBryan | contactOrientation () const |
| The perceived orientation of the contact being reported. | |
| virtual void | setContactVelocity (const DtVector &velocity) |
| The perceived velocity of the contact being reported. | |
| virtual DtVector | contactVelocity () const |
| The perceived velocity of the contact being reported. | |
| 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 | setContactFormation (const DtAggregateFormation formation) |
| The perceived formation of the contact being reported. | |
| virtual DtAggregateFormation | contactFormation () const |
| The perceived formation of the contact being reported. | |
| virtual void | setContactForce (const DtForceType &force) |
| The perceived force of the contact being reported. | |
| virtual DtForceType | contactForce () const |
| The perceived force of the contact being reported. | |
| virtual void | setContactActivity (DtU32 activityEnum) |
| The perceived activity of the contact being reported. | |
| virtual DtU32 | contactActivity () const |
| The perceived activity of the contact being reported. | |
| virtual void | setContactName (const DtString &name) |
| The object name of the contact being reported, if the contact represents an actual object in the simulation. | |
| virtual DtString | contactName () const |
| The object name of the contact being reported, if the contact represents an actual object in the simulation. | |
| virtual void | setSpotterName (const DtString &name) |
| The object name of the entity which initially reported the contact. | |
| virtual DtString | spotterName () const |
| The object name of the entity which initially reported the contact. | |
| virtual void | setTimeOfReport (DtTime t) |
| The simulation time the report was initially generated. | |
| virtual DtTime | timeOfReport () const |
| The simulation time the report was initially generated. | |
| virtual void | setTimeOfContact (DtTime t) |
| The simulation time of the data about the contact contained in this report. | |
| virtual DtTime | timeOfContact () const |
| The simulation time of the data about the contact contained in this report. | |
| virtual void | setCombatIdentificationLevel (int t) |
| The identification level of the contact. | |
| virtual int | combatIdentificationLevel () const |
| The identification level of the contact. | |
| virtual void | setDetectionError (double detectionErrorIn) |
| The identification detection error. | |
| virtual double | detectionError () const |
| The identification detection error. | |
| virtual void | setContactInfo (const DtRwSensorContactInfo &info) |
| Accessor for the contact info. | |
| virtual const DtRwSensorContactInfo & | contactInfo () const |
| Accessor for the contact info. | |
| virtual DtRwSensorContactInfo & | contactInfo () |
| Accessor for the contact info. | |
Static Public Member Functions | |
| static DtSimReport * | creator () |
| Returns a new instance of DtSpotReport. | |
Protected Attributes | |
| DtRwSensorContactInfo | myContactInfo |
| DtRwString | mySpotterName |
| DtRwReal | myTimeOfReport |
| Time report was generated. | |
Private Member Functions | |
| DtSpotReport () | |
| Default constructor is private since it is not implemented. | |
DtSpotReport; subclass of DtSimReport.
A report containing information about a single sighting made of an entity by another entity. This report contains perceived data about the sighted object (referred to as the Contact) that does not necessarily reflect the ground truth of the contact's state. This report is a RW object that supports file serialization, as well as supporting network serialization. All location data is in the geocentric coordinate system.
| DtSpotReport::DtSpotReport | ( | const DtString & | rwName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtSpotReport::DtSpotReport | ( | const DtString & | rwName, |
| const DtSpotReport & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| virtual DtSpotReport::~DtSpotReport | ( | ) | [virtual] |
| DtSpotReport::DtSpotReport | ( | ) | [private] |
Default constructor is private since it is not implemented.
| const DtSpotReport& DtSpotReport::operator= | ( | const DtSpotReport & | orig | ) |
| virtual int DtSpotReport::type | ( | ) | const [virtual] |
What kind of report am I? Returns a character string representing the kind of report.
Derived classes must implement this function, returning a string that uniquely represents the kind of report it is. The definitions for report types used in VR-Forces are in radioMsgTypes.h.
Implements DtSimReport.
| virtual DtSimReport* DtSpotReport::clone | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
make a copy of this report
Implements DtSimReport.
| virtual void DtSpotReport::setContactLocation | ( | const DtVector & | vector | ) | [virtual] |
The perceived location of the contact being reported.
Specified in geocentric coordinates.
| virtual DtVector DtSpotReport::contactLocation | ( | ) | const [virtual] |
The perceived location of the contact being reported.
Specified in geocentric coordinates.
| virtual void DtSpotReport::setContactOrientation | ( | const DtTaitBryan & | orientation | ) | [virtual] |
The perceived orientation of the contact being reported.
Specified in the geocentric reference frame.
| virtual DtTaitBryan DtSpotReport::contactOrientation | ( | ) | const [virtual] |
The perceived orientation of the contact being reported.
Specified in the geocentric reference frame.
| virtual void DtSpotReport::setContactVelocity | ( | const DtVector & | velocity | ) | [virtual] |
The perceived velocity of the contact being reported.
Specified in the geocentric reference frame.
| virtual DtVector DtSpotReport::contactVelocity | ( | ) | const [virtual] |
The perceived velocity of the contact being reported.
Specified in the geocentric reference frame.
| virtual void DtSpotReport::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. In this way, a report could specify "Some type of vehicle" using type (1 (1 1 -1 -1 -1 -1 -1))
| virtual DtObjectType DtSpotReport::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. In this way, a report could specify "Some type of vehicle" using type (1 (1 1 -1 -1 -1 -1 -1))
| virtual void DtSpotReport::setContactFormation | ( | const DtAggregateFormation | formation | ) | [virtual] |
The perceived formation of the contact being reported.
The report uses OtherFormation to indicate unknown formation. (the default)
| virtual DtAggregateFormation DtSpotReport::contactFormation | ( | ) | const [virtual] |
The perceived formation of the contact being reported.
The report uses OtherFormation to indicate unknown formation. (the default)
| virtual void DtSpotReport::setContactForce | ( | const DtForceType & | force | ) | [virtual] |
The perceived force of the contact being reported.
Defaults to DtForceOther
| virtual DtForceType DtSpotReport::contactForce | ( | ) | const [virtual] |
The perceived force of the contact being reported.
Defaults to DtForceOther
| virtual void DtSpotReport::setContactActivity | ( | DtU32 | activityEnum | ) | [virtual] |
The perceived activity of the contact being reported.
This value is an enumeration of activities. Not currently used by VR-Forces, but still transmitted with the message. Defaults to DtActivityUnknown.
| virtual DtU32 DtSpotReport::contactActivity | ( | ) | const [virtual] |
The perceived activity of the contact being reported.
This value is an enumeration of activities. Not currently used by VR-Forces, but still transmitted with the message. Defaults to DtActivityUnknown.
| virtual void DtSpotReport::setContactName | ( | const DtString & | name | ) | [virtual] |
The object name of the contact being reported, if the contact represents an actual object in the simulation.
Included to facilitate sensor fusion type operations.
| virtual DtString DtSpotReport::contactName | ( | ) | const [virtual] |
The object name of the contact being reported, if the contact represents an actual object in the simulation.
Included to facilitate sensor fusion type operations.
| virtual void DtSpotReport::setSpotterName | ( | const DtString & | name | ) | [virtual] |
The object name of the entity which initially reported the contact.
If the report is forwarded up the chain of command, this name should remain the same.
| virtual DtString DtSpotReport::spotterName | ( | ) | const [virtual] |
The object name of the entity which initially reported the contact.
If the report is forwarded up the chain of command, this name should remain the same.
| virtual void DtSpotReport::setTimeOfReport | ( | DtTime | t | ) | [virtual] |
The simulation time the report was initially generated.
If a report is not immediately sent upon contact, this time will be later than timeOfContact.
| virtual DtTime DtSpotReport::timeOfReport | ( | ) | const [virtual] |
The simulation time the report was initially generated.
If a report is not immediately sent upon contact, this time will be later than timeOfContact.
| virtual void DtSpotReport::setTimeOfContact | ( | DtTime | t | ) | [virtual] |
The simulation time of the data about the contact contained in this report.
| virtual DtTime DtSpotReport::timeOfContact | ( | ) | const [virtual] |
The simulation time of the data about the contact contained in this report.
| virtual void DtSpotReport::setCombatIdentificationLevel | ( | int | t | ) | [virtual] |
The identification level of the contact.
| virtual int DtSpotReport::combatIdentificationLevel | ( | ) | const [virtual] |
The identification level of the contact.
| virtual void DtSpotReport::setDetectionError | ( | double | detectionErrorIn | ) | [virtual] |
The identification detection error.
| virtual double DtSpotReport::detectionError | ( | ) | const [virtual] |
The identification detection error.
| virtual void DtSpotReport::setContactInfo | ( | const DtRwSensorContactInfo & | info | ) | [virtual] |
Accessor for the contact info.
| virtual const DtRwSensorContactInfo& DtSpotReport::contactInfo | ( | ) | const [virtual] |
Accessor for the contact info.
| virtual DtRwSensorContactInfo& DtSpotReport::contactInfo | ( | ) | [virtual] |
Accessor for the contact info.
| virtual int DtSpotReport::netRepSize | ( | ) | const [virtual] |
Adds current size of this message to size reported by base class.
Implements DtSimReport.
| virtual bool DtSpotReport::setFromNet | ( | const char * | networkBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Extracts elements of this report from the network buffer.
Implements DtSimReport.
| virtual bool DtSpotReport::setToNet | ( | ) | [virtual] |
Encodes contents of this report into the network buffer.
Implements DtSimReport.
| static DtSimReport* DtSpotReport::creator | ( | ) | [static] |
Returns a new instance of DtSpotReport.
| virtual DtString DtSpotReport::stringRep | ( | ) | const [virtual] |
Reimplemented from DtSimReport.
DtRwSensorContactInfo DtSpotReport::myContactInfo [protected] |
DtRwString DtSpotReport::mySpotterName [protected] |
DtRwReal DtSpotReport::myTimeOfReport [protected] |
Time report was generated.