class DtIfPlan:

Instances of DtIfPlan are the content portions of a plan message. This message contains enough information to reconstruct a DtPlan, minus the the content of the actual statements. The message is intended to be used with DtPlanStatement messages, which convey the rest of the content needed to fully represent the plan.

Content-Type: DtSetPlanMessageType

statement count: The number of DtSimStatements contained in this message.

plan statements: A list of <statement count>=""> DtSimStatements in this message. Statements should be appended to the plan�s main block in the order they appear in the message. If the plan is large enough to require multiple messages, then the messages should be processed in the order they are received, further appending to the statements to received in earlier DtPlan messages. DtNetIfPlan is the FIXED portion of the simulation network representation of a plan message, padded to an 8 byte boundary.

Fixed portion is immediately followed by:

where n is myStatementCount.

Statements are top-level statements, added in the order they appear in the plan. Individual statements may contain nested statements (e.g. for 'If/else/then' and 'When' statements).

Inheritance diagram for DtIfPlan:

[legend]

Public Member Functions
	DtIfPlan ()

virtual	~DtIfPlan ()

	DtIfPlan (const DtIfPlan &orig)

DtIfPlan &	operator= (const DtIfPlan &orig)

virtual int	type () const

virtual DtSimInterfaceContent *	clone () const

virtual const DtUUID &	planName () const

virtual void	setPlanName (const DtUUID &name)

virtual DtString	markingText () const

virtual bool	addStatement (const DtSimStatement &statement)

virtual const std::vector < DtSimStatement * > &	statements () const

virtual const DtRwTriggersList &	triggers () const

virtual void	addTrigger (const DtTriggerStmt &)

virtual void	setTriggers (const DtRwTriggersList &)

virtual void	setVariables (const DtRwVariableBindings &)

const DtRwVariableBindings &	variables () const

DtRwVariableBindings &	variables ()

virtual void	setAssign (bool flag)

virtual bool	assign () const

virtual int	netRepSize () const

virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)

virtual bool	setToNet ()

virtual void	printDataToString (DtString &str)

void	emptyStatementList ()

virtual bool	isSamePlan (DtIfPlan *rhs)

virtual void	setPlanFromMessage (DtPlan &plan) const

virtual void	upgradeTriggerUUIDs ()


virtual bool	isGlobal () const

virtual void	setIsGlobal (bool yesNo)


virtual void	setIsQuickLaunch (bool)

virtual bool	isQuickLaunch () const

virtual void	setShowOnQuickLaunchToolbar (bool)

virtual bool	showOnQuickLaunchToolbar () const

virtual void	setQuickLaunchIcon (const DtString &)

virtual const DtString &	quickLaunchIcon () const

virtual void	setOrdinal (int)

virtual int	ordinal () const

virtual void	setPlanSummary (const DtString &)

virtual const DtString &	planSummary () const

Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()

virtual bool	update (const DtSimInterfaceContent *data)

virtual char *	netRep ()

virtual void	printContentType (DtString &str)

virtual void	setUseSessionId (bool yesNo)

virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)

static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)

static void	setFactory (DtInterfaceContentFactory *factory)

static DtInterfaceContentFactory *	factory ()

static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Member Functions
void	copyStatementList (const std::vector< DtSimStatement * > &otherList)

Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()

	DtSimInterfaceContent (const DtSimInterfaceContent &orig)

const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)

virtual char *	createNetworkBuffer ()

Protected Attributes
DtUUID	myPlanName

std::vector< DtSimStatement * >	myStatementList

bool	myAppendFlag

bool	myAssignFlag

bool	myIsGlobal

DtU32	myQuickLaunchFlags

DtU32	myOrdinal

DtString	myQuickLaunchIcon

DtString	myPlanSummary

DtRwTriggersList	myTriggers

DtRwVariableBindings	myVariables

Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep

bool	myUseSessionId

Additional Inherited Members
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory

static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfPlan::DtIfPlan ( )

default constructor

virtual DtIfPlan::~DtIfPlan ( )

virtual

destructor

DtIfPlan::DtIfPlan ( const DtIfPlan & orig )

