DtWaitElapsedTask Class Reference

DtWaitElapsedTask commands an entity to wait until a given amount of simulation time has elapsed, relative to the start time of the simulation. More...

Inheritance diagram for DtWaitElapsedTask:

List of all members.

Public Member Functions
	DtWaitElapsedTask ()
	default constructor
	DtWaitElapsedTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtWaitElapsedTask (const DtString &writeName, const DtWaitElapsedTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtWaitElapsedTask &	operator= (const DtWaitElapsedTask &orig)
	assignment operator
virtual	~DtWaitElapsedTask ()
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 wait task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual void	setElapsedTime (DtReal seconds)
virtual DtReal	elapsedTime () const
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 DtSimTask *	creator ()
Protected Attributes
DtRwReal	myElapsedTime

---

Detailed Description

DtWaitElapsedTask commands an entity to wait until a given amount of simulation time has elapsed, relative to the start time of the simulation.

It inherits read/writableness from SimTask.

No action is required by the entity while it is in the waiting state.

task-type: DtWaitElapsedType

parameters: elapsed time - Length of time elapsed from the start of the simula- tion, in seconds. This struct is the FIXED portion of the simulation network representation of a wait duration task.

---

Constructor & Destructor Documentation

DtWaitElapsedTask::DtWaitElapsedTask

(

)

default constructor

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

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

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

copy constructor

virtual DtWaitElapsedTask::~DtWaitElapsedTask

(

)

[virtual]

---

Member Function Documentation

const DtWaitElapsedTask& DtWaitElapsedTask::operator=

(

const DtWaitElapsedTask &

orig

)

assignment operator

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

Creates a copy of this wait task.

Implements DtSimTask.

virtual DtString DtWaitElapsedTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtWaitElapsedTask::setElapsedTime

(

DtReal

seconds

)

[virtual]

virtual DtReal DtWaitElapsedTask::elapsedTime

(

)

const [virtual]

virtual int DtWaitElapsedTask::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSimTask.

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtWaitElapsedTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtWaitElapsedTask::creator

(

)

[static]

---

Member Data Documentation

DtRwReal DtWaitElapsedTask::myElapsedTime [protected]

---

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

• include/vrftasks/waitElpsdTask.h