DtCombatRangeController Class Reference

Uses Descriptor Type: DtCombatRangeControllerDescriptor. More...

Inheritance diagram for DtCombatRangeController:

List of all members.

Public Member Functions
	DtCombatRangeController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtCombatRangeController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual bool	init ()
	Calls setRadio()
virtual void	setRangeItems ()
	Sets whether or not to use subordinates as a means to add range rings.
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
virtual void	setRangeItemsFromDescriptor ()
	Sets to use combat range in descriptor.
virtual void	setRangeItemsFromSubordinates ()
	Sets to use subordinate ranges.
virtual void	tick ()
	If myCheckOnTick is true, call useSubordinateRange to check subordinate ranges.
virtual void	mergeRangeItems (const DtRangeItems &)
	Merges in the supplied range items with existing range items. If range item exists then takes the larger of the ranges.
virtual void	setRebuildRangeItemListOnNextTick (bool onOff)
virtual bool	rebuildRangeItemListOnNextTick ()
virtual bool	belongsToAggregate ()
Static Protected Member Functions
static void	subordinateChangedCallback (const DtSubordinateManager &subordinateManager, void *userData)
Protected Attributes
const DtCombatRangeControllerDescriptor *	myDescriptor
bool	myRebuildRangeItemListOnNextTick
DtVrfAggregateStateRepository *	myOwningAggregateSR
Private Member Functions
	DtCombatRangeController ()
	Not implemented.
	DtCombatRangeController (const DtCombatRangeController &orig)
	Not implemented.
const DtCombatRangeController &	operator= (const DtCombatRangeController &orig)
	Not implemented.

---

Detailed Description

Uses Descriptor Type: DtCombatRangeControllerDescriptor.

---

Constructor & Destructor Documentation

DtCombatRangeController::DtCombatRangeController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtCombatRangeController::~DtCombatRangeController

(

)

[virtual]

destructor

DtCombatRangeController::DtCombatRangeController

(

)

[private]

Not implemented.

DtCombatRangeController::DtCombatRangeController

(

const DtCombatRangeController &

orig

)

[private]

Not implemented.

---

Member Function Documentation

virtual DtString DtCombatRangeController::type

(

)

const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:

DtCombatRangeControllerType

Reimplemented from DtControllerComponent.

static DtSimComponent* DtCombatRangeController::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[static]

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:

New instance of this class.

virtual bool DtCombatRangeController::init

(

)

[virtual]

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual void DtCombatRangeController::setRangeItems

(

)

[virtual]

Sets whether or not to use subordinates as a means to add range rings.

If false will use default values as defined in the descriptor. If true will iterate over subordinates and add a range ring of each unique name type and maximum range for that name. It will also add callbacks for removal or addition of subordinates.

virtual void DtCombatRangeController::setRangeItemsFromDescriptor

(

)

[protected, virtual]

Sets to use combat range in descriptor.

Clears out all current range rings and adds a single new one based on the descriptor and name

virtual void DtCombatRangeController::setRangeItemsFromSubordinates

(

)

[protected, virtual]

Sets to use subordinate ranges.

Iterates over all subordinates and takes the greatest range of a particular named type. If subordinates have no ranges, and they are also aggregates, will check aggregates during tick until ranges show up

virtual void DtCombatRangeController::tick

(

)

[protected, virtual]

If myCheckOnTick is true, call useSubordinateRange to check subordinate ranges.

Reimplemented from DtSimComponent.

virtual void DtCombatRangeController::mergeRangeItems

(

const DtRangeItems &

)

[protected, virtual]

Merges in the supplied range items with existing range items. If range item exists then takes the larger of the ranges.

static void DtCombatRangeController::subordinateChangedCallback	(	const DtSubordinateManager &	subordinateManager,
		void *	userData
	)		[static, protected]

virtual void DtCombatRangeController::setRebuildRangeItemListOnNextTick

(

bool

onOff

)

[protected, virtual]

virtual bool DtCombatRangeController::rebuildRangeItemListOnNextTick

(

)

[protected, virtual]

virtual bool DtCombatRangeController::belongsToAggregate

(

)

[protected, virtual]

const DtCombatRangeController& DtCombatRangeController::operator=

(

const DtCombatRangeController &

orig

)

[private]

Not implemented.

---

Member Data Documentation

const DtCombatRangeControllerDescriptor* DtCombatRangeController::myDescriptor [protected]

bool DtCombatRangeController::myRebuildRangeItemListOnNextTick [protected]

DtVrfAggregateStateRepository* DtCombatRangeController::myOwningAggregateSR [protected]

---

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

• include/vrfmodel/combatRangeController.h