DtSimCommandStmt Class Reference

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

Inheritance diagram for DtSimCommandStmt:

List of all members.

Public Member Functions
	DtSimCommandStmt (DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtSimCommandStmt (const DtSimCommandStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtSimCommandStmt ()
	destructor
DtSimCommandStmt &	operator= (const DtSimCommandStmt &orig)
	assignment operator
virtual DtSimStatement *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
	virtual copy constructor
virtual int	type () const
	Returns DtTaskStatementType (defined in simStmtTypes.h)
virtual void	execute (DtPlan &planContext)
	Execute the current statement and make any changes to the Plan state as appropriate.
virtual DtString	stringRep (int subBlockIndex=DtSR_STMT) const
	Get a readable string representation of this Task statement.
virtual DtSimCommand *	simCommand () const
	Get the current DtSimCommand.
virtual void	setSimCommand (DtSimCommand *arg)
	Set the DtSimCommand. This will clone() its own copy.
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Note: Task statements override putSelf and getSelf so that they can avoid an extra level of nesting in the save file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	DtReaderWriter member function that reads the task as if it were a statement object itself.
virtual int	netRepSize () const
	Returns the size of the full network representation.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the request from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class sim statement) with the set data request contents.
Static Public Member Functions
static DtSimStatement *	creator (DtReaderWriterRegistry *parentRegistry=NULL)
Protected Attributes
DtSimCommand *	mySimCommand

---

Detailed Description

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

---

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	(	FILE *	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 DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

DtReaderWriter member function that reads the task as if it were a statement object itself.

It calls DtSimCommand::createSimCommand().

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]

---

Member Data Documentation

DtSimCommand* DtSimCommandStmt::mySimCommand [protected]

---

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

• include/vrfplan/simCommandStmt.h