VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Private Member Functions
DtPlanMessageBuilder Class Reference

class DtPlanMessageBuilder: More...

Inheritance diagram for DtPlanMessageBuilder:
Inheritance graph
[legend]

Public Member Functions

 DtPlanMessageBuilder ()
 default constructor
 DtPlanMessageBuilder (const DtString &planName)
 DtPlanMessageBuilder (const DtUUID &planName)
virtual ~DtPlanMessageBuilder ()
 destructor
virtual DtIfPlan planMessage (bool isAssigned=true, bool isGlobal=false)
 Returns the plan message given the specified arguments.
- Public Member Functions inherited from DtPlanBuilder
 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 DtPlanplan () const
 Returns the plan in it's current state.
virtual DtPlanplanCopy () 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 DtSimBlockplanBlock ()
 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.

Private Member Functions

 DtPlanMessageBuilder (const DtPlanMessageBuilder &orig)
 copy constructor
DtPlanMessageBuilderoperator= (const DtPlanMessageBuilder &orig)
 assignment operator

Additional Inherited Members

- Public Types inherited from DtPlanBlockBuilder
typedef boost::shared_ptr
< DtPlanBlockBuilder
SharedPlanBlockBuilder
- Protected Attributes inherited from DtPlanBuilder
DtPlan myPlan

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:

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)