VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtTacticalSmokeParameters Class Reference
Inheritance diagram for DtTacticalSmokeParameters:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtTacticalSmokeParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 constructor with parameters to set up read/writability correctly
 DtTacticalSmokeParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtTacticalSmokeParameters ()
 destructor
const DtTacticalSmokeParametersoperator= (const DtTacticalSmokeParameters &orig)
 assignment operator
virtual DtVrfObjectParametersclone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParametersclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString type () const
 Should return the type of object this is a parameter block for.
virtual double deadReckoningDensityThreshold () const
virtual void setDeadReckoningDensityThreshold (double d)
virtual double deadReckoningSigmaThreshold () const
virtual void setDeadReckoningSigmaThreshold (double d)

Static Public Member Functions

static DtVrfObjectParameterscreator ()
 

Protected Member Functions

 DtTacticalSmokeParameters (const DtTacticalSmokeParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor. Use clone instead...
 DtTacticalSmokeParameters (const DtTacticalSmokeParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

Protected Attributes

parameters

These parameters are available for setting in the OPD files.

{@

DtRwReal myDrDensityThreshold
 Parameter Name: dr-density-threshold
Parameter Description: Indicates the dead reckoning threshold for density Parameter Default: 1 Parameter Units: percent change.
DtRwReal myDrSigmaThreshold
 Parameter Name: dr-sigma-threshold
Parameter Description: Indicates the dead reckoning threshold for sigma (puff expansion) Parameter Default Value: 1
Parameter Units: meters.

Constructor & Destructor Documentation

DtTacticalSmokeParameters::DtTacticalSmokeParameters ( const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
)

constructor with parameters to set up read/writability correctly

destructor

DtTacticalSmokeParameters::DtTacticalSmokeParameters ( const DtTacticalSmokeParameters orig,
const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
) [protected]

copy constructor. Use clone instead...

DtTacticalSmokeParameters::DtTacticalSmokeParameters ( const DtTacticalSmokeParameters orig,
const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) [protected]

Member Function Documentation

const DtTacticalSmokeParameters& DtTacticalSmokeParameters::operator= ( const DtTacticalSmokeParameters orig)

assignment operator

virtual DtVrfObjectParameters* DtTacticalSmokeParameters::clone ( const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]

Reimplemented from DtVrfObjectParameters.

virtual DtVrfObjectParameters* DtTacticalSmokeParameters::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]

Reimplemented from DtVrfObjectParameters.

virtual DtString DtTacticalSmokeParameters::type ( ) const [virtual]

Should return the type of object this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtVrfObjectParameters.

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 DtVrfObjectParameters.

virtual double DtTacticalSmokeParameters::deadReckoningSigmaThreshold ( ) const [virtual]
virtual void DtTacticalSmokeParameters::setDeadReckoningSigmaThreshold ( double  d) [virtual]

Member Data Documentation

Parameter Name: dr-density-threshold
Parameter Description: Indicates the dead reckoning threshold for density Parameter Default: 1 Parameter Units: percent change.

Parameter Name: dr-sigma-threshold
Parameter Description: Indicates the dead reckoning threshold for sigma (puff expansion) Parameter Default Value: 1
Parameter Units: meters.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)