DtCeSurrender Class Reference

class DtCeSurrender:

DtCeSurrender represents a boolean operator (true, false) test on a given entity's surrendered state. NOTE: Surrendered is valid for lifeforms only

Inheritance diagram for DtCeSurrender:

Public Member Functions
	DtCeSurrender ()
	DtCeSurrender (DtReaderWriterRegistry *parentRegistry)
	DtCeSurrender (const DtCeSurrender &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtCeSurrender ()
DtCeSurrender &	operator= (const DtCeSurrender &orig)
virtual DtSimCondExpr *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual int	type () const
virtual void	setEntity (const DtUUID &)
virtual const DtUUID &	entity () const
virtual void	setModifier (const DtString &arg)
virtual const DtString &	modifier () const
virtual void	setSurrenderTestValue (DtBoolean yesNo)
virtual DtBoolean	surrenderTestValue () 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
DtRwUUID	myEntity
DtRwString	myModifier
DtRwBoolean	mySurrenderVal
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

DtCeSurrender::DtCeSurrender

(

)

default constructor

DtCeSurrender::DtCeSurrender

(

DtReaderWriterRegistry *

parentRegistry

)

real constructor

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

copy constructor

virtual DtCeSurrender::~DtCeSurrender ( )

virtual

destructor

Member Function Documentation

DtCeSurrender& DtCeSurrender::operator=

(

const DtCeSurrender &

orig

)

assignment operator

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

virtual

clone operator

Implements DtSimCondExpr.

virtual int DtCeSurrender::type ( ) const

virtual

Returns DtCondExprAltitudeType (defined in condExprTypes.h).

Implements DtSimCondExpr.

virtual void DtCeSurrender::setEntity ( const DtUUID &  )

virtual

Set the entity. Was: setEntityName.

virtual const DtUUID& DtCeSurrender::entity ( ) const

virtual

Was: entityName.

virtual void DtCeSurrender::setModifier ( const DtString &  arg )

virtual

Set the test modifier. If it is an empty string, checks only the specified entity. If it is the string "ANY", checks all subordinate entities to see if any of them match the test, If it is neither of the above, it requires that all specified entities match.

virtual const DtString& DtCeSurrender::modifier ( ) const

virtual

virtual void DtCeSurrender::setSurrenderTestValue ( DtBoolean  yesNo )

virtual

Set the surrender value (either "true", "false") to test.

virtual DtBoolean DtCeSurrender::surrenderTestValue ( ) const

virtual

virtual DtString DtCeSurrender::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 DtCeSurrender 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 DtCeSurrender::netRepSize ( ) const

virtual

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

Reimplemented from DtSimCondExpr.

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

virtual

Fills in the expression from the network buffer.

Reimplemented from DtSimCondExpr.

virtual bool DtCeSurrender::setToNet ( )

virtual

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

Reimplemented from DtSimCondExpr.

static DtSimCondExpr* DtCeSurrender::creator ( )

static

Member Data Documentation

DtRwUUID DtCeSurrender::myEntity

protected

DtRwString DtCeSurrender::myModifier

protected

DtRwBoolean DtCeSurrender::mySurrenderVal

protected

---

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

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