VR-Forces 4.6.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions
DtCeOr Class Reference

class DtCeOr: More...

Inheritance diagram for DtCeOr:
Inheritance graph
[legend]

Public Member Functions

 DtCeOr ()
 default constructor
 DtCeOr (DtReaderWriterRegistry *parentRegistry)
 real constructor
 DtCeOr (const DtCeOr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
virtual ~DtCeOr ()
 destructor
DtCeOroperator= (const DtCeOr &orig)
 assignment operator
virtual DtSimCondExprclone (DtReaderWriterRegistry *parentRegistry=NULL) const
 clone operator
virtual int type () const
 Returns the type of conditional expression defined in condExprTypes.h.
virtual DtString stringRep (int subExprIndex=DtSR_EXPR) const
 Get a readable string representation of this level of this expression.
- Public Member Functions inherited from DtLogicalOperatorCondition
 DtLogicalOperatorCondition (const DtString &typeName)
 default constructor
 DtLogicalOperatorCondition (const DtString &typeName, DtReaderWriterRegistry *parentRegistry)
 real constructor
 DtLogicalOperatorCondition (const DtLogicalOperatorCondition &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
virtual ~DtLogicalOperatorCondition ()
 destructor
DtLogicalOperatorConditionoperator= (const DtLogicalOperatorCondition &orig)
 assignment operator
virtual void addCondition (const DtSimCondExpr &)
 Adds a new condition into the condition list. Will clone.
virtual void removeCondition (const DtSimCondExpr &)
 Removes exactly matching condition.
virtual void clearConditions ()
 Clears out all conditions.
const DtRwConditionsListconditions () const
 Ruturns conditions.
virtual int subExprCount () const
 Get the number of sub-expressions nested inside this expression.
virtual DtSimCondExprsubExpr (int index)
 Get a pointer to any particular sub-expression nested inside this expression.
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 This special version of getData needs to create the necessary sub-expression elements, tell the elements to getSelf, and then add the element to myRegistry.
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.
DtSimCondExproperator= (const DtSimCondExpr &orig)
 assignment operator
virtual void setEvaluator (DtEvaluator *evaluator)
 Set the evaluator object to be used in our evaluate() function.
DtEvaluatorevaluator ()
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 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 charnetRep ()
virtual const DtUUIDsimulationObject () 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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () 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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () 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 DtSimCondExprcreator ()

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 charcreateNetworkBuffer ()
- Protected Attributes inherited from DtLogicalOperatorCondition
DtRwConditionsList myConditions
- Static Protected Attributes inherited from DtSimCondExpr
static DtCondExprFactorymyFactory

Detailed Description

class DtCeOr:

Instances of DtCeOr represent a logical OR of two Conditional Expressions.

Constructor & Destructor Documentation

DtCeOr::DtCeOr ( )

default constructor

DtCeOr::DtCeOr ( DtReaderWriterRegistry parentRegistry)

real constructor

DtCeOr::DtCeOr ( const DtCeOr orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

virtual DtCeOr::~DtCeOr ( )
virtual

destructor

Member Function Documentation

DtCeOr& DtCeOr::operator= ( const DtCeOr orig)

assignment operator

virtual DtSimCondExpr* DtCeOr::clone ( DtReaderWriterRegistry parentRegistry = NULL) const
virtual

clone operator

Implements DtSimCondExpr.

virtual int DtCeOr::type ( ) const
virtual

Returns the type of conditional expression defined in condExprTypes.h.

DtCondExprAndType

Implements DtSimCondExpr.

virtual DtString DtCeOr::stringRep ( int  subExprIndex = DtSR_EXPR) const
virtual

Get a readable string representation of this level of this expression.

The subExprIndex argument indicates which stringRep to get as a prefix for a given sub-expression. For an AND expression, the first (0) sub-expression's prefix is the "AND(" part, the second sub-expression's prefix is the ", " part, and if the subExprIndex value of DtSimCondExpr::DtSR_EXPR is given, the final ")" is returned.

See the documentation for DtSimCondExpr::stringRep for more information.

Implements DtSimCondExpr.

static DtSimCondExpr* DtCeOr::creator ( )
static

The documentation for this class was generated from the following file:

Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)