DtCombatRangeControllerDescriptor Class Reference

DtCombatRangeControllerDescriptor, descriptor for the DtCombatRangeController component. More...

Inheritance diagram for DtCombatRangeControllerDescriptor:

List of all members.

Public Member Functions
	DtCombatRangeControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtCombatRangeControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtCombatRangeControllerDescriptor (const DtCombatRangeControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtCombatRangeControllerDescriptor &	operator= (const DtCombatRangeControllerDescriptor &orig)
	assignment
virtual	~DtCombatRangeControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual const DtString &	rangeName () const
	Accessor/mutator for myRangeName.
virtual void	setRangeName (const DtString &rangeName)
	Accessor/mutator for myRangeName.
virtual double	combatRange () const
	Accessor/mutator for myCombatRange.
virtual void	setCombatRange (double combatRange)
	Accessor/mutator for myCombatRange.
virtual bool	useSubordinates () const
virtual void	setUseSubordinates (bool)
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtCombatRangeControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myRangeName
	Parameter Name: range-name Parameter Description: The name of the range rind if not using subordinates.
DtRwReal	myCombatRange
	Parameter Name: combat-range Parameter Description: The size of the range ring is not using subordinates.
DtRwBoolean	myUseSubordinates
	Parameter Name: use-subordinates Parameter Description: If an aggregate owns the combatRangeController, this flag determines whether the aggregate will poll subordinates for range items when disaggregated Parameter Default Value: false.

---

Detailed Description

DtCombatRangeControllerDescriptor, descriptor for the DtCombatRangeController component.

A DtComponentDescriptor that has additional information needed for providing parameters to a combat range controller. This controller is used by aggregates to register range rings either on a general basis (not looking at subordinates) or by iterating over subordinates and picking the largest range ring

---

Constructor & Destructor Documentation

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

constructor

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

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

copy constructor

virtual DtCombatRangeControllerDescriptor::~DtCombatRangeControllerDescriptor

(

)

[virtual]

destructor

DtCombatRangeControllerDescriptor::DtCombatRangeControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtCombatRangeControllerDescriptor& DtCombatRangeControllerDescriptor::operator=

(

const DtCombatRangeControllerDescriptor &

orig

)

assignment

virtual DtString DtCombatRangeControllerDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtCombatRangeControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtCombatRangeControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

virtual const DtString& DtCombatRangeControllerDescriptor::rangeName

(

)

const [virtual]

Accessor/mutator for myRangeName.

virtual void DtCombatRangeControllerDescriptor::setRangeName

(

const DtString &

rangeName

)

[virtual]

Accessor/mutator for myRangeName.

virtual double DtCombatRangeControllerDescriptor::combatRange

(

)

const [virtual]

Accessor/mutator for myCombatRange.

virtual void DtCombatRangeControllerDescriptor::setCombatRange

(

double

combatRange

)

[virtual]

Accessor/mutator for myCombatRange.

virtual bool DtCombatRangeControllerDescriptor::useSubordinates

(

)

const [virtual]

See also:

myUseSubordinates.

virtual void DtCombatRangeControllerDescriptor::setUseSubordinates

(

bool

)

[virtual]

See also:

myUseSubordinates.

static DtComponentDescriptor* DtCombatRangeControllerDescriptor::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 DtComponentDescriptor.

---

Member Data Documentation

DtRwString DtCombatRangeControllerDescriptor::myRangeName [protected]

Parameter Name: range-name
Parameter Description: The name of the range rind if not using subordinates.

Parameter Default Value:

DtRwReal DtCombatRangeControllerDescriptor::myCombatRange [protected]

Parameter Name: combat-range
Parameter Description: The size of the range ring is not using subordinates.

Parameter Default Value: 0.0
Parameter Units: meters

DtRwBoolean DtCombatRangeControllerDescriptor::myUseSubordinates [protected]

Parameter Name: use-subordinates
Parameter Description: If an aggregate owns the combatRangeController, this flag determines whether the aggregate will poll subordinates for range items when disaggregated Parameter Default Value: false.

---

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

• include/vrfobjparam/combatRangeCtlDesc.h