Instances of DtPlanBlock represent top-level blocks of statements in Plans.

Inheritance diagram for DtPlanBlock:

Public Member Functions
	DtPlanBlock (DtPlan *plan=NULL)

	DtPlanBlock (const DtString &name, DtPlan plan=NULL, DtReaderWriterRegistry parentRegistry=NULL)

	DtPlanBlock (const DtPlanBlock &orig)

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

virtual	~DtPlanBlock ()

DtPlanBlock &	operator= (const DtPlanBlock &orig)

virtual DtSimBlock *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtPlan *	plan () const

virtual void	setPlan (DtPlan *arg)

virtual void	exitFromBlock (DtPlan &planContext)

virtual bool	translateIndex (DtStmtIndex &stmtIndex)

Public Member Functions inherited from DtSimBlock
	DtSimBlock (DtSimStatement *parentStatement)

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

	DtSimBlock (const DtSimBlock &orig)

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

virtual	~DtSimBlock ()

DtSimBlock &	operator= (const DtSimBlock &orig)

DtSimBlock *	clone () const

DtSimStatement *	firstStmt () const

DtSimStatement *	lastStmt () const

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

virtual void	translateIndices (DtList &stmtIndexList)

virtual DtSimStatement *	lookupStatement (DtStmtIdType statementId)

virtual DtRecursiveSimBlockIterator *	spawnRecursiveIterator () const

virtual bool	validate ()

virtual bool	isSameBlock (DtSimBlock *rhs)

void	setParentStatement (DtSimStatement *)

DtSimStatement *	parentStatement () const

virtual DtListItem *	addToList (DtRwListedObj data, DtRwListedObj after)

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

virtual void	reset ()

Public Member Functions inherited from DtRwIntrusiveList
	DtRwIntrusiveList ()

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

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

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

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

virtual	~DtRwIntrusiveList ()

DtRwIntrusiveList &	operator= (const DtRwIntrusiveList &orig)

DtRwListedObj *	firstObj () const

DtRwListedObj *	lastObj () const

DtListItem *	first () const

DtListItem *	last () const

unsigned	count () const

DtListItem *	add (DtRwListedObj *data)

DtListItem *	addToStart (DtRwListedObj *data)

DtListItem *	addToEnd (DtRwListedObj *data)

DtListItem *	addBefore (DtRwListedObj data, DtRwListedObj before)

DtListItem *	addAfter (DtRwListedObj data, DtRwListedObj after)

DtRwListedObj *	remove (DtRwListedObj *data)

virtual DtRwListedObj *	remove (DtListItem *item)

void	removeAndDelete (DtRwListedObj *data)

virtual void	removeAndDelete (DtListItem *item)

virtual void	removeAll ()

virtual void	removeAllAndDelete ()

DtListItem *	itemLookup (DtRwListedObj *data) const

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

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

virtual const char *	readerWriterType () 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	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	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

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

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)

Protected Attributes
DtPlan *	myPlan

Protected Attributes inherited from DtSimBlock
DtSimStatement *	myParentStatement

Protected Attributes inherited from DtRwIntrusiveList
DtList	myList

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 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 inherited from DtSimBlock
virtual void	cloneListFrom (const DtSimBlock &other)

Protected Member Functions inherited from DtRwIntrusiveList
	DtRwIntrusiveList (const DtRwIntrusiveList &orig)

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

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

DtPlanBlock::DtPlanBlock ( DtPlan * plan = NULL )

default constructor

DtPlanBlock::DtPlanBlock	(	const DtString &	name,
		DtPlan *	plan = `NULL`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

real constructor

DtPlanBlock::DtPlanBlock ( const DtPlanBlock & orig )

default copy constructor NOTE: this does a deep copy of the statements.

DtPlanBlock::DtPlanBlock	(	const DtString &	name,
		const DtPlanBlock &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

better copy constructor NOTE: this does a deep copy of the statements.

virtual DtPlanBlock::~DtPlanBlock ( )

virtual

destructor

Member Function Documentation

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

assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones.

virtual DtSimBlock* DtPlanBlock::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

The normal clone function.

Implements DtSimBlock.

virtual DtPlan* DtPlanBlock::plan ( ) const

virtual

Get a pointer to the parent plan.

virtual void DtPlanBlock::setPlan ( DtPlan * arg )

virtual

Set the pointer to the parent plan.

virtual void DtPlanBlock::exitFromBlock ( DtPlan & planContext )

virtual

This function is called by the last statement in the block so that the block can do whatever is appropriate at the end of this block. For Plan blocks, this will Complete the parent DtPlan.

Implements DtSimBlock.

virtual bool DtPlanBlock::translateIndex ( DtStmtIndex & stmtIndex )

virtual

If you have a DtStmtIndex object that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndex function to convert it to point into this Block. Returns true if a match was found, false otherwise.

Reimplemented from DtSimBlock.

Member Data Documentation

DtPlan* DtPlanBlock::myPlan

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfplan/planBlock.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation