 |
VR-Forces 4.7 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.7 Class Documentation
|
Defines a criteria for choosing targets for a single weapon system. More...
Public Member Functions | |
| DtTargetSelectionCriteria (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtTargetSelectionCriteria (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| DtTargetSelectionCriteria (const DtString &name, const DtTargetSelectionCriteria &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| DtTargetSelectionCriteria (const DtSymbolString &name, const DtTargetSelectionCriteria &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtTargetSelectionCriteria (const DtTargetSelectionCriteria &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| DtTargetSelectionCriteria & | operator= (const DtTargetSelectionCriteria &orig) |
| assignment | |
| virtual | ~DtTargetSelectionCriteria () |
| destructor | |
| bool | operator== (const DtTargetSelectionCriteria &) const |
| Equivalence operator. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual DtTargetPriorityList & | priorityList () |
| Accessor/mutator for myTargetPriorityList. | |
| virtual const DtTargetPriorityList & | priorityList () const |
| virtual int | maxTargets () const |
| Accessor/mutator for myMaxTargets. | |
| virtual void | setMaxTargets (int num) |
| virtual DtRwSpatialFilterContainer * | targetRegion () |
| Accessor/mutator for myTargetRegion. | |
| virtual const DtRwSpatialFilterContainer * | targetRegion () const |
| virtual bool | fireWithSpotReportOnly () const |
| virtual void | setFireWithSpotReportOnly (bool value) |
 Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| 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. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| 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. | |
| 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. | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. | |
| 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. | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. | |
| 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. | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. | |
| 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. | |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| 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. | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. | |
| 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. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| 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. | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. | |
| 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. | |
| 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. | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. | |
Protected Attributes | |
parameters | |
These parameters are available for setting in the OPD files. | |
| DtTargetPriorityList | myTargetPriorityList |
| Parameter Name: target-priorities Parameter Description: List of object types provides acceptable types of objects to use as targets, and well as what types should be considered higher priority than other types. | |
| DtRwInt | myMaxTargets |
| Parameter Name: max-targets Parameter Description: Maximum number of targets to output to this weapon system simultaneously. | |
| DtRwSpatialFilterContainer | myTargetRegion |
| Parameter Name: target-region Parameter Description: Region (in relation to the host entity) in which this weapon should attempt target objects. | |
| DtRwBoolean | myFireWithSpotReportOnly |
| Parameter Name: fire-with-spot-report-only Parameter Description: If true, the entity will use this weapon to fire on targets that it has received data on only though spot reports. | |
| 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. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. | |
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 )() |
| 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. | |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| 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. | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| 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 |
Defines a criteria for choosing targets for a single weapon system.
This class stores all the information about what targets should be considered valid for a particular weapon, and a prioritizing order for those targets.
| DtTargetSelectionCriteria::DtTargetSelectionCriteria | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtTargetSelectionCriteria::DtTargetSelectionCriteria | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtTargetSelectionCriteria::DtTargetSelectionCriteria | ( | const DtString & | name, |
| const DtTargetSelectionCriteria & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| DtTargetSelectionCriteria::DtTargetSelectionCriteria | ( | const DtSymbolString & | name, |
| const DtTargetSelectionCriteria & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| DtTargetSelectionCriteria::DtTargetSelectionCriteria | ( | const DtTargetSelectionCriteria & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
|
virtual |
destructor
| DtTargetSelectionCriteria& DtTargetSelectionCriteria::operator= | ( | const DtTargetSelectionCriteria & | orig | ) |
assignment
|
virtual |
Accessor/mutator for myTargetPriorityList.
|
virtual |
|
virtual |
Accessor/mutator for myMaxTargets.
|
virtual |
|
virtual |
Accessor/mutator for myTargetRegion.
|
virtual |
|
virtual |
|
virtual |
| bool DtTargetSelectionCriteria::operator== | ( | const DtTargetSelectionCriteria & | ) | const |
Equivalence operator.
|
virtual |
Used to supply a string type that this reader writer type is.
This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create
Reimplemented from DtReaderWriter.
Reimplemented in DtTargetingControlTable.
|
protected |
Parameter Name: target-priorities
Parameter Description: List of object types provides acceptable types of objects to use as targets, and well as what types should be considered higher priority than other types.
Parameter Default Value: Empty list.
|
protected |
Parameter Name: max-targets
Parameter Description: Maximum number of targets to output to this weapon system simultaneously.
Value of -1 indicates no limit.
Parameter Default Value: -1
|
protected |
Parameter Name: target-region
Parameter Description: Region (in relation to the host entity) in which this weapon should attempt target objects.
Only objects within the defined region are valid. If no region is defined, all targets are valid. Spatial filters can be combined with logical and/or/not operators as well.
Example 1: Every entity within 4000 meters of this entity.
(in-range
(range 4000.000000)
)
Example 2: Every entity within 4000 meters of this entity, and within the defined frustum of the facing direction of the entity.
(and
(in-range
(range 4000.000000)
)
(in-frustum
(az-max 1.0472)
(az-min -1.0472)
(el-max 1.5708)
(el-min -1.5708)
)
)
Custom geometry filters can be created though the toolkit.
See documentation for DtRwSpatialFilter for more information.
Parameter Default Value:
|
protected |
Parameter Name: fire-with-spot-report-only
Parameter Description: If true, the entity will use this weapon to fire on targets that it has received data on only though spot reports.
Otherwise, a sensor located on the entity is required to see the target before selecting it as a valid target for this weapon. Parameter Default Value: false.