DtIfAdminSyncMatrixActivatePlanRequest Class Reference

Admin content to request activate/deactivate a plan of an object in a synchronization matrix phase. A DtIfSyncMatrixPlansStatus message is typically sent in response to this request.

Inheritance diagram for DtIfAdminSyncMatrixActivatePlanRequest:

Public Member Functions
	DtIfAdminSyncMatrixActivatePlanRequest ()
	DtIfAdminSyncMatrixActivatePlanRequest (const DtIfAdminSyncMatrixActivatePlanRequest &orig)
const DtIfAdminSyncMatrixActivatePlanRequest &	operator= (const DtIfAdminSyncMatrixActivatePlanRequest &orig)
virtual	~DtIfAdminSyncMatrixActivatePlanRequest () override
virtual const DtAdminContentMessageType &	type () const override
virtual DtAdminContent *	clone () const override
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual DtString	stringRep () const override
virtual const DtUUID &	object () const
virtual void	setObject (const DtUUID &object)
virtual const DtString &	phaseName () const
virtual void	setPhaseName (const DtString &phaseName)
virtual bool	activate () const
virtual void	setActivate (bool activate)
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
DtUUID	myObject
DtString	myPhaseName
bool	myActivate
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

DtIfAdminSyncMatrixActivatePlanRequest::DtIfAdminSyncMatrixActivatePlanRequest

(

)

default constructor

DtIfAdminSyncMatrixActivatePlanRequest::DtIfAdminSyncMatrixActivatePlanRequest

(

const DtIfAdminSyncMatrixActivatePlanRequest &

orig

)

copy constructor

virtual DtIfAdminSyncMatrixActivatePlanRequest::~DtIfAdminSyncMatrixActivatePlanRequest ( )

overridevirtual

Member Function Documentation

const DtIfAdminSyncMatrixActivatePlanRequest& DtIfAdminSyncMatrixActivatePlanRequest::operator=

(

const DtIfAdminSyncMatrixActivatePlanRequest &

orig

)

assignment operator

virtual const DtAdminContentMessageType& DtIfAdminSyncMatrixActivatePlanRequest::type ( ) const

overridevirtual

Returns

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

Implements DtAdminContent.

virtual DtAdminContent* DtIfAdminSyncMatrixActivatePlanRequest::clone ( ) const

overridevirtual

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 DtUUID& DtIfAdminSyncMatrixActivatePlanRequest::object ( ) const

virtual

The object uuid.

virtual void DtIfAdminSyncMatrixActivatePlanRequest::setObject ( const DtUUID &  object )

virtual

The object uuid.

virtual const DtString& DtIfAdminSyncMatrixActivatePlanRequest::phaseName ( ) const

virtual

The synchronization matrix phase name.

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

virtual

The synchronization matrix phase name.

virtual bool DtIfAdminSyncMatrixActivatePlanRequest::activate ( ) const

virtual

Activate/Deactivate status.

virtual void DtIfAdminSyncMatrixActivatePlanRequest::setActivate ( bool  activate )

virtual

Activate/Deactivate status.

virtual int DtIfAdminSyncMatrixActivatePlanRequest::netRepSize ( ) const

overridevirtual

Returns

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

Reimplemented from DtAdminContent.

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

overridevirtual

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

Reimplemented from DtAdminContent.

virtual bool DtIfAdminSyncMatrixActivatePlanRequest::setToNet ( )

overridevirtual

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

Reimplemented from DtAdminContent.

virtual DtString DtIfAdminSyncMatrixActivatePlanRequest::stringRep ( ) const

overridevirtual

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* DtIfAdminSyncMatrixActivatePlanRequest::create ( )

static

Member Data Documentation

DtUUID DtIfAdminSyncMatrixActivatePlanRequest::myObject

protected

DtString DtIfAdminSyncMatrixActivatePlanRequest::myPhaseName

protected

bool DtIfAdminSyncMatrixActivatePlanRequest::myActivate

protected

---

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

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