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

Inheritance diagram for DtSimCondExpr:

[legend]

Public Member Functions
	DtSimCondExpr ()
	default constructor More...

	DtSimCondExpr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor More...

	DtSimCondExpr (const DtSimCondExpr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

virtual	~DtSimCondExpr ()
	destructor More...

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. More...

DtSimCondExpr &	operator= (const DtSimCondExpr &orig)
	assignment operator More...

virtual DtSimCondExpr *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const =0
	clone operator More...

virtual int	type () const =0
	Returns the type of conditional expression defined in condExprTypes.h. More...

virtual void	setEvaluator (DtEvaluator *evaluator)
	Set the evaluator object to be used in our evaluate() function. More...

DtEvaluator *	evaluator ()

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. More...

virtual int	subExprCount () const
	Get the number of sub-expressions nested inside this expression. More...

virtual DtSimCondExpr *	subExpr (int index)
	Get a pointer to any particular sub-expression nested inside this expression. More...

virtual DtString	modifierStringRep (const DtString &) const
	Given the modifier string, come up with a human readable name for it. More...

virtual DtString	stringRep (int subExprIndex=DtSR_EXPR) const =0
	Get a readable string representation of this level of this expression. More...

DtString	stringRepFull () const
	Get a readable string representation of this full expression. More...

virtual char *	netRep ()

virtual int	netRepSize () const
	These 3 should become pure virtual functions. More...

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

virtual bool	setToNet ()

virtual const DtUUID &	simulationObject () const
	Static functions. More...

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

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. More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

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. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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. More...

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. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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. More...

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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. More...

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...

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. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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. More...

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. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSimCondExpr *	createCondExpr (DtlObjPtr mtlStream)
	Construct an empty conditional expression of the appropriate type. More...

static void	addCondExprCreatorFcn (const DtString &type, const int intType, DtCondExprCreatorFcn fcn)
	Adds a conditional expression creator member function to the conditional expression factory. More...

static void	setFactory (DtCondExprFactory *factory)

static DtCondExprFactory *	factory ()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

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

Protected Member Functions
virtual char *	createNetworkBuffer ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

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. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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

static bool	thePutIndent

static DtOutputStream *	theOutputStream

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

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

For those conditional expressions that can use a modifier for determining whether or not the conditional expression can apply to a pattern (DtCeCheckEntityIdentificationLevel, DtCeEntDestroyed, etc.) the pattern is defined as follows as a comma delimited text that must have the following format:

PATTERN,[ANY],[INVERT],<EXCLUDEDESTROYED|LOOKATALL>,[force number],[super type],[kind],[domain],[country],[category],[subcategory],[specific],[extra]

Once the keyword PATTERN is seen by the conditional expression it will know to look for the specific format supplied above to fill out the pattern match. Any item in a [] can be filled in or left blank. Any item in a <> must have one of the options selected.

If the keyword ANY is supplied it means that it will also apply to any subordinate of the entity this conditional is applied to also meets the requirement of the conditional If the keyword INVERT is supplied it means it will search for any pattern that is not the pattern specified If EXCLUDEDESTROYED is given destroyed objects will be excluded from the search Force number may be omitted to ignore force in a search. Examples:

Match only non-destroyed friendly M1A2s: PATTERN,,,EXCLUDEDESTROYED,1,1,1,1,225,1,1,3,0

Match all humans of any force: PATTERN,,,LOOKATALL,,1,3,-1,-1,-1,-1,-1,-1

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

pure virtual

virtual int DtSimCondExpr::type ( ) const

pure virtual

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

Implemented in DtCeResourceOperator, DtCeSimTime, DtCeConstant, DtCeNot, DtCeRandom, DtCeAltitude, DtCeReceiveTextMessage, DtCeEntDiGuyAppearance, DtCeSurrender, vrfAddConditionalExample::MyConditionalExpression, DtCeCheckEntityIdentificationLevel, DtCeEntDiGuyAnimation, DtCeEntEmbarkationStateChange, DtCeMissileApproachWarning, DtCeScenarioEvent, DtCeSimDateTime, DtCeSimTimeOfDay, DtCeBreached, DtCeEnvironmentalActive, DtCeAnd, DtCeEntDestroyed, DtCeEntHasTarget, DtCeEntInArea, DtCeEntLeftOfLine, DtCeEntUnderFire, DtCeOr, DtCeEntIndependentlyTasked, and DtCeEntityCreated.

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.

DtEvaluator* DtSimCondExpr::evaluator ( )

inline

virtual bool DtSimCondExpr::evaluate	(	const DtUUID &	object,
		DtSimManager *	simManager,
		const DtPlan *	= `0`
	)		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 DtCeNot, and DtLogicalOperatorCondition.

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 DtCeNot, and DtLogicalOperatorCondition.

virtual DtString DtSimCondExpr::modifierStringRep ( const DtString & ) const

virtual

Given the modifier string, come up with a human readable name for it.

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

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

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

inlinevirtual

virtual const DtUUID& DtSimCondExpr::simulationObject ( ) const

virtual

Static functions.

If there is a simulation object that has satisfied the requirement of this conditional expression it is returned from this statement. Calls down to evaluator to return the simulation object that was found during evaluation

static DtSimCondExpr* DtSimCondExpr::createCondExpr ( DtlObjPtr mtlStream )

static

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

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/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