DtOrbitTask Class Reference

DtOrbitTask represents an orbit task for an entity to perform. More...

Inheritance diagram for DtOrbitTask:

List of all members.

Public Member Functions
	DtOrbitTask (const DtString &writeName, const DtOrbitTask &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtOrbitTask &	operator= (const DtOrbitTask &original)
	assignment operator
virtual	~DtOrbitTask ()
virtual int	type () const
	Returns "orbit".
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
	Creates a copy of this task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual void	setCenter (const DtVector &center)
	Point to orbit, in geocentric coordinates.
virtual DtVector	center () const
virtual void	setRadius (double radius)
	Orbital radius, in meters.
virtual double	radius () const
virtual void	setClockwise (bool clockwise)
	Direction to orbit.
virtual bool	clockwise () const
virtual int	netRepSize () const
	Returns the size of the network representation.
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.
	DtOrbitTask ()
	Constructors.
	DtOrbitTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructors.
	DtOrbitTask (const DtVector &newCenter, double newRadius, bool isClockwise)
	Constructors.
Static Public Member Functions
static DtSimTask *	creator ()
Private Attributes
DtRwVector	myCenter
DtRwReal	myRadius
DtRwBoolean	myClockwise

---

Detailed Description

DtOrbitTask represents an orbit task for an entity to perform.

It inherits read/writableness from SimTask, and includes the center point to orbit, the radius at which to orbit, and flag indicating clockwise or counter clockwise.

Only individual entities can receive this task. This task is never complete, and is only stopped when the entity is destroyed or re-tasked.

task-type: DtOrbitType

---

Constructor & Destructor Documentation

DtOrbitTask::DtOrbitTask

(

)

Constructors.

DtOrbitTask::DtOrbitTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructors.

DtOrbitTask::DtOrbitTask	(	const DtVector &	newCenter,
		double	newRadius,
		bool	isClockwise
	)

Constructors.

DtOrbitTask::DtOrbitTask	(	const DtString &	writeName,
		const DtOrbitTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtOrbitTask::~DtOrbitTask

(

)

[virtual]

---

Member Function Documentation

DtOrbitTask& DtOrbitTask::operator=

(

const DtOrbitTask &

original

)

assignment operator

virtual int DtOrbitTask::type

(

)

const [virtual]

Returns "orbit".

Implements DtSimTask.

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

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtOrbitTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtOrbitTask::setCenter

(

const DtVector &

center

)

[virtual]

Point to orbit, in geocentric coordinates.

virtual DtVector DtOrbitTask::center

(

)

const [virtual]

virtual void DtOrbitTask::setRadius

(

double

radius

)

[virtual]

Orbital radius, in meters.

virtual double DtOrbitTask::radius

(

)

const [virtual]

virtual void DtOrbitTask::setClockwise

(

bool

clockwise

)

[virtual]

Direction to orbit.

virtual bool DtOrbitTask::clockwise

(

)

const [virtual]

virtual int DtOrbitTask::netRepSize

(

)

const [virtual]

Returns the size of the network representation.

Reimplemented from DtSimTask.

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtOrbitTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtOrbitTask::creator

(

)

[static]

---

Member Data Documentation

DtRwVector DtOrbitTask::myCenter [private]

DtRwReal DtOrbitTask::myRadius [private]

DtRwBoolean DtOrbitTask::myClockwise [private]

---

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

• include/vrftasks/orbitTask.h