DtPlanBlock Class Reference

class DtPlanBlock: More...

Inheritance diagram for DtPlanBlock:

List of all members.

Public Member Functions
	DtPlanBlock (DtPlan *plan=NULL)
	default constructor
	DtPlanBlock (const DtString &name, DtPlan *plan=NULL, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtPlanBlock (const DtPlanBlock &orig)
	default copy constructor NOTE: this does a deep copy of the statements.
	DtPlanBlock (const DtString &name, const DtPlanBlock &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	better copy constructor NOTE: this does a deep copy of the statements.
virtual	~DtPlanBlock ()
	destructor
DtPlanBlock &	operator= (const DtPlanBlock &orig)
	assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones.
virtual DtSimBlock *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
	The normal clone function.
virtual DtPlan *	plan () const
	Get a pointer to the parent plan.
virtual void	setPlan (DtPlan *arg)
	Set the pointer to the parent plan.
virtual void	exitFromBlock (DtPlan &planContext)
	This function is called by the last statement in the block so that the block can do whatever is appropriate at the end of this block.
virtual bool	translateIndex (DtStmtIndex &stmtIndex) const
	If you have a DtStmtIndex object that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndex function to convert it to point into this Block.
Protected Attributes
DtPlan *	myPlan

---

Detailed Description

class DtPlanBlock:

Instances of DtPlanBlock represent top-level blocks of statements in Plans.

---

Constructor & Destructor Documentation

DtPlanBlock::DtPlanBlock

(

DtPlan *

plan = NULL

)

default constructor

DtPlanBlock::DtPlanBlock	(	const DtString &	name,
		DtPlan *	plan = NULL,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

DtPlanBlock::DtPlanBlock

(

const DtPlanBlock &

orig

)

default copy constructor NOTE: this does a deep copy of the statements.

DtPlanBlock::DtPlanBlock	(	const DtString &	name,
		const DtPlanBlock &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

better copy constructor NOTE: this does a deep copy of the statements.

virtual DtPlanBlock::~DtPlanBlock

(

)

[virtual]

destructor

---

Member Function Documentation

DtPlanBlock& DtPlanBlock::operator=

(

const DtPlanBlock &

orig

)

assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones.

virtual DtSimBlock* DtPlanBlock::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

The normal clone function.

Implements DtSimBlock.

virtual DtPlan* DtPlanBlock::plan

(

)

const [virtual]

Get a pointer to the parent plan.

virtual void DtPlanBlock::setPlan

(

DtPlan *

arg

)

[virtual]

Set the pointer to the parent plan.

virtual void DtPlanBlock::exitFromBlock

(

DtPlan &

planContext

)

[virtual]

This function is called by the last statement in the block so that the block can do whatever is appropriate at the end of this block.

For Plan blocks, this will Complete the parent DtPlan.

Implements DtSimBlock.

virtual bool DtPlanBlock::translateIndex

(

DtStmtIndex &

stmtIndex

)

const [virtual]

If you have a DtStmtIndex object that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndex function to convert it to point into this Block.

Returns true if a match was found, false otherwise.

Reimplemented from DtSimBlock.

---

Member Data Documentation

DtPlan* DtPlanBlock::myPlan [protected]

---

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

• include/vrfplan/planBlock.h