DtLaunchSmokeTask Class Reference

Instances of DtLaunchSmokeTask represent entity smoke grenade/bomb commands. More...

Inheritance diagram for DtLaunchSmokeTask:

List of all members.

Public Member Functions
	DtLaunchSmokeTask ()
	default constructor
	DtLaunchSmokeTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtLaunchSmokeTask ()
	destructor
	DtLaunchSmokeTask (const DtString &writeName, const DtLaunchSmokeTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor - not implemented
DtLaunchSmokeTask &	operator= (const DtLaunchSmokeTask &orig)
	assignment operator - not implemented
virtual int	type () const
	Returns DtLaunchSmokeTaskType (defined in radioMsgTypes.h).
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of the task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
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.
virtual const bool	launchAtNearestThreat () const
	Indicates whether the smoke should be launched toward the nearest threat, or at a specific heading.
virtual void	setLaunchAtNearestThreat (bool v)
	Indicates whether the smoke should be launched toward the nearest threat, or at a specific heading.
virtual double	launchHeading () const
	A user-specified heading in which to throw the smoke bomb.
virtual void	setLaunchHeading (double heading)
	A user-specified heading in which to throw the smoke bomb.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwBoolean	myLaunchAtNearestThreat
DtRwReal	myLaunchHeading

---

Detailed Description

Instances of DtLaunchSmokeTask represent entity smoke grenade/bomb commands.

This task can be specified in two ways: Either to launch the smoke grenade at a specific compass heading, or to launch the smoke toward the closest perceived threat entity.

---

Constructor & Destructor Documentation

DtLaunchSmokeTask::DtLaunchSmokeTask

(

)

default constructor

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

constructor

virtual DtLaunchSmokeTask::~DtLaunchSmokeTask

(

)

[virtual]

destructor

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

copy constructor - not implemented

---

Member Function Documentation

DtLaunchSmokeTask& DtLaunchSmokeTask::operator=

(

const DtLaunchSmokeTask &

orig

)

assignment operator - not implemented

virtual int DtLaunchSmokeTask::type

(

)

const [virtual]

Returns DtLaunchSmokeTaskType (defined in radioMsgTypes.h).

Implements DtSimTask.

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

Creates a copy of the task.

Implements DtSimTask.

virtual DtString DtLaunchSmokeTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual const bool DtLaunchSmokeTask::launchAtNearestThreat

(

)

const [virtual]

Indicates whether the smoke should be launched toward the nearest threat, or at a specific heading.

Default value is True.

virtual void DtLaunchSmokeTask::setLaunchAtNearestThreat

(

bool

v

)

[virtual]

Indicates whether the smoke should be launched toward the nearest threat, or at a specific heading.

Default value is True.

virtual double DtLaunchSmokeTask::launchHeading

(

)

const [virtual]

A user-specified heading in which to throw the smoke bomb.

Only applicable when launchAtNearestThreat() is false.

virtual void DtLaunchSmokeTask::setLaunchHeading

(

double

heading

)

[virtual]

A user-specified heading in which to throw the smoke bomb.

Only applicable when launchAtNearestThreat() is false.

virtual int DtLaunchSmokeTask::netRepSize

(

)

const [virtual]

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

Be sure to call the base class's netRepSize() and add the returned value in computation of overall size of network representation.

Reimplemented from DtSimTask.

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

Fills in the task from the network buffer.

Be sure to call down to the base class's setFromNet() to ensure that the entire message is set from the network representation.

Reimplemented from DtSimTask.

virtual bool DtLaunchSmokeTask::setToNet

(

)

[virtual]

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

Be sure to call down to base class's setToNet() to ensure complete contents of the message are set in the network representation.

Reimplemented from DtSimTask.

static DtSimTask* DtLaunchSmokeTask::creator

(

)

[static]

---

Member Data Documentation

DtRwBoolean DtLaunchSmokeTask::myLaunchAtNearestThreat [protected]

DtRwReal DtLaunchSmokeTask::myLaunchHeading [protected]

---

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

• include/vrftasks/launchSmokeTask.h