DtAggregatedSetController Class Reference

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

Inheritance diagram for DtAggregatedSetController:

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.
virtual void	tick ()
	Tick to potentially timeout engagement results.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
Public Member Functions inherited from DtLocalEntitySetController
	DtLocalEntitySetController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtLocalEntitySetController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processSetForce (DtSimMessage *msg)
virtual void	processSetAppearance (DtSimMessage *msg)
virtual void	processSetCapabilities (DtSimMessage *msg)
virtual void	processSetAltitude (DtSimMessage *msg)
virtual void	processSetResource (DtSimMessage *msg)
virtual void	processSetSOR (DtSimMessage *msg)
virtual void	processSetSpeed (DtSimMessage *msg)
virtual void	processSetEngagementRules (DtSimMessage *msg)
virtual void	processSetRestore (DtSimMessage *msg)
virtual void	processSetConcealed (DtSimMessage *msg)
virtual void	processSetLocation (DtSimMessage *msg)
	Verifies that the message contains a DtSetLocationRequest and if so pulls the requested location out of the message.
virtual void	processSetSuperior (DtSimMessage *msg)
virtual void	setLocation (DtVector geocentricLocation)
	Converts geocentricLocation to local coordinates and then provides them to myLocalEntity->place.
virtual void	setLocation (DtVector geocentricLocation, bool &dataAvailable)
	dataAvailable will indicate whether all data needed was paged in.
virtual void	processSetHeading (DtSimMessage *msg)
	Verifies that the message contains a DtSetHeadingRequest and if so pulls the requested heading out of the message.
virtual void	setHeading (DtReal heading)
	Calls place on myLocalEntity with the requested heading.
virtual bool	tickWhileDestroyed () const
	Tick while destroyed so that sets that do some processing during tick can be resolved while the entity is destroyed - for example set location on terrain that is not yet loaded.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimRadio *	radio ()
	The radio this component is listening to.
virtual void	taskNotify (const DtSimTask &task)
	This is used by the entity to notify all controllers that a new task has been received.
virtual void	clearTask ()
	Called when you want to clear out this component's task state.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	preprocess ()
	Perform parallel preprocessing prior to tick and similar computations.
virtual void	parallelTick ()
	called in parallel
virtual void	preFirstTickInit ()
	called from preprocess if appropriate
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static void	setEngagementResultsCallback (DtSimMessage *msg, void *usr)
	Callback for DtSetEngagementResults set data requests.
static void	setTrueAggregateTaskNotifyCallback (const DtSimTask &task, const DtSimComponent &notifier, void *usr)
static void	setStatePropertiesCallback (DtSimMessage *msg, void *usr)
	Callback for DtSetStateProperties set data requests.
static void	setFormationCallback (DtSimMessage *msg, void *usr)
	Callback for DtSetFormationRequest set data requests.
static void	setResupplyModeCallback (DtSimMessage *msg, void *usr)
	Callback for DtSetResupplyModeRequest set data requests.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Static Public Member Functions inherited from DtLocalEntitySetController
static void	setHeadingCallback (DtSimMessage *msg, void *usrData)
static void	setForceCallback (DtSimMessage *msg, void *usrData)
static void	setLocationCallback (DtSimMessage *msg, void *usrData)
static void	setSuperiorCallback (DtSimMessage *msg, void *usrData)
static void	setAppearanceCallback (DtSimMessage *msg, void *usrData)
static void	setCapabilitiesCallback (DtSimMessage *msg, void *usrData)
static void	setAltitudeCallback (DtSimMessage *msg, void *usrData)
static void	setResourceCallback (DtSimMessage *msg, void *usrData)
static void	setSORCallback (DtSimMessage *msg, void *usrData)
static void	setSpeedCallback (DtSimMessage *msg, void *usrData)
static void	setEngagementRulesCallback (DtSimMessage *msg, void *usrData)
static void	setRestoreCallback (DtSimMessage *msg, void *usrData)
static void	setConcealedCallback (DtSimMessage *msg, void *usrData)

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 void	processSetEngagementResults (DtSimMessage *msg)
	Handler for setEngagementResultsCallback().
