DtTacticalSmokeActuatorDescriptor Class Reference

DtTacticalSmokeActuatorDescriptor; descriptor for the DtTacticalSmokeActuator component. More...

Inheritance diagram for DtTacticalSmokeActuatorDescriptor:

List of all members.

Public Member Functions
	DtTacticalSmokeActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtTacticalSmokeActuatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtTacticalSmokeActuatorDescriptor (const DtTacticalSmokeActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtTacticalSmokeActuatorDescriptor &	operator= (const DtTacticalSmokeActuatorDescriptor &orig)
	assignment
virtual	~DtTacticalSmokeActuatorDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual double	dissipationTimeInMinutes () const
virtual void	setDissipationTimeInMinutes (double time)
virtual double	growthRate () const
virtual void	setGrowthRate (double value)
virtual double	maxRadius () const
virtual void	setMaxRadius (double value)
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtTacticalSmokeActuatorDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myDissipationTime
	Parameter Name: dissapation-time Parameter Description: The time is takes a cloud to go from 100% density to 0% (in minutes) Parameter Units: minutes Parameter Default Value: 4 .
DtRwReal	myGrowthRate
	Parameter Name: growth-rate Parameter Description: Rate at which the cloud grows.
DtRwReal	myMaxRadius
	Parameter Name: max-radius Parameter Description: Maximum radius (sigma size) the cloud will grow to, before it stops growing.

---

Detailed Description

DtTacticalSmokeActuatorDescriptor; descriptor for the DtTacticalSmokeActuator component.

Class DtTacticalSmokeActuatorDescriptor: A DtActuatorComponentDescriptor that has parameters that indicate the initial settings for the tactical smoke actuator

---

Constructor & Destructor Documentation

DtTacticalSmokeActuatorDescriptor::DtTacticalSmokeActuatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtTacticalSmokeActuatorDescriptor::DtTacticalSmokeActuatorDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtTacticalSmokeActuatorDescriptor::DtTacticalSmokeActuatorDescriptor	(	const DtTacticalSmokeActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtTacticalSmokeActuatorDescriptor::~DtTacticalSmokeActuatorDescriptor

(

)

[virtual]

destructor

DtTacticalSmokeActuatorDescriptor::DtTacticalSmokeActuatorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtTacticalSmokeActuatorDescriptor& DtTacticalSmokeActuatorDescriptor::operator=

(

const DtTacticalSmokeActuatorDescriptor &

orig

)

assignment

virtual DtString DtTacticalSmokeActuatorDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

This will be used to create the descriptor on read from an mtl file.

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtTacticalSmokeActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

static DtComponentDescriptor* DtTacticalSmokeActuatorDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtActuatorComponentDescriptor.

virtual double DtTacticalSmokeActuatorDescriptor::dissipationTimeInMinutes

(

)

const [virtual]

See also:

myDissipationTime

virtual void DtTacticalSmokeActuatorDescriptor::setDissipationTimeInMinutes

(

double

time

)

[virtual]

See also:

myDissipationTime

virtual double DtTacticalSmokeActuatorDescriptor::growthRate

(

)

const [virtual]

See also:

myGrowthRate

virtual void DtTacticalSmokeActuatorDescriptor::setGrowthRate

(

double

value

)

[virtual]

See also:

myGrowthRate

virtual double DtTacticalSmokeActuatorDescriptor::maxRadius

(

)

const [virtual]

See also:

myMaxRadius

virtual void DtTacticalSmokeActuatorDescriptor::setMaxRadius

(

double

value

)

[virtual]

See also:

myMaxRadius

---

Member Data Documentation

DtRwReal DtTacticalSmokeActuatorDescriptor::myDissipationTime [protected]

Parameter Name: dissapation-time
Parameter Description: The time is takes a cloud to go from 100% density to 0% (in minutes) Parameter Units: minutes Parameter Default Value: 4
.

DtRwReal DtTacticalSmokeActuatorDescriptor::myGrowthRate [protected]

Parameter Name: growth-rate
Parameter Description: Rate at which the cloud grows.

Parameter Units: meters/second
Parameter Default Value: 0.166

DtRwReal DtTacticalSmokeActuatorDescriptor::myMaxRadius [protected]

Parameter Name: max-radius
Parameter Description: Maximum radius (sigma size) the cloud will grow to, before it stops growing.

Parameter Units: meters
Parameter Default Value: 5

---

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

• include/vrfobjparam/tacticalSmokeActDesc.h