The DtCeResourceOperator class represents a relational comparison (for example, <, >) between a simulation object's resource value and a floating point constant. Each DtCeResourceOperator contains a:

Resource name string
Relational operator as a string
Real-number comparison value
Flag that indicates whether the comparison value is a percentage.

When the evaluate() function is called, the resource operator looks up the named resource in the localState() of the simulation object associated with the plan context.

If the percentFlag flag is true, the resource's percentageFull() value is used, otherwise the resource's amount() value is used. The resource value is then converted into a real number and compared to the specified comparison value, using the specified relational operator.

The supported operators are the same as in C++:

< (less than)
<= (less than or equal to)
== (equal to (= is also accepted))
!= (not equal to)
>= (greater than or equal to)
> (greater than).

The DtCeResourceOperator class is configured with the DtEvalResourceOp (evalResourceOp.h) evaluator.

Inheritance diagram for DtCeResourceOperator:

[legend]

Public Member Functions
	DtCeResourceOperator ()

	DtCeResourceOperator (DtReaderWriterRegistry *parentRegistry)

	DtCeResourceOperator (const DtCeResourceOperator &orig, DtReaderWriterRegistry *parentRegistry=NULL)

virtual	~DtCeResourceOperator ()

DtCeResourceOperator &	operator= (const DtCeResourceOperator &orig)

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

virtual int	type () const

virtual void	setResource (const DtString &resource)

virtual const DtString &	resource () const

virtual void	setOper (const DtString &arg)

virtual const DtString &	oper () const

virtual void	setComparisonValue (DtReal value)

virtual DtReal	comparisonValue () const

virtual void	setPercentFlag (bool arg)

virtual bool	percentFlag () const

virtual DtString	stringRep (int subExprIndex=DtSR_EXPR) const

virtual int	netRepSize () const

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

virtual bool	setToNet ()

Public Member Functions inherited from DtSimCondExpr
	DtSimCondExpr ()

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

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

virtual	~DtSimCondExpr ()

virtual bool	init ()

DtSimCondExpr &	operator= (const DtSimCondExpr &orig)

virtual void	setEvaluator (DtEvaluator *evaluator)

DtEvaluator *	evaluator ()

virtual bool	evaluate (DtLocalObject owner, const DtSimulationServices simManager, const DtPlan *=0) const

virtual int	subExprCount () const

virtual DtSimCondExpr *	subExpr (int index)

virtual DtString	modifierStringRep (const DtString &) const

DtString	stringRepFull () const

virtual char *	netRep ()

virtual const DtUUID &	simulationObject () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

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

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

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

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimCondExpr *	creator ()

Static Public Member Functions inherited from DtSimCondExpr
static DtSimCondExpr *	createCondExpr (DtlObjPtr mtlStream)

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

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

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

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)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwString	myResource

DtRwString	myOper

DtRwReal	myComparisonValue

DtRwBoolean	myPercentFlag

Protected Attributes inherited from DtSimCondExpr
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

bool	myInvalid

bool	myChangedFlag

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

Static Public Attributes inherited from DtSimCondExpr
static const int	DtSR_EXPR = -1

Protected Member Functions inherited from DtSimCondExpr
virtual char *	createNetworkBuffer ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtSimCondExpr
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

Constructor & Destructor Documentation

DtCeResourceOperator::DtCeResourceOperator ( )

default constructor

DtCeResourceOperator::DtCeResourceOperator ( DtReaderWriterRegistry * parentRegistry )

real constructor

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

copy constructor

virtual DtCeResourceOperator::~DtCeResourceOperator ( )

virtual

destructor

Member Function Documentation

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

assignment operator

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

virtual

clone operator

Implements DtSimCondExpr.

virtual int DtCeResourceOperator::type ( ) const

virtual

Returns DtCondExprResourceType (defined in condExprTypes.h).

Implements DtSimCondExpr.

virtual void DtCeResourceOperator::setResource ( const DtString & resource )

virtual

Set the resource to test.

virtual const DtString& DtCeResourceOperator::resource ( ) const

virtual

virtual void DtCeResourceOperator::setOper ( const DtString & arg )

virtual

Set the relational operator type ("<=" "<" "=" "!=" ">=" ">").

virtual const DtString& DtCeResourceOperator::oper ( ) const

virtual

virtual void DtCeResourceOperator::setComparisonValue ( DtReal value )

virtual

Set the comparison value.

virtual DtReal DtCeResourceOperator::comparisonValue ( ) const

virtual

virtual void DtCeResourceOperator::setPercentFlag ( bool arg )

virtual

Set the flag indicating that the comparison value is a percentage.

virtual bool DtCeResourceOperator::percentFlag ( ) const

virtual

virtual DtString DtCeResourceOperator::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 if this expression can have sub-expressions. Since a DtCeResourceOperator has no sub-expressions, it only returns a string representation if passed an index of DtSimCondExpr::DtSR_EXPR.

See the documentation for DtSimCondExpr::stringRep for more information.

Implements DtSimCondExpr.

virtual int DtCeResourceOperator::netRepSize ( ) const

virtual

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

Reimplemented from DtSimCondExpr.

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

virtual

Fills in the expression from the network buffer.

Reimplemented from DtSimCondExpr.

virtual bool DtCeResourceOperator::setToNet ( )

virtual

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

Reimplemented from DtSimCondExpr.

static DtSimCondExpr* DtCeResourceOperator::creator ( )

static

Member Data Documentation

DtRwString DtCeResourceOperator::myResource

protected

DtRwString DtCeResourceOperator::myOper

protected

aka myLeftValue

DtRwReal DtCeResourceOperator::myComparisonValue

protected

DtRwBoolean DtCeResourceOperator::myPercentFlag

protected

aka myRightValue

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/ceResourceOperator.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation