DtTopLevelOrganizationController Class Reference

DtTopLevelOrganizationController; aggregate organization controller for a force-level aggregate entity. More...

Inheritance diagram for DtTopLevelOrganizationController:

List of all members.

Public Member Functions
	DtTopLevelOrganizationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtTopLevelOrganizationController ()
	destructor
virtual bool	init ()
	Calls setRadio()
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	Clears out myDesignatorsIssuedThisTick and calls DtPseudoAggregateOrganizationController::tick().
virtual bool	generateEchelonId (int designator)
	Generates an echelon id based on the provided designator, the local entity opd entry, and the current state of the organization hierarchy, and assigns the echelon id to the entity.
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 Types
typedef std::set< int >	DtIntSet
Protected Member Functions
virtual void	setCommandNetRadioChannel ()
	Sets the command net radio channel for this entity's radio to a predefined value based on the force.
virtual int	nextAvaliableDesignator ()
	Overridden from base class to look though all existing subordinates of the force level for an appropriate designator instead of just the listed subordinated.
virtual void	reorganize ()
	Does nothing.
virtual bool	reorganizeNeeded ()
	Returns false.
Protected Attributes
DtIntSet	myDesignatorsIssuedThisTick
	This keeps track of designators issued this tick so that the same designator is not issued to two objects in the same tick.
Private Member Functions
	DtTopLevelOrganizationController ()
	DtTopLevelOrganizationController (const DtTopLevelOrganizationController &orig)
	Not implemented.
DtTopLevelOrganizationController &	operator= (const DtTopLevelOrganizationController &orig)
	Not implemented.

---

Detailed Description

DtTopLevelOrganizationController; aggregate organization controller for a force-level aggregate entity.

DtTopLevelOrganizationController is the organization controller used in force level aggregates.

Developer Description: They are derived from pseudo-aggregate organization controllers, but override some functionallity to take into account the fact that there is a local top level aggregate on each backend.

Uses Descriptor Type: DtComponentDescriptor

---

Member Typedef Documentation

typedef std::set<int> DtTopLevelOrganizationController::DtIntSet [protected]

---

Constructor & Destructor Documentation

DtTopLevelOrganizationController::DtTopLevelOrganizationController

(

)

[private]

DtTopLevelOrganizationController::DtTopLevelOrganizationController

(

const DtTopLevelOrganizationController &

orig

)

[private]

Not implemented.

DtTopLevelOrganizationController::DtTopLevelOrganizationController	(	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 DtTopLevelOrganizationController::~DtTopLevelOrganizationController

(

)

[virtual]

destructor

---

Member Function Documentation

DtTopLevelOrganizationController& DtTopLevelOrganizationController::operator=

(

const DtTopLevelOrganizationController &

orig

)

[private]

Not implemented.

virtual bool DtTopLevelOrganizationController::init

(

)

[virtual]

Calls setRadio()

Reimplemented from DtOrganizationController.

virtual DtString DtTopLevelOrganizationController::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:

DtTopLevelOrganizationControllerType

Reimplemented from DtAggregateOrganizationController.

virtual void DtTopLevelOrganizationController::tick

(

)

[virtual]

Clears out myDesignatorsIssuedThisTick and calls DtPseudoAggregateOrganizationController::tick().

Reimplemented from DtAggregateOrganizationController.

virtual bool DtTopLevelOrganizationController::generateEchelonId

(

int

designator

)

[virtual]

Generates an echelon id based on the provided designator, the local entity opd entry, and the current state of the organization hierarchy, and assigns the echelon id to the entity.

Returns true if the newly generated id is different from the currnet one.

Reimplemented from DtOrganizationController.

static DtSimComponent* DtTopLevelOrganizationController::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.

Reimplemented from DtAggregateOrganizationController.

virtual void DtTopLevelOrganizationController::setCommandNetRadioChannel

(

)

[protected, virtual]

Sets the command net radio channel for this entity's radio to a predefined value based on the force.

(1 Force = 1, 2 Force = 2). This is a special naming scheme used for top level aggregates.

Reimplemented from DtAggregateOrganizationController.

virtual int DtTopLevelOrganizationController::nextAvaliableDesignator

(

)

[protected, virtual]

Overridden from base class to look though all existing subordinates of the force level for an appropriate designator instead of just the listed subordinated.

Needed since each backend locally simulates the force level aggregates.

Reimplemented from DtAggregateOrganizationController.

virtual void DtTopLevelOrganizationController::reorganize

(

)

[protected, virtual]

Does nothing.

Overridden from base class because top level objects cannot do reorganization since they are not published and exist on each backend independently.

Reimplemented from DtAggregateOrganizationController.

virtual bool DtTopLevelOrganizationController::reorganizeNeeded

(

)

[protected, virtual]

Returns false.

Overridden from base class because top level objects cannot do reorganization since they are not published and exist on each backend independently.

Reimplemented from DtAggregateOrganizationController.

---

Member Data Documentation

DtIntSet DtTopLevelOrganizationController::myDesignatorsIssuedThisTick [protected]

This keeps track of designators issued this tick so that the same designator is not issued to two objects in the same tick.

At the start of each tick, this set is cleared.

---

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

• include/vrfmodel/topLevOrgCtrl.h