DtIfSyncMatrixPhaseInfoResponse Class Reference

Interface content for a respone to add phase and set phase end condition requuests.

Inheritance diagram for DtIfSyncMatrixPhaseInfoResponse:

Public Member Functions
	DtIfSyncMatrixPhaseInfoResponse ()
	DtIfSyncMatrixPhaseInfoResponse (const DtIfSyncMatrixPhaseInfoResponse &orig)
const DtIfSyncMatrixPhaseInfoResponse &	operator= (const DtIfSyncMatrixPhaseInfoResponse &orig)
virtual	~DtIfSyncMatrixPhaseInfoResponse ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual const DtUUID &	syncMatrix () const
virtual void	setSyncMatrix (const DtUUID &syncMatrix)
virtual const DtString &	currentName () const
virtual void	setCurrentName (const DtString &name)
virtual const DtString &	requestedName () const
virtual void	setRequestedName (const DtString &name)
virtual int	phaseIndex () const
virtual void	setPhaseIndex (int phaseIndex)
virtual bool	endConditionSpecified () const
virtual void	setEndConditionSpecified (bool endConditionSpecified)
virtual bool	completed () const
virtual void	setCompleted (bool completed)
virtual bool	linkWithPreviousPhase () const
virtual void	setLinkWithPreviousPhase (bool linked)
virtual void	setEndCondition (const DtSimCondExpr *endCondition)
virtual const DtSimCondExpr *	endCondition () 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 Attributes
DtUUID	mySyncMatrix
DtString	myCurrentName
DtString	myRequestedName
int	myPhaseIndex
bool	myEndConditionSpecified
DtRwCondExpr	myEndCondition
bool	myCompleted
bool	myLinkWithPreviousPhase
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
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

DtIfSyncMatrixPhaseInfoResponse::DtIfSyncMatrixPhaseInfoResponse

(

)

default constructor

DtIfSyncMatrixPhaseInfoResponse::DtIfSyncMatrixPhaseInfoResponse

(

const DtIfSyncMatrixPhaseInfoResponse &

orig

)

copy constructor

virtual DtIfSyncMatrixPhaseInfoResponse::~DtIfSyncMatrixPhaseInfoResponse ( )

virtual

Member Function Documentation

const DtIfSyncMatrixPhaseInfoResponse& DtIfSyncMatrixPhaseInfoResponse::operator=

(

const DtIfSyncMatrixPhaseInfoResponse &

orig

)

assignment operator

virtual int DtIfSyncMatrixPhaseInfoResponse::type ( ) const

virtual

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfSyncMatrixPhaseInfoResponse::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual const DtUUID& DtIfSyncMatrixPhaseInfoResponse::syncMatrix ( ) const

virtual

The synchronization matrix object uuid.

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

virtual

The synchronization matrix object uuid.

virtual const DtString& DtIfSyncMatrixPhaseInfoResponse::currentName ( ) const

virtual

The phase current name. If empty, a new phase will be created.

virtual void DtIfSyncMatrixPhaseInfoResponse::setCurrentName ( const DtString &  name )

virtual

The phase current name. If empty, a new phase will be created.

virtual const DtString& DtIfSyncMatrixPhaseInfoResponse::requestedName ( ) const

virtual

The phase requested name. Can be used as either the name of a new phase or the new name for an existing phase.

virtual void DtIfSyncMatrixPhaseInfoResponse::setRequestedName ( const DtString &  name )

virtual

The phase requested name. Can be used as either the name of a new phase or the new name for an existing phase.

virtual int DtIfSyncMatrixPhaseInfoResponse::phaseIndex ( ) const

virtual

The phase index in the phases list. Used when we want to add a new phase in a specific index or move an existing phase to another index in the phases list.

virtual void DtIfSyncMatrixPhaseInfoResponse::setPhaseIndex ( int  phaseIndex )

virtual

The phase index in the phases list. Used when we want to add a new phase in a specific index or move an existing phase to another index in the phases list.

virtual bool DtIfSyncMatrixPhaseInfoResponse::endConditionSpecified ( ) const

virtual

Determine if this message specify an end condition. If not, the current end condition of the phase will not be replaced. Default value: true.

virtual void DtIfSyncMatrixPhaseInfoResponse::setEndConditionSpecified ( bool  endConditionSpecified )

virtual

Determine if this message specify an end condition. If not, the current end condition of the phase will not be replaced. Default value: true.

virtual bool DtIfSyncMatrixPhaseInfoResponse::completed ( ) const

virtual

Compeleted status.

virtual void DtIfSyncMatrixPhaseInfoResponse::setCompleted ( bool  completed )

virtual

Compeleted status.

virtual bool DtIfSyncMatrixPhaseInfoResponse::linkWithPreviousPhase ( ) const

virtual

Linked status.

virtual void DtIfSyncMatrixPhaseInfoResponse::setLinkWithPreviousPhase ( bool  linked )

virtual

Linked status.

virtual void DtIfSyncMatrixPhaseInfoResponse::setEndCondition ( const DtSimCondExpr *  endCondition )

virtual

Set/Get the end condition.

virtual const DtSimCondExpr* DtIfSyncMatrixPhaseInfoResponse::endCondition ( ) const

virtual

Set/Get the end condition.

virtual int DtIfSyncMatrixPhaseInfoResponse::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSyncMatrixPhaseInfoResponse::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfSyncMatrixPhaseInfoResponse::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfSyncMatrixPhaseInfoResponse::creator ( )

static

Member Data Documentation

DtUUID DtIfSyncMatrixPhaseInfoResponse::mySyncMatrix

protected

DtString DtIfSyncMatrixPhaseInfoResponse::myCurrentName

protected

DtString DtIfSyncMatrixPhaseInfoResponse::myRequestedName

protected

int DtIfSyncMatrixPhaseInfoResponse::myPhaseIndex

protected

bool DtIfSyncMatrixPhaseInfoResponse::myEndConditionSpecified

protected

DtRwCondExpr DtIfSyncMatrixPhaseInfoResponse::myEndCondition

protected

bool DtIfSyncMatrixPhaseInfoResponse::myCompleted

protected

bool DtIfSyncMatrixPhaseInfoResponse::myLinkWithPreviousPhase

protected

---

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

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