class DtIfStmt:

Instances of DtIfStmt represent a conditional ("If" statement). Currently, they can only have one condition, and one or two sub-Blocks ("Then" and "Else"), but in the future they might be extended to support multiple "ElseIf" conditions and sub-blocks as well.

Related Examples

Simple Plan Example

Inheritance diagram for DtIfStmt:

[legend]

Public Member Functions
	DtIfStmt (DtReaderWriterRegistry *parentRegistry=NULL)

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

virtual	~DtIfStmt () override

DtIfStmt &	operator= (const DtIfStmt &orig)

virtual DtSimStatement *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const override

virtual int	type () const override

virtual void	execute (DtPlan &planContext) override

virtual void	step (DtPlan &planContext, bool forceStep=false) override

virtual int	subBlockCount () const override

virtual DtSimBlock *	subBlock (int index) override

virtual DtString	stringRep (int subBlockIndex=DtSR_STMT) const override

virtual void	exitFromIf (DtPlan &planContext)

virtual const DtSimCondExpr *	condExpr () const override

virtual void	setCondExpr (const DtSimCondExpr *arg) override

virtual DtIfBlock *	thenBlock () const

virtual void	setThenBlock (DtIfBlock *arg)

virtual DtIfBlock *	elseBlock () const

virtual void	setElseBlock (DtIfBlock *arg)

virtual int	netRepSize () const override

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

virtual bool	setToNet () override

virtual void	upgradeTriggerUUID (const boost::unordered_map< DtUUID, DtUUID > &) override

virtual void	reset () override