copy constructor

Member Function Documentation

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

assignment operator

virtual int DtIfPlan::type ( ) const

virtual

Returns the type of Interface Content.

Implements DtSimInterfaceContent.

Reimplemented in DtIfMultiplePlanSet, and DtIfSyncMatrixPlan.

virtual DtSimInterfaceContent* DtIfPlan::clone ( ) const

virtual

Implements DtSimInterfaceContent.

Reimplemented in DtIfMultiplePlanSet, and DtIfSyncMatrixPlan.

virtual const DtUUID& DtIfPlan::planName ( ) const

virtual

Set/get the uuid of the plan. Set the uuid before adding statements, to make sure we don't exceed the size of net rep. The net rep size is checked when statements are being added, but not when the name is being set. Was: name.

virtual void DtIfPlan::setPlanName ( const DtUUID & name )

virtual

Was: setName.

Reimplemented in DtIfMultiplePlanSet.

virtual DtString DtIfPlan::markingText ( ) const

virtual

Reimplemented in DtIfMultiplePlanSet.

virtual bool DtIfPlan::isGlobal ( ) const

virtual

Indicates whether this plan is a global plan or an individual entity plan.

virtual void DtIfPlan::setIsGlobal ( bool yesNo )

virtual

Indicates whether this plan is a global plan or an individual entity plan.

virtual bool DtIfPlan::addStatement ( const DtSimStatement & statement )

virtual

Add a statement to the message. If statement cannot be added to message (i.e. it is too large), return false. Statement should be a top-level statement in the plan (statements in the main block of plan statements). Statements should be added in the order they appear in the main plan block. If addStatement returns false, you have exceeded the maximum size permitted for the PDU. Create a new next plan message and append the statement to that one.

virtual const std::vector<DtSimStatement*>& DtIfPlan::statements ( ) const

virtual

Get the list of statements in the message.

virtual const DtRwTriggersList& DtIfPlan::triggers ( ) const

virtual

Get a list of triggers for this plan.

virtual void DtIfPlan::addTrigger ( const DtTriggerStmt & )

virtual

Adds a new trigger to this plan.

virtual void DtIfPlan::setTriggers ( const DtRwTriggersList & )

virtual

Sets triggers to be the triggers list.

virtual void DtIfPlan::setVariables ( const DtRwVariableBindings & )

virtual

Variables used in this plan.

const DtRwVariableBindings& DtIfPlan::variables ( ) const

inline

DtRwVariableBindings& DtIfPlan::variables ( )

inline

virtual void DtIfPlan::setAssign ( bool flag )

virtual

Set/get the assign flag. If assign is true, the object's current plan should be replaced/appended by the statements in this message. Otherwise, this message represents the object's current plan (and has been sent in response to a 'request plan' message).

virtual bool DtIfPlan::assign ( ) const

virtual

virtual int DtIfPlan::netRepSize ( ) const

virtual

Get the list of statements in the message. Statement returns the size of the full network representation (control object name included) padded to an 8-byte boundary.

Reimplemented from DtSimInterfaceContent.

Reimplemented in DtIfMultiplePlanSet, and DtIfSyncMatrixPlan.

virtual bool DtIfPlan::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)

virtual

Fills in the task from the network buffer.

Reimplemented from DtSimInterfaceContent.

Reimplemented in DtIfMultiplePlanSet, and DtIfSyncMatrixPlan.

virtual bool DtIfPlan::setToNet ( )

virtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSimInterfaceContent.

Reimplemented in DtIfMultiplePlanSet, and DtIfSyncMatrixPlan.

virtual void DtIfPlan::printDataToString ( DtString & str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfPlan::creator ( )

static

void DtIfPlan::emptyStatementList ( )

Empty contents of our statement list. Deletes the DtSimStatement* data items in the list. Non-virtual because it is called from constructors.

virtual bool DtIfPlan::isSamePlan ( DtIfPlan * rhs )

virtual

Returns true if the plans are equivalent. The equivalnece test DOES NOT look at variables.

virtual void DtIfPlan::setIsQuickLaunch ( bool )

virtual