DtPlanBlockBuilder Class Reference

class DtPlanBlockBuilder:

The DtPlanBlockBuilder class should not be created directly. Create the DtPlanBuilder class to create a plan. When adding blocks to a plan this class is returned and you can use this to continue adding plans to that conditional block.

Inheritance diagram for DtPlanBlockBuilder:

Public Types
typedef std::shared_ptr < DtPlanBlockBuilder >	SharedPlanBlockBuilder

Public Member Functions
	DtPlanBlockBuilder ()
	DtPlanBlockBuilder (DtSimBlock *)
virtual	~DtPlanBlockBuilder ()
virtual DtSimBlock *	planBlock ()
virtual void	addStatement (const DtSimTask &, bool addToStart=false)
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)
virtual void	addTaskCommand (const DtSimTask &, const DtUUID &, bool addToStart=false)
virtual void	addWaitUntilCondition (const DtSimCondExpr &, bool addToStart=false)
virtual void	addIfCondition (const DtSimCondExpr &, SharedPlanBlockBuilder &thenBlockBuilder, SharedPlanBlockBuilder &elseBlockBuilder, bool addToStart=false)
virtual SharedPlanBlockBuilder	addWhileCondition (const DtSimCondExpr &, bool addToStart=false)

Protected Attributes
DtSimBlock *	mySimBlock

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

Member Typedef Documentation

typedef std::shared_ptr<DtPlanBlockBuilder> DtPlanBlockBuilder::SharedPlanBlockBuilder

Constructor & Destructor Documentation

DtPlanBlockBuilder::DtPlanBlockBuilder

(

)

CTOR.

DtPlanBlockBuilder::DtPlanBlockBuilder

(

DtSimBlock *

)

virtual DtPlanBlockBuilder::~DtPlanBlockBuilder ( )

virtual

DTOR.

DtPlanBlockBuilder::DtPlanBlockBuilder ( const DtPlanBlockBuilder &  )

private

Member Function Documentation

virtual DtSimBlock* DtPlanBlockBuilder::planBlock ( )

virtual

Access to the block that this class represents.

virtual void DtPlanBlockBuilder::addStatement ( const DtSimTask &  , bool  addToStart = false  )

virtual

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 DtPlanBlockBuilder::addStatement ( const DtSetDataRequest &  , bool  addToStart = false  )

virtual

virtual void DtPlanBlockBuilder::addStatement ( const DtSimCommand &  , bool  addToStart = false  )

virtual

virtual void DtPlanBlockBuilder::addSetDataCommand ( const DtSetDataRequest &  , const DtUUID &  , bool  addToStart = false  )

virtual

Adds a new set data command to issue to the given object.

virtual void DtPlanBlockBuilder::addTaskCommand ( const DtSimTask &  , const DtUUID &  , bool  addToStart = false  )

virtual

Adds a new task to issue to the given object.

virtual void DtPlanBlockBuilder::addWaitUntilCondition ( const DtSimCondExpr &  , bool  addToStart = false  )

virtual

Creates a wait until conditional statement. No plan block builder is returned as the wait until does not execute any statements on completion.

virtual void DtPlanBlockBuilder::addIfCondition ( const DtSimCondExpr &  , SharedPlanBlockBuilder &  thenBlockBuilder, SharedPlanBlockBuilder &  elseBlockBuilder, bool  addToStart = false  )

virtual

Because an if conditional has 2 blocks (then and else) need to have two shared block pointers.

virtual SharedPlanBlockBuilder DtPlanBlockBuilder::addWhileCondition ( const DtSimCondExpr &  , bool  addToStart = false  )

virtual

Adds a while condition to the plan and returns a block builder for the block.

DtPlanBlockBuilder& DtPlanBlockBuilder::operator= ( const DtPlanBlockBuilder &  )

private

Member Data Documentation

DtSimBlock* DtPlanBlockBuilder::mySimBlock

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfplan/planBlockBuilder.h