DtMoveIntoFormationTask Class Reference

File: moveIntoFormationTask.h. More...

Inheritance diagram for DtMoveIntoFormationTask:

List of all members.

Public Member Functions
	DtMoveIntoFormationTask ()
	default constructor
	DtMoveIntoFormationTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtMoveIntoFormationTask (const DtString &writeName, const DtMoveIntoFormationTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtMoveIntoFormationTask &	operator= (const DtMoveIntoFormationTask &orig)
	assignment operator
virtual	~DtMoveIntoFormationTask ()
virtual int	type () const
	Returns DtMoveIntoFormationTaskType.
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this movetoLocation task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual const DtVector &	location () const
	location (in geocentric coordinates) at which aggregate should get into formation
virtual void	setLocation (const DtVector &point)
virtual double	heading () const
	heading (in radians) at which aggregate should orient formation
virtual void	setHeading (double heading)
virtual DtString	formationName () const
virtual void	setFormationName (const DtString &formation)
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.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Overridden to read in the old formation enumeration and convert it to a formation name.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwVector	myLocation
DtRwReal	myHeading
DtRwString	myFormationName

---

Detailed Description

File: moveIntoFormationTask.h.

Class: DtMoveIntoFormationTask DtMoveIntoFormationTask is a task for getting an aggregate into formation at a given location and heading.

---

Constructor & Destructor Documentation

DtMoveIntoFormationTask::DtMoveIntoFormationTask

(

)

default constructor

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

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

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

copy constructor

virtual DtMoveIntoFormationTask::~DtMoveIntoFormationTask

(

)

[virtual]

---

Member Function Documentation

const DtMoveIntoFormationTask& DtMoveIntoFormationTask::operator=

(

const DtMoveIntoFormationTask &

orig

)

assignment operator

virtual int DtMoveIntoFormationTask::type

(

)

const [virtual]

Returns DtMoveIntoFormationTaskType.

Implements DtSimTask.

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

Creates a copy of this movetoLocation task.

Implements DtSimTask.

virtual DtString DtMoveIntoFormationTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual const DtVector& DtMoveIntoFormationTask::location

(

)

const [virtual]

location (in geocentric coordinates) at which aggregate should get into formation

virtual void DtMoveIntoFormationTask::setLocation

(

const DtVector &

point

)

[virtual]

virtual double DtMoveIntoFormationTask::heading

(

)

const [virtual]

heading (in radians) at which aggregate should orient formation

virtual void DtMoveIntoFormationTask::setHeading

(

double

heading

)

[virtual]

virtual DtString DtMoveIntoFormationTask::formationName

(

)

const [virtual]

virtual void DtMoveIntoFormationTask::setFormationName

(

const DtString &

formation

)

[virtual]

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtMoveIntoFormationTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

virtual void DtMoveIntoFormationTask::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath = DtFilename::nullFilename(),
		const DtVariableBindingsList &	variableBindings = nullVariableReference()
	)		[virtual]

Overridden to read in the old formation enumeration and convert it to a formation name.

static DtSimTask* DtMoveIntoFormationTask::creator

(

)

[static]

---

Member Data Documentation

DtRwVector DtMoveIntoFormationTask::myLocation [protected]

DtRwReal DtMoveIntoFormationTask::myHeading [protected]

DtRwString DtMoveIntoFormationTask::myFormationName [protected]

---

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

• include/vrftasks/moveIntoFormationTask.h