Public Member Functions inherited from DtSimConditionalStatement
	DtSimConditionalStatement (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

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

virtual	~DtSimConditionalStatement () override

Public Member Functions inherited from DtSimStatement
	DtSimStatement ()

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

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

virtual	~DtSimStatement () override

virtual bool	init ()

DtSimStatement &	operator= (const DtSimStatement &orig)

virtual bool	validate ()

DtSimStatement *	nextStmt () const

DtSimStatement *	prevStmt () const

virtual DtStmtIdType	statementId () const

virtual void	setStatementId (DtStmtIdType arg)

virtual DtSimBlock *	parentBlock () const

virtual void	setParentBlock (DtSimBlock *arg)

virtual DtRecursiveSimStatementIterator *	spawnRecursiveIterator () const

virtual DtSimStatement *	lookupStatement (DtStmtIdType statementId)

virtual void	setStatementDescription (const DtString &)

virtual const DtString &	statementDescription () const

virtual char *	netRep ()

virtual bool	isSameStatement (DtSimStatement *)

Public Member Functions inherited from DtRwListedObj
	DtRwListedObj ()

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

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

	DtRwListedObj (const DtRwListedObj &orig)

virtual	~DtRwListedObj () override

DtRwListedObj &	operator= (const DtRwListedObj &orig)

DtRwListedObj *	next () const

DtRwListedObj *	prev () const

DtRwListedObj *	wrapNext () const

DtRwListedObj *	wrapPrev () const

virtual const char *	readerWriterType () const override

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

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 int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

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 DtSimStatement *	creator (DtReaderWriterRegistry *parentRegistry=NULL)

Static Public Member Functions inherited from DtSimStatement
static DtStmtIdType	generateNewStmtId ()

static DtSimStatement *	createStatement (DtlObjPtr mtlStream, DtReaderWriterRegistry *parentRegistry=NULL)

static DtSimStatement *	createStatement (int statementType, DtReaderWriterRegistry *parentRegistry=NULL)

static void	addStatementCreatorFcn (const DtString &type, int intType, DtStatementCreatorFcn fcn)

static void	setFactory (DtStatementFactory *factory)

static DtStatementFactory *	factory ()

static bool	getStatementNameFromStatementType (int statementType, DtString &statementName)

static bool	getStatementTypeFromStatementName (const DtString &statementName, int &statementType)

static bool	addStatementTypeMapping (const DtString &statementName, int taskType)

static bool	removeStatementTypeMapping (const DtString &statementName, int statementType)

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 Member Functions
virtual bool	compare (DtSimStatement *rhs) override

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

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

Protected Attributes
DtRwCondExpr	myCondExpr

bool	myResult

DtIfBlock *	myThenBlock

DtIfBlock *	myElseBlock

Protected Attributes inherited from DtSimStatement
DtStmtIdType	myStatementId

DtSimBlock *	myParentBlock

char *	myNetRep

DtRwString	myStatementDescription

Protected Attributes inherited from DtRwListedObj
DtList *	myList

DtListItem *	myItem

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 DtSimStatement
static const int	DtSR_STMT = -1

Static Protected Attributes inherited from DtSimStatement
static DtStatementFactory *	myFactory

static DtStringIntMapper	theStatementNameMapper

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

DtIfStmt::DtIfStmt ( DtReaderWriterRegistry * parentRegistry = NULL )

default constructor DtIfStmt();

Usual constructor

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

copy constructor

virtual DtIfStmt::~DtIfStmt ( )

overridevirtual

destructor

Member Function Documentation

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

assignment operator

virtual DtSimStatement* DtIfStmt::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const

overridevirtual

virtual copy constructor

Implements DtSimStatement.

virtual int DtIfStmt::type ( ) const

overridevirtual

Returns DtIfStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual void DtIfStmt::execute ( DtPlan & planContext )

overridevirtual

Execute the current statement and make any changes to the Plan state as appropriate.

Implements DtSimStatement.

virtual void DtIfStmt::step	(	DtPlan &	planContext,
		bool	forceStep = `false`
	)

overridevirtual

Steps to the next statement by setting the plan context�s current statement, based on the result of the test.

Reimplemented from DtSimStatement.

virtual int DtIfStmt::subBlockCount ( ) const

overridevirtual

Get the number of blocks nested inside this statement.

Reimplemented from DtSimStatement.

virtual DtSimBlock* DtIfStmt::subBlock ( int index )

overridevirtual

Get the a pointer to each particular block nested inside this statement.

Reimplemented from DtSimStatement.

virtual DtString DtIfStmt::stringRep ( int subBlockIndex = DtSR_STMT ) const

overridevirtual

Get a readable string representation of this If statement.

The subBlockIndex argument indicates which stringRep to get as a prefix for a given sub-block. For an If statement, the first (0) sub-block's prefix is the "if (...) then" part, if a second sub-block exists, its prefix is the "else" part, and if a subBlockIndex value of DtSimStatement::DtSR_STMT is given, the "endif" part is returned.

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

Implements DtSimStatement.

virtual void DtIfStmt::exitFromIf ( DtPlan & planContext )

virtual

The exitFromIf function is called when one of the the "If" blocks is complete, it just steps to the next statement after the If.

virtual const DtSimCondExpr* DtIfStmt::condExpr ( ) const

overridevirtual

Get/set the conditional expression.

Implements DtSimConditionalStatement.

virtual void DtIfStmt::setCondExpr ( const DtSimCondExpr * arg )

overridevirtual

Sets the conditional expression used to evaluate the wait until.

Implements DtSimConditionalStatement.

virtual DtIfBlock* DtIfStmt::thenBlock ( ) const

virtual

Get/set the then block.

virtual void DtIfStmt::setThenBlock ( DtIfBlock * arg )

virtual

virtual DtIfBlock* DtIfStmt::elseBlock ( ) const

virtual

Get/set the else block.

virtual void DtIfStmt::setElseBlock ( DtIfBlock * arg )

virtual

virtual int DtIfStmt::netRepSize ( ) const

overridevirtual

Returns the size of the full network representation padded to an 8-byte boundary. Size is computed from the following:

sizeof(DtNetSimStatement) + sizeof(DtNetIfStatement) + <myThenBlock->firstStmt()->netRepSize()> . . . <myThenBlock->lastStmt()->netRepSize()> <myElseBlock->firstStmt()->netRepSize()> . . . <myElseBlock->lastStmt()->netRepSize()>

Reimplemented from DtSimStatement.

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

overridevirtual

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtIfStmt::setToNet ( )

overridevirtual

Fills in the network buffer (created by base class sim statement) with the if statement contents. Network buffer is filled in as follows:

DtNetSimStatement DtNetIfStatment <myThenBlock->firstStmt()->netRep()> . . . <myThenBlock->lastStmt()->netRep()> <myElseBlock->firstStmt()->netRep()> . . . <myElseBlock->lastStmt()->netRep()>

Reimplemented from DtSimStatement.

virtual void DtIfStmt::upgradeTriggerUUID ( const boost::unordered_map< DtUUID, DtUUID > & )

overridevirtual

For those statements that need to, map from the old to new trigger UUID.

Reimplemented from DtSimStatement.

virtual void DtIfStmt::reset ( )

overridevirtual

Called when the plan is reset, will iterate over all statements to reset as well.

Reimplemented from DtSimStatement.

static DtSimStatement* DtIfStmt::creator ( DtReaderWriterRegistry * parentRegistry = NULL )

static

virtual bool DtIfStmt::compare ( DtSimStatement * )

overrideprotectedvirtual

Called from isSameStatement. Compares net reps to see if they are the same. Override to do different comparrison.

Reimplemented from DtSimStatement.

Member Data Documentation

DtRwCondExpr DtIfStmt::myCondExpr

protected

bool DtIfStmt::myResult

protected

myResult temporarily holds the results of an evaluation of myCondExpr between the "execute" call and the "step" call.

DtIfBlock* DtIfStmt::myThenBlock

protected

DtIfBlock* DtIfStmt::myElseBlock

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfplan/ifStmt.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation