 |
VR-Forces 4.6.1 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.6.1 Class Documentation
|
class DtCeEntUnderFire: More...
Public Member Functions | |
| DtCeEntUnderFire () | |
| default constructor | |
| DtCeEntUnderFire (DtReaderWriterRegistry *parentRegistry) | |
| real constructor | |
| DtCeEntUnderFire (const DtCeEntUnderFire &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| virtual | ~DtCeEntUnderFire () |
| destructor | |
| DtCeEntUnderFire & | operator= (const DtCeEntUnderFire &orig) |
| assignment operator | |
| virtual DtSimCondExpr * | clone (DtReaderWriterRegistry *parentRegistry=NULL) const |
| clone operator | |
| virtual int | type () const |
| Returns DtCondExprEntityUnderFireType (defined in condExprTypes.h). | |
| virtual void | setEntity (const DtUUID &) |
| Set the entity. | |
| virtual const DtUUID & | entity () const |
| Was: entityName. | |
| virtual void | setModifier (const DtString &arg) |
| Set the test modifier. | |
| virtual const DtString & | modifier () const |
| Returns the modifier. | |
| virtual DtString | stringRep (int subExprIndex=DtSR_EXPR) const |
| Get a readable string representation of this level of this expression. | |
| virtual int | netRepSize () const |
| returns the size of the full network representation padded to an 8-byte boundary. | |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Fills in the expression from the network buffer. | |
| virtual bool | setToNet () |
| Fills in the network buffer (created by base class conditional expression) with the conditional expression contents. | |
 Public Member Functions inherited from DtSimCondExpr | |
| DtSimCondExpr () | |
| default constructor | |
| DtSimCondExpr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtSimCondExpr (const DtSimCondExpr &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| virtual | ~DtSimCondExpr () |
| destructor | |
| virtual bool | init () |
| Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation. | |
| DtSimCondExpr & | operator= (const DtSimCondExpr &orig) |
| assignment operator | |
| virtual void | setEvaluator (DtEvaluator *evaluator) |
| Set the evaluator object to be used in our evaluate() function. | |
| DtEvaluator * | evaluator () |
| virtual bool | evaluate (const DtUUID &object, DtSimManager *simManager, const DtPlan *=0) const |
| Evaluate this conditional expression for the entity with the given object name, in the context of the given simManager, and return the current result. | |
| virtual int | subExprCount () const |
| Get the number of sub-expressions nested inside this expression. | |
| virtual DtSimCondExpr * | subExpr (int index) |
| Get a pointer to any particular sub-expression nested inside this expression. | |
| virtual DtString | modifierStringRep (const DtString &) const |
| Given the modifier string, come up with a human readable name for it. | |
| DtString | stringRepFull () const |
| Get a readable string representation of this full expression. | |
| virtual char * | netRep () |
| virtual const DtUUID & | simulationObject () const |
| Static functions. | |
| 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 * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| 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 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. | |
Static Public Member Functions | |
| static DtSimCondExpr * | creator () |
| Returns a new DtCeEntUnderFire. | |
| Static Public Member Functions inherited from DtSimCondExpr | |
| static DtSimCondExpr * | createCondExpr (DtlObjPtr mtlStream) |
| Construct an empty conditional expression of the appropriate type. | |
| static void | addCondExprCreatorFcn (const DtString &type, const int intType, DtCondExprCreatorFcn fcn) |
| Adds a conditional expression creator member function to the conditional expression factory. | |
| static void | setFactory (DtCondExprFactory *factory) |
| static DtCondExprFactory * | factory () |
| 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 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. | |
| Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter > | |
| static DtObjectCounter::CounterType | ObjectCount () |
| static const DtObjectContainer * | ObjectContainer () |
Protected Attributes | |
| DtRwUUID | myEntity |
| DtRwString | myModifier |
| Protected Attributes inherited from DtSimCondExpr | |
| char * | myNetRep |
| DtEvaluator * | myEvaluator |
| 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 Attributes inherited from DtSimCondExpr | |
| static const int | DtSR_EXPR = -1 |
| A constant for use as the subExprIndex argument to stringRep(). | |
| Protected Member Functions inherited from DtSimCondExpr | |
| virtual char * | createNetworkBuffer () |
| Static Protected Attributes inherited from DtSimCondExpr | |
| static DtCondExprFactory * | myFactory |
class DtCeEntUnderFire:
Instances of DtCeEntUnderFire represent an entity under fire test.
| DtCeEntUnderFire::DtCeEntUnderFire | ( | ) |
default constructor
| DtCeEntUnderFire::DtCeEntUnderFire | ( | DtReaderWriterRegistry * | parentRegistry | ) |
real constructor
| DtCeEntUnderFire::DtCeEntUnderFire | ( | const DtCeEntUnderFire & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
|
virtual |
destructor
| DtCeEntUnderFire& DtCeEntUnderFire::operator= | ( | const DtCeEntUnderFire & | orig | ) |
assignment operator
|
virtual |
clone operator
Implements DtSimCondExpr.
|
virtual |
Returns DtCondExprEntityUnderFireType (defined in condExprTypes.h).
Implements DtSimCondExpr.
|
virtual |
Set the entity.
Was: setEntityName
|
virtual |
Was: entityName.
|
virtual |
Set the test modifier.
If it is an empty string, checks only the specified entity. If it is the string "ANY", checks all subordinate entities to see if any of them match the test, If it is neither of the above, it requires that all specified entities match.
|
virtual |
Returns the modifier.
Get a readable string representation of this level of this expression.
The subExprIndex argument indicates which stringRep to get if this expression can have sub-expressions. Since an Entity under fire test has no sub-expressions, it only returns a string representation if passed an index of DtSimCondExpr::DtSR_EXPR.
See the documentation for DtSimCondExpr::stringRep for more information.
Implements DtSimCondExpr.
|
virtual |
returns the size of the full network representation padded to an 8-byte boundary.
Reimplemented from DtSimCondExpr.
|
virtual |
Fills in the expression from the network buffer.
Reimplemented from DtSimCondExpr.
|
virtual |
Fills in the network buffer (created by base class conditional expression) with the conditional expression contents.
Reimplemented from DtSimCondExpr.
|
static |
Returns a new DtCeEntUnderFire.
|
protected |
|
protected |