DtSetSpotReportingRequest Class Reference

DtSetSpotReportingRequest is used to set spot reporting on or off for an entity. More...

Inheritance diagram for DtSetSpotReportingRequest:

List of all members.

Public Member Functions
	DtSetSpotReportingRequest ()
	default constructor
	DtSetSpotReportingRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetSpotReportingRequest (const DtString &writeName, const DtSetSpotReportingRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetSpotReportingRequest &	operator= (const DtSetSpotReportingRequest &orig)
	assignment operator
virtual	~DtSetSpotReportingRequest ()
virtual int	type () const
	Returns DtSetSpotReportingRequestType.
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of the request.
virtual DtString	stringRep () const
	Get a readable string representation of this setDataRequest.
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
virtual bool	spotReporting () const
	If globalEnabledOverridingLocal is not true, this represents the local setting for enabling spot reports.
virtual void	setSpotReporting (bool spot)
	If globalEnabledOverridingLocal is not true, this represents the local setting for enabling spot reports.
virtual bool	globalEnabledOverridingLocal () const
	If this value is true, the controller will enable or disable its spot reports according to the global setting stored in the DtVrfSimSettingsManager.
virtual void	setGlobalEnabledOverridingLocal (bool globalOverride)
	If this value is true, the controller will enable or disable its spot reports according to the global setting stored in the DtVrfSimSettingsManager.
Static Public Member Functions
static DtSetDataRequest *	creator ()
Protected Attributes
DtRwBoolean	mySpotReportingOn
DtRwBoolean	myGlobalEnabledOverridingLocal

---

Detailed Description

DtSetSpotReportingRequest is used to set spot reporting on or off for an entity.

It inherits read/writableness from DtSetDataRequest.

---

Constructor & Destructor Documentation

DtSetSpotReportingRequest::DtSetSpotReportingRequest

(

)

default constructor

DtSetSpotReportingRequest::DtSetSpotReportingRequest	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetSpotReportingRequest::DtSetSpotReportingRequest	(	const DtString &	writeName,
		const DtSetSpotReportingRequest &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSetSpotReportingRequest::~DtSetSpotReportingRequest

(

)

[virtual]

---

Member Function Documentation

const DtSetSpotReportingRequest& DtSetSpotReportingRequest::operator=

(

const DtSetSpotReportingRequest &

orig

)

assignment operator

virtual int DtSetSpotReportingRequest::type

(

)

const [virtual]

Returns DtSetSpotReportingRequestType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetSpotReportingRequest::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetSpotReportingRequest::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual bool DtSetSpotReportingRequest::spotReporting

(

)

const [virtual]

If globalEnabledOverridingLocal is not true, this represents the local setting for enabling spot reports.

If globalEnabledOverridingLocal is true, this setting is ignored.

virtual void DtSetSpotReportingRequest::setSpotReporting

(

bool

spot

)

[virtual]

If globalEnabledOverridingLocal is not true, this represents the local setting for enabling spot reports.

If globalEnabledOverridingLocal is true, this setting is ignored.

virtual bool DtSetSpotReportingRequest::globalEnabledOverridingLocal

(

)

const [virtual]

If this value is true, the controller will enable or disable its spot reports according to the global setting stored in the DtVrfSimSettingsManager.

If this value is false, the local setting specified by spotReporting() will be used.

virtual void DtSetSpotReportingRequest::setGlobalEnabledOverridingLocal

(

bool

globalOverride

)

[virtual]

If this value is true, the controller will enable or disable its spot reports according to the global setting stored in the DtVrfSimSettingsManager.

If this value is false, the local setting specified by spotReporting() will be used.

virtual int DtSetSpotReportingRequest::netRepSize

(

)

const [virtual]

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSpotReportingRequest::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSpotReportingRequest::setToNet

(

)

[virtual]

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

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetSpotReportingRequest::creator

(

)

[static]

---

Member Data Documentation

DtRwBoolean DtSetSpotReportingRequest::mySpotReportingOn [protected]

DtRwBoolean DtSetSpotReportingRequest::myGlobalEnabledOverridingLocal [protected]

---

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

• include/vrftasks/setSpotReportingRequest.h