DtTaskStmt Class Reference

Instances of DtTaskStmt represent a single task command. More...

Inheritance diagram for DtTaskStmt:

List of all members.

Public Member Functions
	DtTaskStmt (DtReaderWriterRegistry *parentRegistry=NULL)
	default constructor DtTaskStmt();
	DtTaskStmt (const DtTaskStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtTaskStmt ()
	destructor
DtTaskStmt &	operator= (const DtTaskStmt &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 DtSimTask *	task () const
	Get the current Task.
virtual void	setTask (DtSimTask *arg)
	Set the Task (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 task contents.
Static Public Member Functions
static DtSimStatement *	creator (DtReaderWriterRegistry *parentRegistry=NULL)
Protected Attributes
DtSimTask *	myTask

---

Detailed Description

Instances of DtTaskStmt represent a single task command.

---

Constructor & Destructor Documentation

DtTaskStmt::DtTaskStmt

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

default constructor DtTaskStmt();

Usual constructor

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

copy constructor

virtual DtTaskStmt::~DtTaskStmt

(

)

[virtual]

destructor

---

Member Function Documentation

DtTaskStmt& DtTaskStmt::operator=

(

const DtTaskStmt &

orig

)

assignment operator

virtual DtSimStatement* DtTaskStmt::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

virtual copy constructor

Implements DtSimStatement.

virtual int DtTaskStmt::type

(

)

const [virtual]

Returns DtTaskStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual void DtTaskStmt::execute

(

DtPlan &

planContext

)

[virtual]

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

Implements DtSimStatement.

virtual DtString DtTaskStmt::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 DtSimTask* DtTaskStmt::task

(

)

const [virtual]

Get the current Task.

virtual void DtTaskStmt::setTask

(

DtSimTask *

arg

)

[virtual]

Set the Task (this will clone() its own copy).

virtual void DtTaskStmt::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 task as if it were a statement object itself. It calls DtSimTask::putself().

Reimplemented from DtReaderWriter.

virtual void DtTaskStmt::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 DtSimTask::createTask().

virtual int DtTaskStmt::netRepSize

(

)

const [virtual]

Returns the size of the full network representation.

Reimplemented from DtSimStatement.

virtual bool DtTaskStmt::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtTaskStmt::setToNet

(

)

[virtual]

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

Reimplemented from DtSimStatement.

static DtSimStatement* DtTaskStmt::creator

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

[static]

---

Member Data Documentation

DtSimTask* DtTaskStmt::myTask [protected]

---

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

• include/vrfplan/taskStmt.h