DtPatrolTwoPointsTask Class Reference

DtPatrolTwoPointsTask represents a patrol between 2 points task for an entity to perform. More...

Inheritance diagram for DtPatrolTwoPointsTask:

List of all members.

Public Member Functions
	DtPatrolTwoPointsTask ()
	default constructor
	DtPatrolTwoPointsTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtPatrolTwoPointsTask (const DtString &writeName, const DtPatrolTwoPointsTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtPatrolTwoPointsTask &	operator= (const DtPatrolTwoPointsTask &orig)
	assignment operator
virtual	~DtPatrolTwoPointsTask ()
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 &	firstControlPtName () const
virtual void	setFirstControlPtName (const DtString &cpName)
virtual const DtString &	secondControlPtName () const
virtual void	setSecondControlPtName (const DtString &cpName)
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	myFirstControlPtName
DtRwString	mySecondControlPtName

---

Detailed Description

DtPatrolTwoPointsTask represents a patrol between 2 points task for an entity to perform.

It inherits read/writableness from SimTask, and includes the two waypoints to patrol between.

Entities given a DtPatrolTwoPointsTask move back and forth between the two waypoints specified in the task. An entity executing a DtPatrolTwoPointsTask 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: DtPatrolTwoPointsType

parameters: first control point - The string name of the first waypoint.

second control point - The string name of the second waypoint. Use the name to look up the corresponding DtVrfObject object in the Object Manager.

---

Constructor & Destructor Documentation

DtPatrolTwoPointsTask::DtPatrolTwoPointsTask

(

)

default constructor

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

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

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

copy constructor

virtual DtPatrolTwoPointsTask::~DtPatrolTwoPointsTask

(

)

[virtual]

---

Member Function Documentation

const DtPatrolTwoPointsTask& DtPatrolTwoPointsTask::operator=

(

const DtPatrolTwoPointsTask &

orig

)

assignment operator

virtual int DtPatrolTwoPointsTask::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* DtPatrolTwoPointsTask::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtPatrolTwoPointsTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual const DtString& DtPatrolTwoPointsTask::firstControlPtName

(

)

const [virtual]

virtual void DtPatrolTwoPointsTask::setFirstControlPtName

(

const DtString &

cpName

)

[virtual]

virtual const DtString& DtPatrolTwoPointsTask::secondControlPtName

(

)

const [virtual]

virtual void DtPatrolTwoPointsTask::setSecondControlPtName

(

const DtString &

cpName

)

[virtual]

virtual int DtPatrolTwoPointsTask::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 DtPatrolTwoPointsTask::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtPatrolTwoPointsTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtPatrolTwoPointsTask::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtPatrolTwoPointsTask::myFirstControlPtName [protected]

DtRwString DtPatrolTwoPointsTask::mySecondControlPtName [protected]

---

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

• include/vrftasks/patrolPtTask.h