DtClearTask Class Reference

DtClearTask is used to tell an entity to clear its current task. More...

Inheritance diagram for DtClearTask:

List of all members.

Public Member Functions
	DtClearTask ()
	default constructor
	DtClearTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtClearTask (const DtString &writeName, const DtClearTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtClearTask &	operator= (const DtClearTask &orig)
	assignment operator
virtual	~DtClearTask ()
virtual int	type () const
	Returns DtClearTaskType (defined in radioMsgTypes.h).
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	taskType () const
	Type of task to be cleared. Task types are defined in radioMsgTypes.h.
virtual void	setTaskType (int type)
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
DtRwInt	myTaskType

---

Detailed Description

DtClearTask is used to tell an entity to clear its current task.

It may be sent by an entity to itself, to clear a subtask, or it may be sent by an aggregate to its subordinate.

set-data-request-type: DtClearTaskType

parameters: speed - Speed in meters per second.

---

Constructor & Destructor Documentation

DtClearTask::DtClearTask

(

)

default constructor

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

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

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

copy constructor

virtual DtClearTask::~DtClearTask

(

)

[virtual]

---

Member Function Documentation

const DtClearTask& DtClearTask::operator=

(

const DtClearTask &

orig

)

assignment operator

virtual int DtClearTask::type

(

)

const [virtual]

Returns DtClearTaskType (defined in radioMsgTypes.h).

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtClearTask::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual int DtClearTask::taskType

(

)

const [virtual]

Type of task to be cleared. Task types are defined in radioMsgTypes.h.

virtual void DtClearTask::setTaskType

(

int

type

)

[virtual]

virtual int DtClearTask::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtClearTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtClearTask::creator

(

)

[static]

---

Member Data Documentation

DtRwInt DtClearTask::myTaskType [protected]

---

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

• include/vrftasks/clearTask.h