DtPatrolRouteTask Class Reference

DtPatrolRouteTask represents a Patrol Along Route task for an entity to perform. More...

Inheritance diagram for DtPatrolRouteTask:

List of all members.

Public Member Functions
	DtPatrolRouteTask ()
	default constructor
	DtPatrolRouteTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtPatrolRouteTask (const DtString &writeName, const DtPatrolRouteTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtPatrolRouteTask &	operator= (const DtPatrolRouteTask &orig)
	assignment operator
virtual	~DtPatrolRouteTask ()
virtual int	type () const
	What kind of task am I? Returns a string indicating the kind of task (for example, “move-to”, “follow-entity”).
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual const DtString &	routeName () const
virtual void	setRouteName (const DtString &rteName)
virtual int	netRepSize () const
	Returns the size of the full network representation (control object name included) 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 DtSimTask *	creator ()
Protected Attributes
DtRwString	myRouteName

---

Detailed Description

DtPatrolRouteTask represents a Patrol Along Route task for an entity to perform.

It inherits read/writableness from SimTask, and includes the route to patrol. An entity given a Patrol Route task moves to the vertex point closest to the location of the entity at the time it receives the task. Then it moves towards the end of the route, going from vertex to vertex. When it reaches the last vertex in the route, it reverses direction, and moves along the route back to the beginning.

An entity executing a DtPatrolRouteTask will not advance to another task unless one of the following things happens:

• A trigger for the entity fires

• The entity is retasked or set Tasked by Superior.

task-type: DtPatrolRouteType

parameters: route name - The string name of the route to patrol. Use the route name to look up the corresponding DtVrfObject object in the Object Manager.

---

Constructor & Destructor Documentation

DtPatrolRouteTask::DtPatrolRouteTask

(

)

default constructor

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

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

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

copy constructor

virtual DtPatrolRouteTask::~DtPatrolRouteTask

(

)

[virtual]

---

Member Function Documentation

const DtPatrolRouteTask& DtPatrolRouteTask::operator=

(

const DtPatrolRouteTask &

orig

)

assignment operator

virtual int DtPatrolRouteTask::type

(

)

const [virtual]

What kind of task am I? Returns a string indicating the kind of task (for example, “move-to”, “follow-entity”).

Derived classes must implement this member function to return a unique string representing the type of task. The set of standard task types supplied with VR-Forces is in taskTypes.h.

Implements DtSimTask.

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

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtPatrolRouteTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual const DtString& DtPatrolRouteTask::routeName

(

)

const [virtual]

virtual void DtPatrolRouteTask::setRouteName

(

const DtString &

rteName

)

[virtual]

virtual int DtPatrolRouteTask::netRepSize

(

)

const [virtual]

Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.

Reimplemented from DtSimTask.

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtPatrolRouteTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtPatrolRouteTask::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtPatrolRouteTask::myRouteName [protected]

---

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

• include/vrftasks/patrolRteTask.h