DtInterceptAndDestroyTask Class Reference

File: interceptAndDestroyTask.h. More...

Inheritance diagram for DtInterceptAndDestroyTask:

List of all members.

Public Member Functions
	DtInterceptAndDestroyTask ()
	default constructor
	DtInterceptAndDestroyTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtInterceptAndDestroyTask (const DtString &writeName, const DtInterceptAndDestroyTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtInterceptAndDestroyTask &	operator= (const DtInterceptAndDestroyTask &orig)
	assignment operator
virtual	~DtInterceptAndDestroyTask ()
virtual int	type () const
	Returns DtInterceptAndDestroyTaskType from radioMsgTypes.h.
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 DtString	targetName () const
	Get/set the name of the object into which the entity should crash.
virtual void	setTargetName (const DtString &name)
virtual double	standOffDistance () const
	Get/set the distance away from the target the entity should stop.
virtual void	setStandOffDistance (const double dis)
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 Member Functions
virtual DtString	parameterStringRep () const
	Get a readable string representation of the paramaters.
Protected Attributes
DtRwString	myTargetName
DtRwReal	myInterceptStandoffDistance

---

Detailed Description

File: interceptAndDestroyTask.h.

Class: DtInterceptAndDestroyTask DtInterceptAndDestroyTask is a task message intended to order an entity to manuver itself to crash directly into a target object. The target object may be an entity, waypoint, etc.

---

Constructor & Destructor Documentation

DtInterceptAndDestroyTask::DtInterceptAndDestroyTask

(

)

default constructor

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

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

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

copy constructor

virtual DtInterceptAndDestroyTask::~DtInterceptAndDestroyTask

(

)

[virtual]

---

Member Function Documentation

const DtInterceptAndDestroyTask& DtInterceptAndDestroyTask::operator=

(

const DtInterceptAndDestroyTask &

orig

)

assignment operator

virtual int DtInterceptAndDestroyTask::type

(

)

const [virtual]

Returns DtInterceptAndDestroyTaskType from radioMsgTypes.h.

Implements DtSimTask.

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

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtInterceptAndDestroyTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual DtString DtInterceptAndDestroyTask::targetName

(

)

const [virtual]

Get/set the name of the object into which the entity should crash.

virtual void DtInterceptAndDestroyTask::setTargetName

(

const DtString &

name

)

[virtual]

virtual double DtInterceptAndDestroyTask::standOffDistance

(

)

const [virtual]

Get/set the distance away from the target the entity should stop.

virtual void DtInterceptAndDestroyTask::setStandOffDistance

(

const double

dis

)

[virtual]

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtInterceptAndDestroyTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtInterceptAndDestroyTask::creator

(

)

[static]

virtual DtString DtInterceptAndDestroyTask::parameterStringRep

(

)

const [protected, virtual]

Get a readable string representation of the paramaters.

---

Member Data Documentation

DtRwString DtInterceptAndDestroyTask::myTargetName [protected]

DtRwReal DtInterceptAndDestroyTask::myInterceptStandoffDistance [protected]

---

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

• include/vrftasks/interceptAndDestroyTask.h