DtIfAdminSyncMatrixPhaseInfoRequest Class Reference

Admin content to set info of a synchronization matrix phase. A DtIfSyncMatrixPhaseInfoResponse message is typically sent in response to this request.

Inheritance diagram for DtIfAdminSyncMatrixPhaseInfoRequest:

Public Member Functions
	DtIfAdminSyncMatrixPhaseInfoRequest ()
	DtIfAdminSyncMatrixPhaseInfoRequest (const DtIfAdminSyncMatrixPhaseInfoRequest &orig)
const DtIfAdminSyncMatrixPhaseInfoRequest &	operator= (const DtIfAdminSyncMatrixPhaseInfoRequest &orig)
virtual	~DtIfAdminSyncMatrixPhaseInfoRequest ()
virtual const DtAdminContentMessageType &	type () const
virtual DtAdminContent *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual DtString	stringRep () const
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 void	setEndCondition (const DtSimCondExpr *endCondition)
virtual const DtSimCondExpr *	endCondition () const
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
virtual bool	init ()
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
Static Public Member Functions inherited from DtAdminContent
static void	addAdminContentCreatorFcn (const DtAdminContentMessageType &contentName, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	isTypeRegistered (const DtAdminContentMessageType &type)

Protected Attributes
DtString	myCurrentName
DtString	myRequestedName
int	myPhaseIndex
bool	myEndConditionSpecified
DtRwCondExpr	myEndCondition
Protected Attributes inherited from DtAdminContent
char *	myNetRep

Additional Inherited Members
Protected Member Functions inherited from DtAdminContent
	DtAdminContent ()
	DtAdminContent (const DtAdminContent &orig)
const DtAdminContent &	operator= (const DtAdminContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Constructor & Destructor Documentation

DtIfAdminSyncMatrixPhaseInfoRequest::DtIfAdminSyncMatrixPhaseInfoRequest

(

)

default constructor

DtIfAdminSyncMatrixPhaseInfoRequest::DtIfAdminSyncMatrixPhaseInfoRequest

(

const DtIfAdminSyncMatrixPhaseInfoRequest &

orig

)

copy constructor

virtual DtIfAdminSyncMatrixPhaseInfoRequest::~DtIfAdminSyncMatrixPhaseInfoRequest ( )

virtual

Member Function Documentation

const DtIfAdminSyncMatrixPhaseInfoRequest& DtIfAdminSyncMatrixPhaseInfoRequest::operator=

(

const DtIfAdminSyncMatrixPhaseInfoRequest &

orig

)

assignment operator

virtual const DtAdminContentMessageType& DtIfAdminSyncMatrixPhaseInfoRequest::type ( ) const

virtual

Returns

The type of admin content this class is. See types defined in radioMsgTypes.h.

Implements DtAdminContent.

virtual DtAdminContent* DtIfAdminSyncMatrixPhaseInfoRequest::clone ( ) const

virtual

Make a copy of this content. Returns a pointer to a newly created copy of this class. Derived classes must override this function to create and return an instance of the derived type.

Implements DtAdminContent.

virtual const DtString& DtIfAdminSyncMatrixPhaseInfoRequest::currentName ( ) const

virtual

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

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

virtual

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

virtual const DtString& DtIfAdminSyncMatrixPhaseInfoRequest::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 DtIfAdminSyncMatrixPhaseInfoRequest::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 DtIfAdminSyncMatrixPhaseInfoRequest::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 DtIfAdminSyncMatrixPhaseInfoRequest::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 DtIfAdminSyncMatrixPhaseInfoRequest::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 DtIfAdminSyncMatrixPhaseInfoRequest::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 void DtIfAdminSyncMatrixPhaseInfoRequest::setEndCondition ( const DtSimCondExpr *  endCondition )

virtual

Set/Get the end condition.

virtual const DtSimCondExpr* DtIfAdminSyncMatrixPhaseInfoRequest::endCondition ( ) const

virtual

Set/Get the end condition.

virtual int DtIfAdminSyncMatrixPhaseInfoRequest::netRepSize ( ) const

virtual

Returns

Size necessary for a network representation of this set request. Base class returns 0.

Reimplemented from DtAdminContent.

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

virtual

Sets the contents of this set request based on the network buffer. Base class does nothing and returns true.

Reimplemented from DtAdminContent.

virtual bool DtIfAdminSyncMatrixPhaseInfoRequest::setToNet ( )

virtual

Sets netRep buffer to the contents of this set request. Base class does nothing and returns true.

Reimplemented from DtAdminContent.

virtual DtString DtIfAdminSyncMatrixPhaseInfoRequest::stringRep ( ) const

virtual

Get a readable string representation of this content. Derived classes must implement this function. The string should include the identity of the content, along with any parameters. The format of the string is up to you.

Implements DtAdminContent.

static DtAdminContent* DtIfAdminSyncMatrixPhaseInfoRequest::create ( )

static

Member Data Documentation

DtString DtIfAdminSyncMatrixPhaseInfoRequest::myCurrentName

protected

DtString DtIfAdminSyncMatrixPhaseInfoRequest::myRequestedName

protected

int DtIfAdminSyncMatrixPhaseInfoRequest::myPhaseIndex

protected

bool DtIfAdminSyncMatrixPhaseInfoRequest::myEndConditionSpecified

protected

DtRwCondExpr DtIfAdminSyncMatrixPhaseInfoRequest::myEndCondition

protected

---

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

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