Inheritance diagram for DtSimCondExpr:

Public Member Functions
	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 DtSimCondExpr *	clone (DtReaderWriterRegistry *parentRegistry=NULL)=0
	clone operator
virtual int	type () const =0
	Returns the type of conditional expression defined in condExprTypes.h.
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.
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	stringRep (int subExprIndex=DtSR_EXPR) const =0
	Get a readable string representation of this level of this expression.
DtString	stringRepFull () const
	Get a readable string representation of this full expression.
virtual char *	netRep ()
virtual int	netRepSize () const
	These 3 should become pure virtual functions.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
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 DtReaderWriter &	operator= (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 aliasContainer &	aliases () 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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtSimCondExpr *	createCondExpr (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 DtCondExprFactory *	factory ()
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.

Static Public Attributes
static const int	DtSR_EXPR = -1
	A constant for use as the subExprIndex argument to stringRep().

Protected Member Functions
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
char *	myNetRep
DtEvaluator *	myEvaluator
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.

Static Protected Attributes
static DtCondExprFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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

Detailed Description

class DtSimCondExpr:

DtSimCondExpr is an abstract base class representing various Conditional Expressions used by the Plan engine and triggers.

Constructor & Destructor Documentation

DtSimCondExpr::DtSimCondExpr ( )

default constructor

DtSimCondExpr::DtSimCondExpr	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

real constructor

DtSimCondExpr::DtSimCondExpr	(	const DtSimCondExpr &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

virtual DtSimCondExpr::~DtSimCondExpr ( )

virtual

destructor

Member Function Documentation

virtual bool DtSimCondExpr::init ( )

virtual

Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.

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

assignment operator

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

pure virtual

virtual int DtSimCondExpr::type ( ) const

pure virtual

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

Implemented in DtCeResourceOperator, DtCeAltitude, DtCeSimTime, vrfAddConditionalExample::MyConditionalExpression, DtCeConstant, DtCeSurrender, DtCeEntDestroyed, DtCeEntHasTarget, DtCeEntInArea, DtCeEntLeftOfLine, DtCeEntUnderFire, DtCeEntDiGuyAnimation, DtCeEntDiGuyAppearance, DtCeOr, DtCeAnd, DtCeEntEmbarkationStateChange, DtCeNot, DtCeRandom, DtCeReceiveTextMessage, and DtCeCheckEntityIdentificationLevel.

virtual void DtSimCondExpr::setEvaluator ( DtEvaluator * evaluator )

virtual

Set the evaluator object to be used in our evaluate() function.

Takes over responsiblity for deleting the memory associated with the DtEvaluator. You must set an evaluator if you intend to call evaluate() on the conditional expression.

virtual bool DtSimCondExpr::evaluate	(	const DtString &	objectName,
		DtSimManager *	simManager
	)		const

virtual

Evaluate this conditional expression for the entity with the given object name, in the context of the given simManager, and return the current result.

Uses the DtEvaluator object set in setEvaluator() to actually perform the evaluation. An evaluator must be set before this function is called. Evaluation is expected to be performed by back-ends only (remote-control applications such as GUIs will not typically call this function).

virtual int DtSimCondExpr::subExprCount ( ) const

virtual

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

Reimplemented in DtCeOr, DtCeAnd, and DtCeNot.

virtual DtSimCondExpr* DtSimCondExpr::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).

Reimplemented in DtCeOr, DtCeAnd, and DtCeNot.

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

pure virtual

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. If a sub-expression index >= 0 is given, the string returned will be the one that should precede that sub-expression. A sub-expression index of DtSimCondExpr::DtSR_EXPR requests the string that should follow any and all sub-expressions, this is the value that should be used for expressions that have no subExprs (i.e. subExprCount() == 0).

Implemented in DtCeResourceOperator, DtCeAltitude, DtCeOr, DtCeAnd, vrfAddConditionalExample::MyConditionalExpression, DtCeSimTime, DtCeSurrender, DtCeEntInArea, DtCeEntLeftOfLine, DtCeEntHasTarget, DtCeEntUnderFire, DtCeEntDiGuyAnimation, DtCeEntDiGuyAppearance, DtCeEntEmbarkationStateChange, DtCeNot, DtCeEntDestroyed, DtCeConstant, DtCeCheckEntityIdentificationLevel, DtCeRandom, and DtCeReceiveTextMessage.

DtString DtSimCondExpr::stringRepFull ( ) const

Get a readable string representation of this full expression.

This calls stringRep and stringRepFull recursively for each subExpr and combines them into a single string.

virtual char* DtSimCondExpr::netRep ( )

virtual

virtual int DtSimCondExpr::netRepSize ( ) const

inlinevirtual

These 3 should become pure virtual functions.

Reimplemented in DtCeResourceOperator, DtCeAltitude, DtCeOr, DtCeAnd, DtCeNot, vrfAddConditionalExample::MyConditionalExpression, DtCeSimTime, DtCeSurrender, DtCeEntInArea, DtCeEntLeftOfLine, DtCeEntHasTarget, DtCeEntUnderFire, DtCeEntDiGuyAnimation, DtCeEntDiGuyAppearance, DtCeEntEmbarkationStateChange, DtCeEntDestroyed, DtCeConstant, DtCeCheckEntityIdentificationLevel, DtCeRandom, and DtCeReceiveTextMessage.

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

inlinevirtual

virtual bool DtSimCondExpr::setToNet ( )

inlinevirtual

static DtSimCondExpr* DtSimCondExpr::createCondExpr ( DtlObjPtr mtlStream )

static

Static functions.

Construct an empty conditional expression of the appropriate type. Creates a new conditional expression, given a pointer to an MTL stream. It parses the stream to extract the type of conditional expression to create. Then it calls the conditional expression factory's create() member function with the statement type. This returns a new instance of the conditional expression type. The conditional expression's getData() member function is then called to retrieve the conditional expression parameters from the stream. The pointer to the new conditional expression is returned.

static void DtSimCondExpr::addCondExprCreatorFcn	(	const DtString &	type,
		const int	intType,
		DtCondExprCreatorFcn	fcn
	)

static

Adds a conditional expression creator member function to the conditional expression factory.

static void DtSimCondExpr::setFactory ( DtCondExprFactory * factory )

static

static DtCondExprFactory* DtSimCondExpr::factory ( )

static

Returns: A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

virtual char* DtSimCondExpr::createNetworkBuffer ( )

protectedvirtual

Member Data Documentation

const int DtSimCondExpr::DtSR_EXPR = -1

static

A constant for use as the subExprIndex argument to stringRep().

DtCondExprFactory* DtSimCondExpr::myFactory

staticprotected

char* DtSimCondExpr::myNetRep

protected

DtEvaluator* DtSimCondExpr::myEvaluator

protected

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

include/vrfutil/condExpr.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation