VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtCeAnd Class Reference

class DtCeAnd: More...

Inheritance diagram for DtCeAnd:
Inheritance graph
[legend]

Public Member Functions

 DtCeAnd ()
 default constructor
 DtCeAnd (DtReaderWriterRegistry *parentRegistry)
 real constructor
 DtCeAnd (const DtCeAnd &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
virtual ~DtCeAnd ()
 destructor
DtCeAndoperator= (const DtCeAnd &orig)
 assignment operator
virtual DtSimCondExprclone (DtReaderWriterRegistry *parentRegistry=NULL)
 clone operator
virtual int type () const
 Returns the type of conditional expression defined in condExprTypes.h.
virtual void setLeftCondExpr (DtSimCondExpr *leftExpr)
 Set the left conditional sub-expression.
virtual DtSimCondExprleftCondExpr ()
virtual const DtSimCondExprleftCondExpr () const
virtual void setRightCondExpr (DtSimCondExpr *rightExpr)
 Set the right conditional sub-expression.
virtual DtSimCondExprrightCondExpr ()
virtual const DtSimCondExprrightCondExpr () const
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 DtString stringRep (int subExprIndex=DtSR_EXPR) const
 Get a readable string representation of this level of this expression.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, 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.
virtual bool evaluate (const DtString &objectName, DtSimManager *simManager) 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.
DtString stringRepFull () const
 Get a readable string representation of this full expression.
virtual char * netRep ()
- 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)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *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 bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
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 DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
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 void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
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 DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions

static DtSimCondExprcreator ()
- Static Public Member Functions inherited from DtSimCondExpr
static DtSimCondExprcreateCondExpr (DtlObjPtr mtlStream)
 Static functions.
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 DtCondExprFactoryfactory ()
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.

Protected Attributes

DtSimCondExprmyLeftCondExpr
DtSimCondExprmyRightCondExpr
- Protected Attributes inherited from DtSimCondExpr
char * myNetRep
DtEvaluatormyEvaluator
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
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.

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::pair
< DtSymbolString, DtString
DtVariableNameType
- 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 DtCondExprFactorymyFactory

Detailed Description

class DtCeAnd:

Instances of DtCeAnd represent a logical AND of two Conditional Expressions.

Constructor & Destructor Documentation

DtCeAnd::DtCeAnd ( )

default constructor

DtCeAnd::DtCeAnd ( DtReaderWriterRegistry parentRegistry)

real constructor

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

copy constructor

virtual DtCeAnd::~DtCeAnd ( )
virtual

destructor

Member Function Documentation

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

assignment operator

virtual DtSimCondExpr* DtCeAnd::clone ( DtReaderWriterRegistry parentRegistry = NULL)
virtual

clone operator

Implements DtSimCondExpr.

virtual int DtCeAnd::type ( ) const
virtual

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

DtCondExprAndType

Implements DtSimCondExpr.

virtual void DtCeAnd::setLeftCondExpr ( DtSimCondExpr leftExpr)
virtual

Set the left conditional sub-expression.

Note: the DtCeAnd object will take over ownership of the leftExpr object.

virtual DtSimCondExpr* DtCeAnd::leftCondExpr ( )
virtual
virtual const DtSimCondExpr* DtCeAnd::leftCondExpr ( ) const
virtual
virtual void DtCeAnd::setRightCondExpr ( DtSimCondExpr rightExpr)
virtual

Set the right conditional sub-expression.

Note: the DtCeAnd object will take over ownership of the rightExpr object.

virtual DtSimCondExpr* DtCeAnd::rightCondExpr ( )
virtual
virtual const DtSimCondExpr* DtCeAnd::rightCondExpr ( ) const
virtual
virtual int DtCeAnd::subExprCount ( ) const
virtual

Get the number of sub-expressions nested inside this expression.

This is two in the case of AND and OR, and one in the case of NOT.

Reimplemented from DtSimCondExpr.

virtual DtSimCondExpr* DtCeAnd::subExpr ( int  index)
virtual

Get a pointer to any particular sub-expression nested inside this expression.

Sub-expressions are indexed as C arrays are (i.e. starting with sub-expression #0). An index of zero selects the left (the only expression for NOT) sub-expression. An index of one selects the right sub-expression of an AND or an OR.

Reimplemented from DtSimCondExpr.

virtual DtString DtCeAnd::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.

virtual DtlObjPtr DtCeAnd::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
virtual

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.

Reimplemented from DtReaderWriter.

virtual int DtCeAnd::netRepSize ( ) const
virtual

returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSimCondExpr.

virtual bool DtCeAnd::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
)
virtual

Fills in the expression from the network buffer.

Reimplemented from DtSimCondExpr.

virtual bool DtCeAnd::setToNet ( )
virtual

Fills in the network buffer (created by base class conditional expression) with the conditional expression contents.

Reimplemented from DtSimCondExpr.

static DtSimCondExpr* DtCeAnd::creator ( )
static

Member Data Documentation

DtSimCondExpr* DtCeAnd::myLeftCondExpr
protected
DtSimCondExpr* DtCeAnd::myRightCondExpr
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)