DtDisaggregatedOccupancyDirectorController Class Reference

DtAggregateOccupancyDirectorController is an occupancy controller that handles occupancy (embarkation) requests for an aggregate entity. More...

Inheritance diagram for DtDisaggregatedOccupancyDirectorController:

List of all members.

Public Member Functions
	DtDisaggregatedOccupancyDirectorController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtDisaggregatedOccupancyDirectorController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processRequestEmbarkationInformation (DtSimMessage *msg)
virtual bool	init ()
	Calls setRadio()
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
static void	requestEmbarkationInformationCallback (DtSimMessage *msg, void *usr)
Protected Member Functions
virtual DtString	embarkableParent (const DtString &object) const
	Returns the parent that this object can embark on.
virtual void	processDisembarkObjectCallback (DtSimMessage *msg)
	Processes DtIfDisembarkObject if address to this object and it is a disembarkAll type message.
virtual void	sendTask (const DtSimTask &task, const DtString &to)
Static Protected Member Functions
static void	disembarkObjectCallback (DtSimMessage *msg, void *usr)
	Callback for responding to DtIfDisembarkObject messages.

---

Detailed Description

DtAggregateOccupancyDirectorController is an occupancy controller that handles occupancy (embarkation) requests for an aggregate entity.

End User Description: The DtAggregateOccupancyDirector is an extended form of DtOccupancyDirectorController that overrides how requests for embarkation information are handled.

This controller may only be configured as a part of an entity that has a vrf-aggregate-state-repository.

Developer Description: Forwards all requests to lead subordinate.

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

---

Member Function Documentation

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

DtAggregateOccupancyDirectorControllerType

Implements DtTaskControllerComponent.

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

static void DtDisaggregatedOccupancyDirectorController::requestEmbarkationInformationCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static]

virtual void DtDisaggregatedOccupancyDirectorController::processRequestEmbarkationInformation

(

DtSimMessage *

msg

)

[virtual]

virtual bool DtDisaggregatedOccupancyDirectorController::init

(

)

[virtual]

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual DtString DtDisaggregatedOccupancyDirectorController::embarkableParent

(

const DtString &

object

)

const [protected, virtual]

Returns the parent that this object can embark on.

If the requested object is a pseudo aggregate, the entity will actually embark on the "leader" of the pseudo aggregate

static void DtDisaggregatedOccupancyDirectorController::disembarkObjectCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static, protected]

Callback for responding to DtIfDisembarkObject messages.

virtual void DtDisaggregatedOccupancyDirectorController::processDisembarkObjectCallback

(

DtSimMessage *

msg

)

[protected, virtual]

Processes DtIfDisembarkObject if address to this object and it is a disembarkAll type message.

virtual void DtDisaggregatedOccupancyDirectorController::sendTask	(	const DtSimTask &	task,
		const DtString &	to
	)		[protected, virtual]

---

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

• include/vrfmodel/disaggregatedOccupancyDirectorController.h