DtAggregatedSetController Class Reference

DtAggregatedSetController is a controller that handles new DtSetTrueAggregateMode. More...

Inheritance diagram for DtAggregatedSetController:

List of all members.

Public Member Functions
	DtAggregatedSetController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtAggregatedSetController ()
	destructor
virtual void	processSetTrueAggregateTaskNotify (const DtSimTask &task)
virtual void	enable ()
	Override to add set data request callbacks and update formation state and bounding geometry.
virtual void	disable ()
	Override to remove set data request callbacks.
virtual bool	init ()
	Override to intialize bounding geometry, based on formation state.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
Static Public Member Functions
static void	setTrueAggregateTaskNotifyCallback (const DtSimTask &task, const DtSimComponent &notifier, void *usr)
static void	setFormationCallback (DtSimMessage *msg, void *usr)
	Callback for DtSetFormationRequest set data requests.
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	setRadio (DtSimRadio *radio)
	Overrides this so it can register its interest in the set commands.
virtual void	addSetDataCallbacks ()
	Add set data request callbacks.
void	removeSetDataCallbacks ()
	Callbacks are removed when component is disabled or destroyed.
virtual void	processSetFormation (DtSimMessage *msg)
	Handler for setFormationCallback().
virtual bool	getFormation (const DtString &formationName, const DtAggregateObjectParameters &parameterEntry, DtFormation &formation)
virtual void	updateBoundingGeometry ()
virtual void	lookupAndCacheProcessSR ()
	This function looks up a process state repository in the process state repository manager by name, and caches a pointer to it in myProcessState.
Protected Attributes
const DtSimTask *	mySimTask
DtVrfAggregateStateRepository *	myAggregateStateRepository
DtAggregatedResolutionPSR *	myAggregatedResolutionProcessState
	Pointer to a process state repository used to store state data associated with this component.
Private Member Functions
	DtAggregatedSetController ()
	Default constructor; should not be called.
	DtAggregatedSetController (const DtAggregatedSetController &orig)
	copy constructor
const DtAggregatedSetController &	operator= (const DtAggregatedSetController &orig)
	assignment operator

---

Detailed Description

DtAggregatedSetController is a controller that handles new DtSetTrueAggregateMode.

It replaces the existing DtControllerComponent

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtAggregatedSetController::DtAggregatedSetController

(

)

[private]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtAggregatedSetController::DtAggregatedSetController

(

const DtAggregatedSetController &

orig

)

[private]

copy constructor

---

Member Function Documentation

virtual void DtAggregatedSetController::processSetTrueAggregateTaskNotify

(

const DtSimTask &

task

)

[virtual]

virtual void DtAggregatedSetController::enable

(

)

[virtual]

Override to add set data request callbacks and update formation state and bounding geometry.

Reimplemented from DtLocalEntitySetController.

virtual void DtAggregatedSetController::disable

(

)

[virtual]

Override to remove set data request callbacks.

Reimplemented from DtLocalEntitySetController.

virtual bool DtAggregatedSetController::init

(

)

[virtual]

Override to intialize bounding geometry, based on formation state.

Reimplemented from DtLocalEntitySetController.

virtual bool DtAggregatedSetController::postAddComponentsInit

(

)

[virtual]

Called after all components have been created, initialized and added to the component manager.

Override this function if you need to do any further initialization after all other components have been created.

Reimplemented from DtSimComponent.

static void DtAggregatedSetController::setTrueAggregateTaskNotifyCallback	(	const DtSimTask &	task,
		const DtSimComponent &	notifier,
		void *	usr
	)		[static]

static void DtAggregatedSetController::setFormationCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static]

Callback for DtSetFormationRequest set data requests.

Calls processSetFormation().

Parameters:

msg	Message containing a DtSetFormationRequest.
usr	Pointer to an instance of this class.

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

const DtAggregatedSetController& DtAggregatedSetController::operator=

(

const DtAggregatedSetController &

orig

)

[private]

assignment operator

virtual void DtAggregatedSetController::setRadio

(

DtSimRadio *

radio

)

[protected, virtual]

Overrides this so it can register its interest in the set commands.

Reimplemented from DtLocalEntitySetController.

virtual void DtAggregatedSetController::addSetDataCallbacks

(

)

[protected, virtual]

Add set data request callbacks.

Set data request callbacks are added when component is first created, and whenever component is enabled.

Reimplemented from DtLocalEntitySetController.

void DtAggregatedSetController::removeSetDataCallbacks

(

)

[protected]

Callbacks are removed when component is disabled or destroyed.

Non-virtual because it is called from the destructor.

Reimplemented from DtLocalEntitySetController.

virtual void DtAggregatedSetController::processSetFormation

(

DtSimMessage *

msg

)

[protected, virtual]

Handler for setFormationCallback().

Parameters:

msg	Message containing a DtSetFormationRequest.

virtual bool DtAggregatedSetController::getFormation	(	const DtString &	formationName,
		const DtAggregateObjectParameters &	parameterEntry,
		DtFormation &	formation
	)		[protected, virtual]

virtual void DtAggregatedSetController::updateBoundingGeometry

(

)

[protected, virtual]

virtual void DtAggregatedSetController::lookupAndCacheProcessSR

(

)

[protected, virtual]

This function looks up a process state repository in the process state repository manager by name, and caches a pointer to it in

myProcessState.

The name (if it exists) is given in the component descriptor (DtComponentDescriptor::processStateRepositoryName). If the name does not exist, it uses the appropriate default name defined in procSRTypes.h. Another component is responsible for creating and destroying the process state repository.

---

Member Data Documentation

const DtSimTask* DtAggregatedSetController::mySimTask [protected]

DtVrfAggregateStateRepository* DtAggregatedSetController::myAggregateStateRepository [protected]

DtAggregatedResolutionPSR* DtAggregatedSetController::myAggregatedResolutionProcessState [protected]

Pointer to a process state repository used to store state data associated with this component.

This process state repository is shared with other components. Another component is responsible for creating and destroying the process state repository. This state is saved and restored as part of a scenario (or checkpoint).

---

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

• include/vrfmodel/aggregatedSetController.h