virtual void	processSetResupplyMode (DtSimMessage *msg)
	Handler for setResupplyModeCallback().
virtual void	processSetStateProperties (DtSimMessage *msg)
	Handler for setStatePropertiesCallback().
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 Member Functions inherited from DtLocalEntitySetController
	DtLocalEntitySetController ()
	Default constructor; should not be called.
	DtLocalEntitySetController (const DtLocalEntitySetController &orig)
	copy constructor
const DtLocalEntitySetController &	operator= (const DtLocalEntitySetController &orig)
	assignment operator
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT, common between preprocess and timedTick.
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
const DtSimTask *	mySimTask
DtVrfAggregateStateRepository *	myAggregateStateRepository
DtAggregatedResolutionPSR *	myAggregatedResolutionProcessState
	Pointer to a process state repository used to store state data associated with this component.
Protected Attributes inherited from DtLocalEntitySetController
DtVrfObject *	myLocalEntity
	Cached pointer to parent object.
DtLocalEntitySetControllerPSR *	myProcessState
	Container for state data associated with this component.
Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
	Controller components can send messages.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptor *	myComponentDescriptor
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtAggregatedSetController ()
	Default constructor; should not be called.
	DtAggregatedSetController (const DtAggregatedSetController &orig)
	copy constructor
const DtAggregatedSetController &	operator= (const DtAggregatedSetController &orig)
	assignment operator

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

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::setEngagementResultsCallback ( DtSimMessage *  msg, void *  usr  )

static

Callback for DtSetEngagementResults set data requests.

Calls processSetEngagementResults().

Parameters

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

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

static

static void DtAggregatedSetController::setStatePropertiesCallback ( DtSimMessage *  msg, void *  usr  )

static

Callback for DtSetStateProperties set data requests.

Calls procesSetStateProperties().

Parameters

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

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 void DtAggregatedSetController::setResupplyModeCallback ( DtSimMessage *  msg, void *  usr  )

static

Callback for DtSetResupplyModeRequest set data requests.

Calls processSetResupplyMode().

Parameters

msg	Message containing a DtSetResupplyModeRequest.
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.

virtual void DtAggregatedSetController::tick ( )

virtual

Tick to potentially timeout engagement results.

Reimplemented from DtLocalEntitySetController.

virtual void DtAggregatedSetController::setIsEnabled ( bool  yesNo )

virtual

Is this component enabled or not.

If enabled, component's tick function will be called, otherwise it will not. Default is true (enabled).

Reimplemented from DtSimComponent.

const DtAggregatedSetController& DtAggregatedSetController::operator= ( const DtAggregatedSetController &  orig )

private

assignment operator

virtual void DtAggregatedSetController::setRadio ( DtSimRadio *  radio )

protectedvirtual

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

Reimplemented from DtLocalEntitySetController.

virtual void DtAggregatedSetController::addSetDataCallbacks ( )

protectedvirtual

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 )

protectedvirtual

Handler for setFormationCallback().

Parameters

msg	Message containing a DtSetFormationRequest.

virtual void DtAggregatedSetController::processSetEngagementResults ( DtSimMessage *  msg )

protectedvirtual

Handler for setEngagementResultsCallback().

Parameters

msg	Message containing a DtSetEngagementResults.

virtual void DtAggregatedSetController::processSetResupplyMode ( DtSimMessage *  msg )

protectedvirtual

Handler for setResupplyModeCallback().

Parameters

msg	Message containing a DtSetResupplyModeRequest.

virtual void DtAggregatedSetController::processSetStateProperties ( DtSimMessage *  msg )

protectedvirtual

Handler for setStatePropertiesCallback().

Parameters

msg	Message containing a DtSetStateProperties.

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

protectedvirtual

virtual void DtAggregatedSetController::updateBoundingGeometry ( )

protectedvirtual

virtual void DtAggregatedSetController::lookupAndCacheProcessSR ( )

protectedvirtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/aggregatedSetController.h