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 ()
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 Attributes
static const int	DtSR_EXPR = -1
	A constant for use as the subExprIndex argument to stringRep().
Protected Member Functions
virtual char *	createNetworkBuffer ()
Protected Attributes
char *	myNetRep
DtEvaluator *	myEvaluator
Static Protected Attributes
static DtCondExprFactory *	myFactory

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 [inline, virtual]

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
	)		`[inline, virtual]`

virtual bool DtSimCondExpr::setToNet ( ) [inline, virtual]

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 ( ) [protected, virtual]