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 DtUUID &object, 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)
	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 (FILE *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 (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 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.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal 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 void	putData (FILE *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)
	Deriving class overrides these to get/put class specific data.
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 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)
	The variable name, if this object is a variable reference.
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 ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
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 ()
	Collection of child DtReaderWriter nodes owned by this object.
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 &)
	Restires 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 *	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 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 &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	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 ()

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.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
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.

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 bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

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 )()

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, DtCeSimTime, DtCeConstant, DtCeOr, DtCeAnd, DtCeNot, DtCeRandom, DtCeAltitude, DtCeReceiveTextMessage, DtCeEntDiGuyAppearance, DtCeSurrender, vrfAddConditionalExample::MyConditionalExpression, DtCeCheckEntityIdentificationLevel, DtCeEntDiGuyAnimation, DtCeEntEmbarkationStateChange, DtCeMissileApproachWarning, DtCeScenarioEvent, DtCeSimDateTime, DtCeBreached, DtCeEnvironmentalActive, DtCeEntDestroyed, DtCeEntHasTarget, DtCeEntInArea, DtCeEntLeftOfLine, and DtCeEntUnderFire.

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 DtUUID &	object,
		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, DtCeOr, DtCeAnd, DtCeSimTime, DtCeAltitude, DtCeNot, DtCeConstant, DtCeSurrender, DtCeCheckEntityIdentificationLevel, DtCeEntInArea, DtCeEntLeftOfLine, DtCeEntEmbarkationStateChange, DtCeRandom, DtCeEntDiGuyAnimation, DtCeEntDiGuyAppearance, DtCeReceiveTextMessage, vrfAddConditionalExample::MyConditionalExpression, DtCeEntHasTarget, DtCeEntUnderFire, DtCeEntDestroyed, DtCeScenarioEvent, DtCeBreached, DtCeMissileApproachWarning, DtCeSimDateTime, and DtCeEnvironmentalActive.

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, DtCeOr, DtCeAnd, DtCeNot, DtCeSimTime, DtCeAltitude, DtCeConstant, DtCeSurrender, DtCeCheckEntityIdentificationLevel, DtCeEntInArea, DtCeEntLeftOfLine, DtCeEntEmbarkationStateChange, DtCeRandom, DtCeEntDiGuyAnimation, DtCeEntDiGuyAppearance, vrfAddConditionalExample::MyConditionalExpression, DtCeEntHasTarget, DtCeEntUnderFire, DtCeReceiveTextMessage, DtCeEntDestroyed, DtCeScenarioEvent, DtCeBreached, DtCeMissileApproachWarning, DtCeSimDateTime, and DtCeEnvironmentalActive.

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/simCondExpr.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