![]() |
VR-Forces Developer's Guide
|
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.

Public Types | |
| enum | Reason { NewContact = 0, PeriodicRefresh = 1, StateUpdate = 2, Resend = 3 } |
Public Types inherited from DtReaderWriter | |
| typedef std::vector < DtSymbolString > | aliasContainer |
| typedef std::vector < DtSymbolString >::iterator | aliasIter |
| typedef std::vector < DtSymbolString > ::const_iterator | aliasConstIter |
| typedef std::vector< DtFilename > | SearchPaths |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
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 const DtSimReportMessageType & | type () const |
| virtual DtSimReport * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| virtual void | setResendId (unsigned int) |
| virtual unsigned int | resendId () const |
| virtual void | setContactMarkingText (const DtString &) |
| virtual const DtString & | contactMarkingText () const |
| virtual int | netRepSize () const |
| virtual bool | setFromNet (const char *networkBuffer, unsigned contentSize) |
| virtual bool | setToNet () |
| virtual DtString | stringRep () const |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| virtual bool | mergeSpotReport (const DtSpotReport &rhs) |
| virtual void | setContactLocation (const DtVector &vector) |
| virtual DtVector | contactLocation () const |
| virtual void | setContactOrientation (const DtTaitBryan &orientation) |
| virtual DtTaitBryan | contactOrientation () const |
| virtual void | setContactVelocity (const DtVector &velocity) |
| virtual DtVector | contactVelocity () const |
| virtual void | setReason (Reason) |
| virtual Reason | reason () const |
| virtual void | setContactType (const DtObjectType &type) |
| virtual DtObjectType | contactType () const |
| virtual void | setContactFormation (const DtAggregateFormation formation) |
| virtual DtAggregateFormation | contactFormation () const |
| virtual void | setContactForce (const DtForceType &force) |
| virtual DtForceType | contactForce () const |
| virtual void | setContactActivity (const DtString &activityEnum) |
| virtual const DtString & | contactActivity () const |
| virtual void | setContactRadius (DtReal radius) |
| virtual DtReal | contactRadius () const |
| virtual void | setContact (const DtUUID &) |
| virtual const DtUUID & | contact () const |
| virtual void | setSpotter (const DtUUID &) |
| virtual const DtUUID & | spotter () const |
| virtual void | setSpotterMarkingText (const DtString &) |
| virtual const DtString & | spotterMarkingText () const |
| virtual void | setSpotterForceType (int) |
| virtual int | spotterForceType () const |
| virtual DtTime | timeOfReport () const |
| virtual void | setDateAndTimeOfReport (DtTime t) |
| virtual DtTime | dateAndTimeOfReport () const |
| virtual void | setSimulationTime (double) |
| virtual double | simulationTime () const |
| virtual void | setExpirationTime (double) |
| virtual double | expirationTime () const |
| virtual DtTime | timeOfContact () const |
| virtual void | setDateAndTimeOfContact (DtTime t) |
| virtual DtTime | dateAndTimeOfContact () const |
| virtual void | setOriginalDateAndTimeOfContact (DtTime t) |
| virtual DtTime | originalDateAndTimeOfContact () const |
| virtual void | setCombatIdentificationLevel (int t) |
| virtual int | combatIdentificationLevel () const |
| virtual void | setDetectionErrorRange (double range) |
| virtual double | detectionErrorRange () const |
| virtual void | setDetectionErrorHorizontal (double angle) |
| virtual double | detectionErrorHorizontal () const |
| virtual void | setDetectionErrorVertical (double angle) |
| virtual double | detectionErrorVertical () const |
| virtual void | setContactHealthPercentage (double) |
| virtual double | contactHealthPercentage () const |
| virtual void | setContactInfo (const DtRwSensorContactInfo &info) |
| virtual const DtRwSensorContactInfo & | contactInfo () const |
| virtual DtRwSensorContactInfo & | contactInfo () |
| virtual void | setUseGroundTruth (bool) |
| virtual bool | useGroundTruth () const |
| virtual void | setEngagementResult (const DtString &) |
| virtual const DtString & | engagementResult () const |
Public Member Functions inherited from DtSimReport | |
| virtual | ~DtSimReport () |
| virtual bool | init () |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual char * | netRep () |
| virtual void | clearNetRep () |
Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| bool | operator== (const DtReaderWriter &) const |
| bool | operator!= (const DtReaderWriter &rhs) const |
| virtual | ~DtReaderWriter () |
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| virtual void | postPutSelf () |
| virtual void | prePutSelf () |
| virtual void | postGetSelf () |
| virtual void | preGetSelf () |
| virtual void | writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| virtual DtSymbolString | name () const |
| virtual void | addAlias (const DtSymbolString &alias) |
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| bool | isReadonly () const |
| virtual void | reset () |
| virtual int | alignment () const |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| virtual void | setName (const DtString &) |
| virtual const char * | readerWriterType () const |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| virtual bool | hasVariableReference () const |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| virtual void | recordUpdateTime () const |
| virtual bool | changedSinceLastChecked () |
| virtual bool | peekChangedSinceLastChecked () const |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| virtual DtSymbolString | variableName () const |
| virtual void | setVariableName (const DtSymbolString variableName) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| const DtReaderWriterRegistry & | registry () const |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| virtual bool | toXml (const DtFilename &) const |
| virtual bool | fromXml (const DtString &) |
| virtual bool | fromXmlFile (const DtFilename &) |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
Static Public Member Functions | |
| static DtSimReport * | creator () |
Static Public Member Functions inherited from DtSimReport | |
| static DtSimReport * | createReport (const DtSimReportMessageType &reportTypeString) |
| static void | addReportCreatorFcn (const DtSimReportMessageType &reportName, DtSimReportCreatorFcn fcn) |
| static void | setFactory (DtSimReportFactory *factory) |
| static DtSimReportFactory * | factory () |
| static bool | isTypeRegistered (const DtSimReportMessageType &type) |
Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (std::string &fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static void | setPutIndent (bool) |
| static bool | putIndent () |
| static const char * | theXmlType () |
| static const DtFilename & | appPath () |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriterFactory * | factory () |
| static void | setOutputStream (DtOutputStream *stream) |
| static DtOutputStream & | outputStream () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
Protected Attributes | |
| DtRwSensorContactInfo | myContactInfo |
| DtRwString | mySpotterMarkingText |
| DtRwInt | mySpotterForceType |
| DtRwUUID | mySpotter |
| DtRwString | myEngagementResult |
| DtRwReal | myDateAndTimeOfReport |
| DtRwReal | mySimulationTime |
| DtRwBoolean | myUseGroundTruth |
| DtRwInt | myReason |
| DtRwReal | myExpirationTime |
| unsigned long | myResendId |
Protected Attributes inherited from DtSimReport | |
| char * | myNetRep |
Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| DtReaderWriterRegistry * | myParentRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| DtReaderWriter * | myDefaultValue |
| aliasContainer | myAliases |
| bool | myInvalid |
| bool | myChangedFlag |
Private Member Functions | |
| DtSpotReport () | |
| enum DtSpotReport::Reason |
| DtSpotReport::DtSpotReport | ( | const DtString & | rwName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtSpotReport::DtSpotReport | ( | const DtString & | rwName, |
| const DtSpotReport & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
|
virtual |
|
private |
Default constructor is private since it is not implemented.
| const DtSpotReport& DtSpotReport::operator= | ( | const DtSpotReport & | orig | ) |
|
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 |
make a copy of this report
Implements DtSimReport.
|
virtual |
The perceived location of the contact being reported. Specified in geocentric coordinates.
|
virtual |
The perceived location of the contact being reported. Specified in geocentric coordinates.
|
virtual |
The perceived orientation of the contact being reported. Specified in the geocentric reference frame.
|
virtual |
The perceived orientation of the contact being reported. Specified in the geocentric reference frame.
|
virtual |
The perceived velocity of the contact being reported. Specified in the geocentric reference frame.
|
virtual |
The perceived velocity of the contact being reported. Specified in the geocentric reference frame.
|
virtual |
If the reason is resend this is the id of the requesting front-end or 0 if scenario load.
|
virtual |
The reason this spot report is being sent.
|
virtual |
The reason this spot report is being sent.
|
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 |
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 |
The perceived formation of the contact being reported. The report uses OtherFormation to indicate unknown formation. (the default)
|
virtual |
The perceived formation of the contact being reported. The report uses OtherFormation to indicate unknown formation. (the default)
|
virtual |
The perceived force of the contact being reported. Defaults to DtForceOther.
|
virtual |
The perceived force of the contact being reported. Defaults to DtForceOther.
|
virtual |
The perceived activity of the contact. This value is a string as defined by the implementor of this activity.
|
virtual |
The perceived activity of the contact. This value is a string as defined by the implementor of this activity.
|
virtual |
The radius of the contact. Valid only for aggregates. Defaults to 0.
|
virtual |
The radius of the contact. Valid only for aggregates. Defaults to 0.
|
virtual |
The object of the contact being reported, if the contact represents an actual object in the simulation. Included to facilitate sensor fusion type operations.Was: setContactname.
|
virtual |
Was: contactName.
|
virtual |
Marking text of the contact. To be used when UUID might not be available on logger tape.
|
virtual |
|
virtual |
The entity which initially reported the contact. If the report is forwarded up the chain of command, this name should remain the same.Was: setSpotterName.
|
virtual |
Was: spotterName.
|
virtual |
Used for logger tape recordings. This information can be used when the UUID is not known, in the case where the vrfObjectData is not recorded to the tape.
|
virtual |
Used for logger tape recordings. This information can be used when the UUID is not known, in the case where the vrfObjectData is not recorded to the tape.
|
virtual |
Used for logger tape recordings. This information can be used when the UUID is not known, in the case where the vrfObjectData is not recorded to the tape.
|
virtual |
Used for logger tape recordings. This information can be used when the UUID is not known, in the case where the vrfObjectData is not recorded to the tape.
|
virtual |
The time of day when the report was sent. This corresponds to the day only part of the dateAndTimeOfReport() method. It is expressed in seconds passed midnight.
|
virtual |
The epoch time of the report was initially generated (date and time of day).
|
virtual |
The epoch time of the report was initially generated (date and time of day).
|
virtual |
The simulation time this report was generated.
|
virtual |
The simulation time this report was generated.
|
virtual |
The amount of time to keep this report around until expiration. -1 means forever, a time not -1 means keep this around since the time of last receipt.
|
virtual |
The amount of time to keep this report around until expiration. -1 means forever, a time not -1 means keep this around since the time of last receipt.
|
virtual |
The simulation time of the data about the contact contained in this report.
|
virtual |
The simulation date and time (epoch) of the data about the contact contained in this report.
|
virtual |
The simulation date and time (epoch) of the data about the contact contained in this report.
|
virtual |
The simulation date and time (epoch) of the data about the the first time this contact was seen.
|
virtual |
The simulation date and time (epoch) of the data about the the first time this contact was seen.
|
virtual |
The identification level of the contact.
|
virtual |
The identification level of the contact.
|
virtual |
The identification detection error.
|
virtual |
The identification detection error.
|
virtual |
The identification detection error.
|
virtual |
The identification detection error.
|
virtual |
The identification detection error.
|
virtual |
The identification detection error.
|
virtual |
The current health of the target from 0 - 1.
|
virtual |
The current health of the target from 0 - 1.
|
virtual |
Accessor for the contact info.
|
virtual |
Accessor for the contact info.
|
virtual |
Accessor for the contact info.
|
virtual |
Accessor myUseGroundTruth.
|
virtual |
Accessor myUseGroundTruth.
|
virtual |
Accessor myEngagementResult.
|
virtual |
Accessor myEngagementResult.
|
virtual |
Adds current size of this message to size reported by base class.
Implements DtSimReport.
Extracts elements of this report from the network buffer.
Implements DtSimReport.
|
virtual |
Encodes contents of this report into the network buffer.
Implements DtSimReport.
|
static |
Returns a new instance of DtSpotReport.
|
virtual |
Reimplemented from DtSimReport.
|
virtual |
Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.
Reimplemented from DtReaderWriter.
|
virtual |
Merges spot report information by taking the latest information and merging into this report. Returns true if changes were made.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
If this is some kind of engagement, a string that describes the outcome.
|
protected |
Time report was generated.
|
protected |
Simulation time that the report was generated.
|
protected |
Hint to the front-end to ignore spot report data and use ground truth for the spot report (default is false)
|
protected |
|
protected |