DtDisaggregatedWaitController Class Reference

DtPseudoAggregateWaitController models waiting behavior for aggregate entities. More...

Inheritance diagram for DtDisaggregatedWaitController:

List of all members.

Public Member Functions
	DtDisaggregatedWaitController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtDisaggregatedWaitController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual bool	init ()
	Override to create the DtWaitingPSR process state repository.
virtual void	tick ()
	Override to do nothing - subordinates will carry out the task.
virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register it's interest in wait* commands.
virtual void	processTaskComplete (DtSimMessage *msg)
	Processes task complete reports.
virtual void	processWaitTask (DtSimMessage *msg, DtSimTaskStatePtr taskState)
	Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of wait tasks.
virtual void	processWaitDurationTask (DtSimMessage *msg, DtSimTaskStatePtr taskState)
	Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of wait tasks.
virtual void	processWaitElapsedTask (DtSimMessage *msg, DtSimTaskStatePtr taskState)
	Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of wait tasks.
Static Public Member Functions
static void	taskCompleteCallback (DtSimMessage *msg, void *usr)
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
	DtDisaggregatedWaitController ()
	Default constructor; should not be called.
	DtDisaggregatedWaitController (const DtDisaggregatedWaitController &orig)
	copy constructor; shallow; does not copy the ports.
const DtDisaggregatedWaitController &	operator= (const DtDisaggregatedWaitController &orig)
	assignment operator; see comments on copy constructor!
virtual void	forwardToSubordinates (const DtSimTask *task)
	Forwards task to each of its subordinates.
Protected Attributes
DtSimCommandRadio *	myCommandRadio

---

Detailed Description

DtPseudoAggregateWaitController models waiting behavior for aggregate entities.

End User Description: Registers for wait, wait duration, and wait elapsed task messages. When received, it forwards the messages on to its subordinates. It calls taskComplete() when it receives a taskComplete() from its lead subordinate. It is intended for use by disaggregated entities only.

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

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

(

)

[virtual]

destructor

DtDisaggregatedWaitController::DtDisaggregatedWaitController

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtDisaggregatedWaitController::DtDisaggregatedWaitController

(

const DtDisaggregatedWaitController &

orig

)

[protected]

copy constructor; shallow; does not copy the ports.

---

Member Function Documentation

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

DtPseudoAggregateWaitControllerType

Reimplemented from DtWaitController.

virtual bool DtDisaggregatedWaitController::init

(

)

[virtual]

Override to create the DtWaitingPSR process state repository.

Reimplemented from DtWaitController.

virtual void DtDisaggregatedWaitController::tick

(

)

[virtual]

Override to do nothing - subordinates will carry out the task.

Reimplemented from DtWaitController.

virtual void DtDisaggregatedWaitController::registerTaskMsgCallbacks

(

)

[virtual]

Overrides this so it can register it's interest in wait* commands.

Reimplemented from DtWaitController.

virtual void DtDisaggregatedWaitController::processWaitTask	(	DtSimMessage *	msg,
		DtSimTaskStatePtr	taskState
	)		[virtual]

Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of wait tasks.

Override to forward tasks to subordinates

Reimplemented from DtWaitController.

virtual void DtDisaggregatedWaitController::processWaitDurationTask	(	DtSimMessage *	msg,
		DtSimTaskStatePtr	taskState
	)		[virtual]

Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of wait tasks.

Override to forward tasks to subordinates

Reimplemented from DtWaitController.

virtual void DtDisaggregatedWaitController::processWaitElapsedTask	(	DtSimMessage *	msg,
		DtSimTaskStatePtr	taskState
	)		[virtual]

Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of wait tasks.

Override to forward tasks to subordinates

Reimplemented from DtWaitController.

virtual void DtDisaggregatedWaitController::processTaskComplete

(

DtSimMessage *

msg

)

[virtual]

Processes task complete reports.

When task complete is received from lead subordinate on the command net, sends task complete for the pseudo-aggregate.

static void DtDisaggregatedWaitController::taskCompleteCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static]

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

const DtDisaggregatedWaitController& DtDisaggregatedWaitController::operator=

(

const DtDisaggregatedWaitController &

orig

)

[protected]

assignment operator; see comments on copy constructor!

virtual void DtDisaggregatedWaitController::forwardToSubordinates

(

const DtSimTask *

task

)

[protected, virtual]

Forwards task to each of its subordinates.

---

Member Data Documentation

DtSimCommandRadio* DtDisaggregatedWaitController::myCommandRadio [protected]

---

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

• include/vrfmodel/disaggregatedWaitController.h