DtIfMultiplePlanSet Class Reference

class DtIfMultiplePlanSet:

Instances of DtIfMultiplePlanSet 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. This message is equivalent to DtIfPlan, except it stores a list of entities

Content-Type: DtMultiplePlanSetMessageType

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.

append flag: bool flag indicating the plan message should be appended to an existing plan. This is used when a plan is large enough to require multiple messages. The first message should have this flag set to false. Subsequent messages should set this flag to true. DtNetIfMultiplePlanSet 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:

<net rep of a DtSimStatement 1 (already padded to 8 byte boundary)> <net rep of a DtSimStatement n (already padded to 8 byte boundary)>

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). Append flag indicates if message is intended for appending an existing plan (as opposed to creating a new plan). Append flag is false by default.

Inheritance diagram for DtIfMultiplePlanSet:

Public Member Functions
	DtIfMultiplePlanSet ()
virtual	~DtIfMultiplePlanSet ()
	DtIfMultiplePlanSet (const DtIfMultiplePlanSet &orig)
DtIfMultiplePlanSet &	operator= (const DtIfMultiplePlanSet &orig)
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual void	setEntities (const std::vector< DtUUID > &)
virtual const std::vector < DtUUID > &	entities () const
virtual void	setPlanName (const DtUUID &name)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual DtString	markingText () const
Public Member Functions inherited from DtIfPlan
	DtIfPlan ()
virtual	~DtIfPlan ()
	DtIfPlan (const DtIfPlan &orig)
DtIfPlan &	operator= (const DtIfPlan &orig)
virtual const DtUUID &	planName () 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 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 DtIfPlan
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 Attributes
std::vector< DtUUID >	myEntities
bool	myUUIDSet
Protected Attributes inherited from DtIfPlan
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
Protected Member Functions inherited from DtIfPlan
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 ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfMultiplePlanSet::DtIfMultiplePlanSet

(

)

default constructor

virtual DtIfMultiplePlanSet::~DtIfMultiplePlanSet ( )

virtual

destructor

DtIfMultiplePlanSet::DtIfMultiplePlanSet

(

const DtIfMultiplePlanSet &

orig

)

copy constructor

Member Function Documentation

DtIfMultiplePlanSet& DtIfMultiplePlanSet::operator=

(

const DtIfMultiplePlanSet &

orig

)

assignment operator

virtual int DtIfMultiplePlanSet::type ( ) const

virtual

Returns the type of Interface Content.

Reimplemented from DtIfPlan.

virtual DtSimInterfaceContent* DtIfMultiplePlanSet::clone ( ) const

virtual

Reimplemented from DtIfPlan.

virtual void DtIfMultiplePlanSet::setEntities ( const std::vector< DtUUID > &  )

virtual

Get/set entities that this plan should be assigned to.

virtual const std::vector<DtUUID>& DtIfMultiplePlanSet::entities ( ) const

virtual

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

virtual

Sets name and sets myNameSet to true if name is non-blank.

Reimplemented from DtIfPlan.

virtual int DtIfMultiplePlanSet::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 DtIfPlan.

static DtSimInterfaceContent* DtIfMultiplePlanSet::creator ( )

static

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

virtual

Fills in the task from the network buffer.

Reimplemented from DtIfPlan.

virtual bool DtIfMultiplePlanSet::setToNet ( )

virtual

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

Reimplemented from DtIfPlan.

virtual DtString DtIfMultiplePlanSet::markingText ( ) const

virtual

Reimplemented from DtIfPlan.

Member Data Documentation

std::vector<DtUUID> DtIfMultiplePlanSet::myEntities

protected

bool DtIfMultiplePlanSet::myUUIDSet

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmsgs/ifMultiplePlanSet.h