Instances of DtSimCommandStmt represent a single sim-command in a DtPlan.

Inheritance diagram for DtSimCommandStmt:

Public Member Functions
	DtSimCommandStmt (DtReaderWriterRegistry *parentRegistry=NULL)

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

virtual	~DtSimCommandStmt ()

DtSimCommandStmt &	operator= (const DtSimCommandStmt &orig)

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

virtual int	type () const

virtual void	execute (DtPlan &planContext)

virtual DtString	stringRep (int subBlockIndex=DtSR_STMT) const

virtual DtSimCommand *	simCommand () const

virtual void	setSimCommand (DtSimCommand *arg)

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

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

virtual int	netRepSize () const

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

virtual bool	setToNet ()

virtual void	step (DtPlan &planContext, bool forceStep)

Public Member Functions inherited from DtSimStatement
	DtSimStatement ()

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

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

virtual	~DtSimStatement ()

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

virtual DtSimBlock *	subBlock (int index)

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

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

virtual void	reset ()

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

DtRwListedObj &	operator= (const DtRwListedObj &orig)

DtRwListedObj *	next () const

DtRwListedObj *	prev () const

DtRwListedObj *	wrapNext () const

DtRwListedObj *	wrapPrev () const

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

virtual	~DtReaderWriter ()

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	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 Attributes
DtSimCommand *	mySimCommand

DtSimCommandContextPtr	myCommandCompletionData

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

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

virtual bool	compare (DtSimStatement *)

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

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

DtSimCommandStmt::DtSimCommandStmt ( DtReaderWriterRegistry * parentRegistry = NULL )

Usual constructor.

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

copy constructor

virtual DtSimCommandStmt::~DtSimCommandStmt ( )

virtual

destructor

Member Function Documentation

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

assignment operator

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

virtual

virtual copy constructor

Implements DtSimStatement.

virtual int DtSimCommandStmt::type ( ) const

virtual

Returns DtTaskStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual void DtSimCommandStmt::execute ( DtPlan & planContext )

virtual

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

Implements DtSimStatement.

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

virtual

Get a readable string representation of this Task statement.

The subBlockIndex argument indicates which stringRep to get if this statement could have sub-blocks. Since a Task statement cannot have sub-blocks, a useful string representation will only be returned if the subBlockIndex argument has the value DtSimStatement::DtSR_STMT. See the documentation for DtSimStatement::stringRep for more details.

Implements DtSimStatement.

virtual DtSimCommand* DtSimCommandStmt::simCommand ( ) const

virtual

Get the current DtSimCommand.

virtual void DtSimCommandStmt::setSimCommand ( DtSimCommand * arg )

virtual

Set the DtSimCommand. This will clone() its own copy.

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

virtual

Note: Task statements override putSelf and getSelf so that they can avoid an extra level of nesting in the save file. DtReaderWriter member function that writes the command as if it were a statement object itself. It calls DtSimTask::putself().

Reimplemented from DtReaderWriter.

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

virtual

DtReaderWriter member function that reads the task as if it were a statement object itself. It calls DtSimCommand::createSimCommand().

Reimplemented from DtReaderWriter.

virtual int DtSimCommandStmt::netRepSize ( ) const

virtual

Returns the size of the full network representation.

Reimplemented from DtSimStatement.

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

virtual

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtSimCommandStmt::setToNet ( )

virtual

Fills in the network buffer (created by base class sim statement) with the set data request contents.

Reimplemented from DtSimStatement.

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

static

virtual void DtSimCommandStmt::step	(	DtPlan &	planContext,
		bool	forceStep
	)

virtual

See if the statement is complete and this command can step to the next statement. An example of a command that might not be complete is a create statement that is waiting for data to page in.

Reimplemented from DtSimStatement.

Member Data Documentation

DtSimCommand* DtSimCommandStmt::mySimCommand

protected

DtSimCommandContextPtr DtSimCommandStmt::myCommandCompletionData

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation