DtStmtIndex Class Reference

class DtStmtIndex: More...

Public Member Functions
	DtStmtIndex ()
	Default constructor.
	DtStmtIndex (const DtSimStatement *statement)
	Casting constructor.
	DtStmtIndex (const DtSimStatement *statement, const DtPlan *plan)
	Construct an index of the statement in the given Plan that has the given statement's statementId.
	DtStmtIndex (int statementId, const DtPlan *plan)
	Construct an index of the statement in the given Plan that has the given statementId.
	DtStmtIndex (const DtStmtIndex &orig, const DtPlan *plan=NULL)
	Copy constructor.
virtual	~DtStmtIndex ()
	Destructor.
DtStmtIndex &	operator= (const DtStmtIndex &orig)
	Assignment operator.
bool	isSameStatementAs (const DtStmtIndex &stmt) const
bool	isSameStatementAs (DtSimStatement *stmt) const
virtual DtSimStatement *	statement () const
virtual void	setStatement (DtSimStatement *arg)
virtual const DtPlan *	plan () const
virtual void	setPlan (const DtPlan *arg)
virtual DtStmtIdType	statementId () const
virtual void	invalidatePointer ()
	Clears the statment pointer because it is no longer valid.
virtual bool	pointerIsInvalid () const
virtual void	setNull ()
	Make this statement index point nowhere (clears statement ptr and id).
virtual bool	isNull () const
	Does this statement index point nowhere (tests for id == 0)?
virtual int	taskExecutionId () const
virtual void	setTaskExecutionId (int v)

Protected Attributes
DtSimStatement *	myStatement
const DtPlan *	myPlan
DtStmtIdType	myStatementId
int	myTaskExecutionId

Detailed Description

class DtStmtIndex:

Instances of DtStmtIndex are smart pointers to DtSimStatement objects. They can access statements either by a direct pointer, or by a combination of a statementId number and a DtPlan pointer.

Constructor & Destructor Documentation

DtStmtIndex::DtStmtIndex

(

)

Default constructor.

DtStmtIndex::DtStmtIndex

(

const DtSimStatement *

statement

)

Casting constructor.

DtStmtIndex::DtStmtIndex	(	const DtSimStatement *	statement,
		const DtPlan *	plan
	)

Construct an index of the statement in the given Plan that has the given statement's statementId.

DtStmtIndex::DtStmtIndex	(	int	statementId,
		const DtPlan *	plan
	)

Construct an index of the statement in the given Plan that has the given statementId.

If statementId is not found in the Plan, pointerIsInvalid will be true.

DtStmtIndex::DtStmtIndex	(	const DtStmtIndex &	orig,
		const DtPlan *	plan = NULL
	)

Copy constructor.

virtual DtStmtIndex::~DtStmtIndex ( )

virtual

Destructor.

Member Function Documentation

DtStmtIndex& DtStmtIndex::operator=

(

const DtStmtIndex &

orig

)

Assignment operator.

bool DtStmtIndex::isSameStatementAs

(

const DtStmtIndex &

stmt

)

const

bool DtStmtIndex::isSameStatementAs

(

DtSimStatement *

stmt

)

const

virtual DtSimStatement* DtStmtIndex::statement ( ) const

virtual

virtual void DtStmtIndex::setStatement ( DtSimStatement *  arg )

virtual

virtual const DtPlan* DtStmtIndex::plan ( ) const

virtual

virtual void DtStmtIndex::setPlan ( const DtPlan *  arg )

virtual

virtual DtStmtIdType DtStmtIndex::statementId ( ) const

virtual

virtual void DtStmtIndex::invalidatePointer ( )

virtual

Clears the statment pointer because it is no longer valid.

Note: this DOES NOT clear myStatementId, and does not prevent the isSameStatementAs test from working.

virtual bool DtStmtIndex::pointerIsInvalid ( ) const

virtual

virtual void DtStmtIndex::setNull ( )

virtual

Make this statement index point nowhere (clears statement ptr and id).

virtual bool DtStmtIndex::isNull ( ) const

virtual

Does this statement index point nowhere (tests for id == 0)?

virtual int DtStmtIndex::taskExecutionId ( ) const

virtual

virtual void DtStmtIndex::setTaskExecutionId ( int  v )

virtual

Member Data Documentation

DtSimStatement* DtStmtIndex::myStatement

protected

const DtPlan* DtStmtIndex::myPlan

protected

DtStmtIdType DtStmtIndex::myStatementId

protected

int DtStmtIndex::myTaskExecutionId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfplan/stmtIndex.h