DtSetEmitterRequest Class Reference

DtSetEmitterRequest is used to turn on and off DtEmitterComponents installed on entities. More...

Inheritance diagram for DtSetEmitterRequest:

List of all members.

Public Member Functions
	DtSetEmitterRequest ()
	default constructor
	DtSetEmitterRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetEmitterRequest (const DtString &writeName, const DtSetEmitterRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetEmitterRequest &	operator= (const DtSetEmitterRequest &orig)
	assignment operator
virtual	~DtSetEmitterRequest ()
virtual int	type () const
	Returns DtSetEmitterRequestType.
virtual void	setEmitterId (DtU8 id)
virtual DtU8	emitterId () const
virtual void	setOn (bool onOff)
virtual bool	on () const
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.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the request from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class setDataRequest) with the set data request contents.
Static Public Member Functions
static DtSetDataRequest *	creator ()
Protected Attributes
DtRwInt	myEmitterId
DtRwBoolean	myOn

---

Detailed Description

DtSetEmitterRequest is used to turn on and off DtEmitterComponents installed on entities.

Since more than one emitter component can be on a single entity, the emitter ID must be included in the message. This value should match the EmitterID being published with this emitter.

---

Constructor & Destructor Documentation

DtSetEmitterRequest::DtSetEmitterRequest

(

)

default constructor

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

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

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

copy constructor

virtual DtSetEmitterRequest::~DtSetEmitterRequest

(

)

[virtual]

---

Member Function Documentation

const DtSetEmitterRequest& DtSetEmitterRequest::operator=

(

const DtSetEmitterRequest &

orig

)

assignment operator

virtual int DtSetEmitterRequest::type

(

)

const [virtual]

Returns DtSetEmitterRequestType.

Implements DtSetDataRequest.

virtual void DtSetEmitterRequest::setEmitterId

(

DtU8

id

)

[virtual]

virtual DtU8 DtSetEmitterRequest::emitterId

(

)

const [virtual]

virtual void DtSetEmitterRequest::setOn

(

bool

onOff

)

[virtual]

virtual bool DtSetEmitterRequest::on

(

)

const [virtual]

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

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetEmitterRequest::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual int DtSetEmitterRequest::netRepSize

(

)

const [virtual]

Returns the size of the full network representation.

Reimplemented from DtSetDataRequest.

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

Fills in the request from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetEmitterRequest::setToNet

(

)

[virtual]

Fills in the network buffer (created by base class setDataRequest) with the set data request contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetEmitterRequest::creator

(

)

[static]

---

Member Data Documentation

DtRwInt DtSetEmitterRequest::myEmitterId [protected]

DtRwBoolean DtSetEmitterRequest::myOn [protected]

---

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

• include/vrftasks/setEmitter.h