DtSetResourceRequest Class Reference

DtSetResourceRequest is used to set a resource value for an entity. More...

Inheritance diagram for DtSetResourceRequest:

List of all members.

Public Member Functions
	DtSetResourceRequest ()
	default constructor
	DtSetResourceRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetResourceRequest (const DtString &writeName, const DtSetResourceRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetResourceRequest &	operator= (const DtSetResourceRequest &orig)
	assignment operator
virtual	~DtSetResourceRequest ()
virtual int	type () const
	Returns "set-resource".
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 const DtString &	resourceName () const
	The list of resource types supported is in resourceTypes.h.
virtual void	setResourceName (const DtString &resource)
virtual DtReal	resourceValue () const
virtual void	setResourceValue (DtReal value)
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.
Static Public Member Functions
static DtSetDataRequest *	creator ()
Protected Attributes
DtRwString	myResourceName
DtRwReal	myResourceValue

---

Detailed Description

DtSetResourceRequest is used to set a resource value for an entity.

It inherits read/writableness from DtSetDataRequest, and includes the name of the resource and the value to set it to.

set-data-request-type: DtSetResourceRequestType

parameters: resource name - String name of the resource to be set. The list of resource types supported in VR-Forces is in resource- Types.h.

resource value - The value of the resource (a real number).

---

Constructor & Destructor Documentation

DtSetResourceRequest::DtSetResourceRequest

(

)

default constructor

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

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

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

copy constructor

virtual DtSetResourceRequest::~DtSetResourceRequest

(

)

[virtual]

---

Member Function Documentation

const DtSetResourceRequest& DtSetResourceRequest::operator=

(

const DtSetResourceRequest &

orig

)

assignment operator

virtual int DtSetResourceRequest::type

(

)

const [virtual]

Returns "set-resource".

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetResourceRequest::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtString& DtSetResourceRequest::resourceName

(

)

const [virtual]

The list of resource types supported is in resourceTypes.h.

virtual void DtSetResourceRequest::setResourceName

(

const DtString &

resource

)

[virtual]

virtual DtReal DtSetResourceRequest::resourceValue

(

)

const [virtual]

virtual void DtSetResourceRequest::setResourceValue

(

DtReal

value

)

[virtual]

virtual int DtSetResourceRequest::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetResourceRequest::setToNet

(

)

[virtual]

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

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetResourceRequest::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtSetResourceRequest::myResourceName [protected]

DtRwReal DtSetResourceRequest::myResourceValue [protected]

---

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

• include/vrftasks/setResource.h