DtRetreatTask Class Reference

Inheritance diagram for DtRetreatTask:

List of all members.

Public Member Functions
	DtRetreatTask ()
	DtRetreatTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtRetreatTask ()
	DtRetreatTask (const DtString &writeName, const DtRetreatTask &orig, DtReaderWriterRegistry *parentRegistry=0)
DtRetreatTask &	operator= (const DtRetreatTask &orig)
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
	Make a copy of this task.
virtual DtString	stringRep () const
	Returns a human-readable string representation of the task.
virtual const DtString &	retreatKind () const
virtual void	setRetreatKind (const DtString &retreatKind)
virtual int	netRepSize () const
	Returns the size in bytes of the network representation of the class.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).
virtual bool	setToNet ()
	Calls netRep() to create the network buffer.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwString	myRetreatKind

---

Constructor & Destructor Documentation

DtRetreatTask::DtRetreatTask

(

)

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

virtual DtRetreatTask::~DtRetreatTask

(

)

[virtual]

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

---

Member Function Documentation

DtRetreatTask& DtRetreatTask::operator=

(

const DtRetreatTask &

orig

)

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

Make a copy of this task.

Returns a newly allocated instance of a DtSimTask. Override this member function to return a pointer to a newly allocated instance of the derived class.

Implements DtSimTask.

virtual DtString DtRetreatTask::stringRep

(

)

const [virtual]

Returns a human-readable string representation of the task.

This string representation is used to display information about the task in the plan editor and viewer. The type and parameters for the task are typically encoded in the string. The format of the string is up to you.

Implements DtSimTask.

virtual const DtString& DtRetreatTask::retreatKind

(

)

const [virtual]

virtual void DtRetreatTask::setRetreatKind

(

const DtString &

retreatKind

)

[virtual]

virtual int DtRetreatTask::netRepSize

(

)

const [virtual]

Returns the size in bytes of the network representation of the class.

This is the size in bytes of the DtNetSimTask structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimTask.

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

Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).

Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

virtual bool DtRetreatTask::setToNet

(

)

[virtual]

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimTask*, and then sets the mySubtask member in the DtNetSimTask from mySubtask. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

static DtSimTask* DtRetreatTask::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtRetreatTask::myRetreatKind [protected]

---

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

• examples/addTask/addTaskSim/retreatTask.h