DtSetDataRequestStmt Class Reference

Instances of DtSetDataRequestStmt represent a single Set command. More...

Inheritance diagram for DtSetDataRequestStmt:

List of all members.

Public Member Functions
	DtSetDataRequestStmt (DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtSetDataRequestStmt (const DtSetDataRequestStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtSetDataRequestStmt ()
	destructor
DtSetDataRequestStmt &	operator= (const DtSetDataRequestStmt &orig)
	assignment operator
virtual DtSimStatement *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
	virtual copy constructor
virtual int	type () const
	Returns DtSetDataStatementType (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 Set statement.
virtual DtSetDataRequest *	setDataRequest () const
	Get the current Set Data Request.
virtual void	setSetDataRequest (DtSetDataRequest *arg)
	Set the Set Data Request (this will clone() its own copy).
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Note: Set 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 Set Data Request 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
DtSetDataRequest *	mySetDataRequest

---

Detailed Description

Instances of DtSetDataRequestStmt represent a single Set command.

---

Constructor & Destructor Documentation

DtSetDataRequestStmt::DtSetDataRequestStmt

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

Usual constructor.

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

copy constructor

virtual DtSetDataRequestStmt::~DtSetDataRequestStmt

(

)

[virtual]

destructor

---

Member Function Documentation

DtSetDataRequestStmt& DtSetDataRequestStmt::operator=

(

const DtSetDataRequestStmt &

orig

)

assignment operator

virtual DtSimStatement* DtSetDataRequestStmt::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

virtual copy constructor

Implements DtSimStatement.

virtual int DtSetDataRequestStmt::type

(

)

const [virtual]

Returns DtSetDataStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual void DtSetDataRequestStmt::execute

(

DtPlan &

planContext

)

[virtual]

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

Implements DtSimStatement.

virtual DtString DtSetDataRequestStmt::stringRep

(

int

subBlockIndex = DtSR_STMT

)

const [virtual]

Get a readable string representation of this Set statement.

The subBlockIndex argument indicates which stringRep to get if this statement could have sub-blocks. Since a Set 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 DtSetDataRequest* DtSetDataRequestStmt::setDataRequest

(

)

const [virtual]

Get the current Set Data Request.

virtual void DtSetDataRequestStmt::setSetDataRequest

(

DtSetDataRequest *

arg

)

[virtual]

Set the Set Data Request (this will clone() its own copy).

virtual void DtSetDataRequestStmt::putSelf	(	FILE *	fp,
		int	indentLevel = 0,
		bool	writeUnspecified = false,
		const DtFilename &	path = DtReaderWriter::appPath()
	)		[virtual]

Note: Set 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 Set Data Request as if it were a statement object itself. It calls DtSetDataRequest::putself().

Reimplemented from DtReaderWriter.

virtual void DtSetDataRequestStmt::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

DtReaderWriter member function that reads the Set Data Request as if it were a statement object itself.

It calls DtSetDataRequest::createTask().

virtual int DtSetDataRequestStmt::netRepSize

(

)

const [virtual]

Returns the size of the full network representation.

Reimplemented from DtSimStatement.

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

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtSetDataRequestStmt::setToNet

(

)

[virtual]

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

Reimplemented from DtSimStatement.

static DtSimStatement* DtSetDataRequestStmt::creator

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

[static]

---

Member Data Documentation

DtSetDataRequest* DtSetDataRequestStmt::mySetDataRequest [protected]

---

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

• include/vrfplan/setStmt.h