DtIfSyncMatrixPlan Class Reference

class DtIfSyncMatrixPlan:

This class is an extension of DtIfPlan where a plan is mapped to a specific object in a specific phase in a specific sync matrix

Inheritance diagram for DtIfSyncMatrixPlan:

Public Member Functions
	DtIfSyncMatrixPlan ()
virtual	~DtIfSyncMatrixPlan ()
	DtIfSyncMatrixPlan (const DtIfSyncMatrixPlan &orig)
DtIfSyncMatrixPlan &	operator= (const DtIfSyncMatrixPlan &orig)
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual const DtUUID &	syncMatrix () const
virtual void	setSyncMatrix (const DtUUID &syncMatrix)
virtual const DtString &	phaseName () const
virtual void	setPhaseName (const DtString &phaseName)
virtual void	setLinkWithPreviousPhase (bool)
virtual bool	linkWithPreviousPhase () const
virtual bool	linkStatusSet () const
virtual void	clearLinkStatusSet ()
Public Member Functions inherited from DtIfPlan
	DtIfPlan ()
virtual	~DtIfPlan ()
	DtIfPlan (const DtIfPlan &orig)
DtIfPlan &	operator= (const DtIfPlan &orig)
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 void	printDataToString (DtString &str)
void	emptyStatementList ()
virtual bool	isSamePlan (DtIfPlan *rhs)
virtual void	setAbandonCurrentPlan (bool)
virtual bool	abandonCurrentPlan () const
virtual void	setSendPlanOnAssignment (bool)
virtual bool	sendPlanOnAssignment () const
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
DtUUID	mySyncMatrix
DtString	myPhaseName
bool	myLinkWithPreviousPhase
bool	myLinkStatusSet
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
bool	myAbandonCurrentPlan
bool	mySendPlanOnAssignment
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

DtIfSyncMatrixPlan::DtIfSyncMatrixPlan

(

)

default constructor

virtual DtIfSyncMatrixPlan::~DtIfSyncMatrixPlan ( )

virtual

destructor

DtIfSyncMatrixPlan::DtIfSyncMatrixPlan

(

const DtIfSyncMatrixPlan &

orig

)

copy constructor

Member Function Documentation

DtIfSyncMatrixPlan& DtIfSyncMatrixPlan::operator=

(

const DtIfSyncMatrixPlan &

orig

)

assignment operator

virtual int DtIfSyncMatrixPlan::type ( ) const

virtual

Returns the type of Interface Content.

Reimplemented from DtIfPlan.

virtual DtSimInterfaceContent* DtIfSyncMatrixPlan::clone ( ) const

virtual

Reimplemented from DtIfPlan.

virtual const DtUUID& DtIfSyncMatrixPlan::syncMatrix ( ) const

virtual

The sync matrix uuid.

virtual void DtIfSyncMatrixPlan::setSyncMatrix ( const DtUUID &  syncMatrix )

virtual

The sync matrix uuid.

virtual const DtString& DtIfSyncMatrixPlan::phaseName ( ) const

virtual

The synchronization matrix phase name.

virtual void DtIfSyncMatrixPlan::setPhaseName ( const DtString &  phaseName )

virtual

The synchronization matrix phase name.

virtual void DtIfSyncMatrixPlan::setLinkWithPreviousPhase ( bool  )

virtual

Whether or not to haev the plan from the previous phase carry over into this phase, so this phase does not have to set a plan.

virtual bool DtIfSyncMatrixPlan::linkWithPreviousPhase ( ) const

virtual

Whether or not to haev the plan from the previous phase carry over into this phase, so this phase does not have to set a plan.

virtual bool DtIfSyncMatrixPlan::linkStatusSet ( ) const

virtual

Whether or not to haev the plan from the previous phase carry over into this phase, so this phase does not have to set a plan.

virtual void DtIfSyncMatrixPlan::clearLinkStatusSet ( )

virtual

Whether or not to haev the plan from the previous phase carry over into this phase, so this phase does not have to set a plan.

virtual int DtIfSyncMatrixPlan::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* DtIfSyncMatrixPlan::creator ( )

static

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

virtual

Fills in the task from the network buffer.

Reimplemented from DtIfPlan.

virtual bool DtIfSyncMatrixPlan::setToNet ( )

virtual

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

Reimplemented from DtIfPlan.

Member Data Documentation

DtUUID DtIfSyncMatrixPlan::mySyncMatrix

protected

DtString DtIfSyncMatrixPlan::myPhaseName

protected

bool DtIfSyncMatrixPlan::myLinkWithPreviousPhase

protected

bool DtIfSyncMatrixPlan::myLinkStatusSet

protected

---

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

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