Inheritance diagram for DtPlanMessageBuilder:

Public Member Functions
	DtPlanMessageBuilder ()
	default constructor More...

	DtPlanMessageBuilder (const DtString &planName)

	DtPlanMessageBuilder (const DtUUID &planName)

virtual	~DtPlanMessageBuilder ()
	destructor More...

virtual DtIfPlan	planMessage (bool isAssigned=true, bool isGlobal=false)
	Returns the plan message given the specified arguments. More...

Public Member Functions inherited from DtPlanBuilder
	DtPlanBuilder ()
	CTOR. More...

	DtPlanBuilder (const DtString &planName)

	DtPlanBuilder (const DtUUID &planName)

virtual	~DtPlanBuilder ()
	DTOR. More...

virtual void	setPlanName (const DtString &)
	Sets the name of the plan. More...

virtual void	setPlanName (const DtUUID &)

virtual const DtPlan &	plan () const
	Returns the plan in it's current state. More...

virtual DtPlan *	planCopy () const
	Returns a copy of the plan. This pointer must be deleted if no longer needed. More...

	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. More...

Public Member Functions inherited from DtPlanBlockBuilder
	DtPlanBlockBuilder ()
	CTOR. More...

	DtPlanBlockBuilder (DtSimBlock *)

virtual	~DtPlanBlockBuilder ()
	DTOR. More...

virtual DtSimBlock *	planBlock ()
	Access to the block that this class represents. More...

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. More...

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. More...

virtual void	addTaskCommand (const DtSimTask &, const DtUUID &, bool addToStart=false)
	Adds a new task to issue to the given object. More...

virtual void	addWaitUntilCondition (const DtSimCondExpr &, bool addToStart=false)
	Creates a wait until conditional statement. More...

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. More...

virtual SharedPlanBlockBuilder	addWhileCondition (const DtSimCondExpr &, bool addToStart=false)
	Adds a while condition to the plan and returns a block builder for the block. More...

Private Member Functions
	DtPlanMessageBuilder (const DtPlanMessageBuilder &orig)
	copy constructor More...

DtPlanMessageBuilder &	operator= (const DtPlanMessageBuilder &orig)
	assignment operator More...

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

Protected Attributes inherited from DtPlanBuilder
DtPlan	myPlan

Protected Attributes inherited from DtPlanBlockBuilder
DtSimBlock *	mySimBlock

Detailed Description

class DtPlanMessageBuilder:

A version of the plan builder that can be used to return a DtifPlan object from the plan

Constructor & Destructor Documentation

DtPlanMessageBuilder::DtPlanMessageBuilder ( )

default constructor

DtPlanMessageBuilder::DtPlanMessageBuilder ( const DtString & planName )

DtPlanMessageBuilder::DtPlanMessageBuilder ( const DtUUID & planName )

virtual DtPlanMessageBuilder::~DtPlanMessageBuilder ( )

virtual

destructor

DtPlanMessageBuilder::DtPlanMessageBuilder ( const DtPlanMessageBuilder & orig )

private

copy constructor

Member Function Documentation

virtual DtIfPlan DtPlanMessageBuilder::planMessage	(	bool	isAssigned = `true`,
		bool	isGlobal = `false`
	)

virtual

Returns the plan message given the specified arguments.

DtPlanMessageBuilder& DtPlanMessageBuilder::operator= ( const DtPlanMessageBuilder & orig )

private

assignment operator

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfmsgs/planMessageBuilder.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation