 |
VR-Forces 4.8 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.8 Class Documentation
|
Process State Repository for the DtActiveSonarSensor component. More...
Public Member Functions | |
| DtActiveSonarSensorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| constructor More... | |
| DtActiveSonarSensorPSR (const DtActiveSonarSensorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| virtual | ~DtActiveSonarSensorPSR () |
| destructor More... | |
| DtActiveSonarSensorPSR & | operator= (const DtActiveSonarSensorPSR &orig) |
| assignment operator - not implemented More... | |
| virtual DtVrfProcessStateRepository * | clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const |
| returns a newly created copy of this object More... | |
| virtual DtString | type () const |
| virtual void | setNextDetectAttempt (DtTime time) |
| Simulation time of next detection attempt (in seconds). More... | |
| virtual DtTime | nextDetectAttempt () const |
| virtual DtString | activeSonarMode () const |
| virtual void | setActiveSonarMode (const DtString &mode) |
| virtual bool | activeSonarModeSpecified () const |
 Public Member Functions inherited from DtPassiveSonarSensorPSR | |
| DtPassiveSonarSensorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| constructor More... | |
| DtPassiveSonarSensorPSR (const DtPassiveSonarSensorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| virtual | ~DtPassiveSonarSensorPSR () |
| destructor More... | |
| DtPassiveSonarSensorPSR & | operator= (const DtPassiveSonarSensorPSR &orig) |
| assignment operator - not implemented More... | |
| virtual void | setDepth (DtReal depth) |
| virtual DtReal | depth () const |
| virtual bool | depthSpecified () const |
| virtual void | setDepthSpecified (bool specified) |
| Public Member Functions inherited from DtSignatureObjectSensorPSR | |
| DtSignatureObjectSensorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| constructor More... | |
| DtSignatureObjectSensorPSR (const DtSignatureObjectSensorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| virtual | ~DtSignatureObjectSensorPSR () |
| destructor More... | |
| DtSignatureObjectSensorPSR & | operator= (const DtSignatureObjectSensorPSR &orig) |
| assignment operator - not implemented More... | |
| virtual void | setZoomLevel (double zoom) |
| The current zoom level, for sensors with zoom capability. More... | |
| virtual double | zoomLevel () const |
| Public Member Functions inherited from DtObjectSensorPSR | |
| DtObjectSensorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| constructor More... | |
| DtObjectSensorPSR (const DtObjectSensorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor More... | |
| virtual | ~DtObjectSensorPSR () |
| destructor More... | |
| DtObjectSensorPSR & | operator= (const DtObjectSensorPSR &orig) |
| assignment operator - not implemented More... | |
| virtual bool | init () |
| Call after creation. More... | |
| virtual DtSensorContactInfoList * | contactInfoList () |
| The list of DtRwSensorContactInfo (or derivative) objects. More... | |
| virtual const DtSensorContactInfoList * | contactInfoList () const |
| The const list of DtRwSensorContactInfo (or derivative) objects. More... | |
| virtual DtRwSensorContactInfo * | lookupContactById (const DtEntityIdentifier &id) const |
| Returns the contact info for the contact with the specified entity ID, or NULL if not found. More... | |
| virtual void | clearContactInfoList () |
| Empties the contact info list. More... | |
| virtual DtRwSensorContactInfo * | createSensorContactInfo () const |
| Returns a new DtRwSensorContactInfo (or derivative) class by calling myContactInfoList->createSensorContactInfo(). More... | |
| virtual const DtRwObjectTypeList & | typesToDetectForTask () const |
| Sets a list of entity types to detect. More... | |
| virtual void | setTypesToDetectForTask (const DtRwObjectTypeList &objectTypes) |
| Sets the dynamic list of types to detect. More... | |
| virtual void | clearTypesToDetectForTask () |
| Clears the dynamic list of types to detect. More... | |
| virtual void | setSensorEnabled (bool enabled) |
| Whether the sensor is enabled or disabled. More... | |
| virtual bool | sensorEnabled () const |
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) |
| Override to call mapTargetIdsToTargetNames() before calling base class version to write ourselves to file. More... | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Override to set flag indicating we should map target names to target identifiers the next time lookupPreviousTarget() is called. More... | |
| Public Member Functions inherited from DtVrfProcessStateRepository | |
| DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| const DtVrfProcessStateRepository & | operator= (const DtVrfProcessStateRepository &orig) |
| virtual | ~DtVrfProcessStateRepository () |
| virtual bool | loadedFromMTL () const |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor More... | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. More... | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor More... | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor More... | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator More... | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. More... | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor More... | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. More... | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. More... | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. More... | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. More... | |
| virtual void | writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More... | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. More... | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. More... | |
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. More... | |
| bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More... | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. More... | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. More... | |
| virtual void | setName (const DtString &) |
| Set the name of the object. More... | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. More... | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. More... | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. More... | |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| Returns true if this variable has a child p in it's chain. More... | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. More... | |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More... | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. More... | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. More... | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. More... | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More... | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. More... | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. More... | |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. More... | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. More... | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. More... | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. More... | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More... | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. More... | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. More... | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More... | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. More... | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. More... | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. More... | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. More... | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. More... | |
| 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()) |
| Gets data from the environment value. More... | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More... | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. More... | |
Static Public Member Functions | |
| static DtVrfProcessStateRepository * | creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry) |
| Returns a newly created instance of this class. More... | |
| Static Public Member Functions inherited from DtPassiveSonarSensorPSR | |
| static DtVrfProcessStateRepository * | creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry) |
| Returns a newly created instance of this class. More... | |
| Static Public Member Functions inherited from DtSignatureObjectSensorPSR | |
| static DtVrfProcessStateRepository * | creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry) |
| Returns a newly created instance of this class. More... | |
| Static Public Member Functions inherited from DtObjectSensorPSR | |
| static DtVrfProcessStateRepository * | creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry) |
| Returns a newly created instance of this class. More... | |
| Static Public Member Functions inherited from DtVrfProcessStateRepository | |
| static DtVrfProcessStateRepositoryFactory * | factory () |
| a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set. More... | |
| static void | setFactory (DtVrfProcessStateRepositoryFactory *factory) |
| static void | addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn) |
| static DtVrfProcessStateRepository * | createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0) |
| Creates a new state repository object, using the factory. More... | |
| 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 () |
| The type that is used when archiving to an XML stream. More... | |
| static const DtFilename & | appPath () |
| Gets the current working directory. More... | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. More... | |
| 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) |
| Given a filename, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. More... | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. More... | |
Protected Attributes | |
| DtRwString | myActiveSonarMode |
| DtRwReal | myNextDetectAttempt |
| Simulation time of next detection attempt (seconds). More... | |
| Protected Attributes inherited from DtPassiveSonarSensorPSR | |
| DtRwReal | myDepth |
| Protected Attributes inherited from DtSignatureObjectSensorPSR | |
| DtRwReal | myZoomLevel |
| Protected Attributes inherited from DtObjectSensorPSR | |
| DtSensorContactInfoList * | myContactInfoList |
| Init() creates this item by using the createSensorContactInfoList() factory method. More... | |
| bool | myMutableMapContactNamesToContactIds |
| Flag used to indicate that we should initialize contact names to DtEntityIdentifiers. More... | |
| DtRwObjectTypeList | myTaskDetectionTypes |
| Parameter Name: task-detection-types Parameter Description: Types of objects to detect for a particular task. More... | |
| DtRwReal | myNextDetectAttempt |
| Simulation time of next detection attempt (seconds). More... | |
| DtRwBoolean | mySensorEnabled |
| Whether the sensor is enabled or disabled. More... | |
| Protected Attributes inherited from DtVrfProcessStateRepository | |
| DtVrfObject * | myVrfObject |
| bool | myLoadedFromMTL |
| 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 |
| Container for the aliases which represent alternative names for the object. More... | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. More... | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. More... | |
Additional Inherited Members | |
| 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 )() |
| Protected Member Functions inherited from DtObjectSensorPSR | |
| virtual DtSensorContactInfoList * | createSensorContactInfoList (const DtString &name) |
| Returns a new DtSensorContactInfoList. More... | |
| virtual void | mapContactIdsToContactNames () |
| Looks up each object in myContactInfoList by the entity ID in the contact information and sets the name of the contact in the contact info to the name of the object found. More... | |
| virtual void | mapContactNamesToContactIds () |
| Looks up each object in myContactInfoList by name, and sets the entity ID in the contact information to the one found in the vrf object. More... | |
| Protected Member Functions inherited from DtVrfProcessStateRepository | |
| DtVrfProcessStateRepository () | |
| const DtVrfObject * | const_vrfObject () const |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. More... | |
| Static Protected Attributes inherited from DtVrfProcessStateRepository | |
| static DtVrfProcessStateRepositoryFactory * | theFactory |
| Static Protected Attributes inherited from DtReaderWriter | |
| static DtString | theUnspecifiedValue |
| static DtGetSelfCallbackInfo | thePostGetSelfCallback |
| static DtPutSelfCallbackInfo | thePrePutSelfCallback |
| static const DtVariableBindingsList | theEmptyVariableBindingsList |
| static bool | theCreatorFcnSet |
| static DtReaderWriterFactory * | theFactory |
| static DtReaderWriterFactoryCreatorFcn | theFactoryCreatorFcn |
| static bool | thePutIndent |
| static DtOutputStream * | theOutputStream |
Process State Repository for the DtActiveSonarSensor component.
Extends DtObjectSensorPSR with a boolean to track whether the active sonar system is on or off.
| DtActiveSonarSensorPSR::DtActiveSonarSensorPSR | ( | DtVrfObject * | vrfObject, |
| const DtString & | rwName = DtString::nullString(), |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtActiveSonarSensorPSR::DtActiveSonarSensorPSR | ( | const DtActiveSonarSensorPSR & | orig, |
| const DtString & | rwName = DtString::nullString(), |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
| DtActiveSonarSensorPSR& DtActiveSonarSensorPSR::operator= | ( | const DtActiveSonarSensorPSR & | orig | ) |
assignment operator - not implemented
|
virtual |
returns a newly created copy of this object
Reimplemented from DtPassiveSonarSensorPSR.
|
virtual |
Reimplemented from DtPassiveSonarSensorPSR.
|
virtual |
Simulation time of next detection attempt (in seconds).
Reimplemented from DtObjectSensorPSR.
|
virtual |
Reimplemented from DtObjectSensorPSR.
|
virtual |
|
virtual |
|
virtual |
|
static |
Returns a newly created instance of this class.
|
protected |
|
protected |
Simulation time of next detection attempt (seconds).