DtPlanBuilder Class Reference

class DtPlanBlockBuilder: More...

Inheritance diagram for DtPlanBuilder:

Public Member Functions
	DtPlanBuilder ()
	CTOR.
	DtPlanBuilder (const DtString &planName)
	DtPlanBuilder (const DtUUID &planName)
virtual	~DtPlanBuilder ()
	DTOR.
virtual void	setPlanName (const DtString &)
	Sets the name of the plan.
virtual void	setPlanName (const DtUUID &)
virtual const DtPlan &	plan () const
	Returns the plan in it's current state.
virtual DtPlan *	planCopy () const
	Returns a copy of the plan. This pointer must be deleted if no longer needed.
	operator const DtPlan & () const
virtual SharedPlanBlockBuilder	addTriggerStatement (const DtSimCondExpr &, DtUUID &triggerUUID, const DtString &description="", bool reregister=true, const DtString &option="ReTask", bool addToStart=false)
	Add a new trigger statement and register it at the current plan position.
Public Member Functions inherited from DtPlanBlockBuilder
	DtPlanBlockBuilder ()
	CTOR.
	DtPlanBlockBuilder (DtSimBlock *)
virtual	~DtPlanBlockBuilder ()
	DTOR.
virtual DtSimBlock *	planBlock ()
	Access to the block that this class represents.
virtual void	addStatement (const DtSimTask &, bool addToStart=false)
	Add a statement to the current block. The statement is added to the start if the flag is true, else the end of the block.
virtual void	addStatement (const DtSetDataRequest &, bool addToStart=false)
virtual void	addStatement (const DtSimCommand &, bool addToStart=false)
virtual void	addSetDataCommand (const DtSetDataRequest &, const DtUUID &, bool addToStart=false)
	Adds a new set data command to issue to the given object.
virtual void	addTaskCommand (const DtSimTask &, const DtUUID &, bool addToStart=false)
	Adds a new task to issue to the given object.
virtual void	addWaitUntilCondition (const DtSimCondExpr &, bool addToStart=false)
	Creates a wait until conditional statement.
virtual void	addIfCondition (const DtSimCondExpr &, SharedPlanBlockBuilder &thenBlockBuilder, SharedPlanBlockBuilder &elseBlockBuilder, bool addToStart=false)
	Because an if conditional has 2 blocks (then and else) need to have two shared block pointers.
virtual SharedPlanBlockBuilder	addWhileCondition (const DtSimCondExpr &, bool addToStart=false)
	Adds a while condition to the plan and returns a block builder for the block.

Protected Attributes
DtPlan	myPlan
Protected Attributes inherited from DtPlanBlockBuilder
DtSimBlock *	mySimBlock

Private Member Functions
	DtPlanBuilder (const DtPlanBuilder &)
DtPlanBuilder &	operator= (const DtPlanBuilder &)

Additional Inherited Members
Public Types inherited from DtPlanBlockBuilder
typedef boost::shared_ptr < DtPlanBlockBuilder >	SharedPlanBlockBuilder

Detailed Description

class DtPlanBlockBuilder:

This helper class will allow for the creation of a plan by adding task, set and conditional statements to it. The plan() method will return the current state of the plan being created

Constructor & Destructor Documentation

DtPlanBuilder::DtPlanBuilder

(

)

CTOR.

DtPlanBuilder::DtPlanBuilder

(

const DtString &

planName

)

DtPlanBuilder::DtPlanBuilder

(

const DtUUID &

planName

)

virtual DtPlanBuilder::~DtPlanBuilder ( )

virtual

DTOR.

DtPlanBuilder::DtPlanBuilder ( const DtPlanBuilder &  )

private

Member Function Documentation

virtual void DtPlanBuilder::setPlanName ( const DtString &  )

virtual

Sets the name of the plan.

virtual void DtPlanBuilder::setPlanName ( const DtUUID &  )

virtual

virtual const DtPlan& DtPlanBuilder::plan ( ) const

virtual

Returns the plan in it's current state.

virtual DtPlan* DtPlanBuilder::planCopy ( ) const

virtual

Returns a copy of the plan. This pointer must be deleted if no longer needed.

DtPlanBuilder::operator const DtPlan & ( ) const

inline

virtual SharedPlanBlockBuilder DtPlanBuilder::addTriggerStatement ( const DtSimCondExpr &  , DtUUID &  triggerUUID, const DtString &  description = "", bool  reregister = true, const DtString &  option = "ReTask", bool  addToStart = false  )

virtual

Add a new trigger statement and register it at the current plan position.

Returns the shared block builder and the UUID of the new trigger than can be used in a future register. The optional flags are the common options used. See triggerStmt.h (DtTriggetStmt) for more information

DtPlanBuilder& DtPlanBuilder::operator= ( const DtPlanBuilder &  )

private

Member Data Documentation

DtPlan DtPlanBuilder::myPlan

protected

---

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

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