DtLaunchExpendableResourceController Class Reference

End User Description: This controller handles DtLaunchExpendableResourceTask tasks. More...

Inheritance diagram for DtLaunchExpendableResourceController:

Public Member Functions
	DtLaunchExpendableResourceController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtLaunchExpendableResourceController ()
	destructor
	DtLaunchExpendableResourceController (const DtLaunchExpendableResourceController &orig)
	copy constructor
DtLaunchExpendableResourceController &	operator= (const DtLaunchExpendableResourceController &orig)
	assignment operator
virtual DtString	type () const
	This returns the string DtLaunchExpendableResourceControllerType, used to uniquely identify the type of component.
virtual void	registerTaskMsgCallbacks ()
	Register a callback for task notification.
virtual void	processLaunchExpendableResourceTask (DtSimMessage *msg)
	Called by LaunchExpendableResourceTaskCallback() when a new DtLaunchExpendableResourceTask message is received.
virtual void	processSetAutoLaunchEnabled (DtSimMessage *msg)
	Called by setAutoLaunchEnabledCallback, will enable or disable the autolaunch feature of this controller.
virtual bool	init ()
	Calculates myPoints, myArcRange from the descriptor parameters and stores them for use when the ExpendableResource is launched.
virtual void	preFirstTickInit ()
	Sets up myTimeInterval and myResourceName based current the current task (if available).
virtual void	tick ()
	Checks if the desired interval of time between firing of the resources has passed.
virtual void	taskComplete (bool success=true)
	Override parent class so we can clean out auto launched subtasks properly.
virtual DtMunitionResource *	lookupExpendableResource (const DtString &resourceName)
	Look up the desired resource to launch.
virtual bool	launchExpendableResources (int numberToFire)
	Launch desired number of resources.
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtSingleTaskControllerComponent ()
	destructor
virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task.
virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void	clearTask ()
	If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.
virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself.
virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component.
virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks.
virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller.
virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id.
virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
	This function is used to determine if the controller should give up trying to execute the current task.
virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true.
virtual bool	taskActive (int taskId) const
virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller.
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimBaseRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks().
virtual void	disable ()
	Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
	The current tasked state of this controller.
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 DtSimBaseRadio *	radio ()
	The radio this component is listening to.
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 bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
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 DtFilename &searchPath, 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
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static void	launchExpendableResourceTaskCallback (DtSimMessage *msg, void *usr)
	Callback function (registered in registerTaskMsgCallbacks()) for DtLaunchExpendableResource task messages.
static void	setAutoLaunchEnabledCallback (DtSimMessage *msg, void *usr)
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry)
	This is called by the factory.

Protected Member Functions
virtual bool	createPSR ()
	Called by init to create the process state repository.
virtual bool	autoLaunchTriggered ()
	Evaluates if the entity should automatically launch its resources.
virtual DtString	selectResourceForAutoLaunch (const DtObjectType &missileType)
virtual void	setupAutoLaunchTriggerList ()
virtual void	setUpAutoLaunchTaskFromDescriptor ()
DtVrfObject *	createResourceObject (const DtObjectType &objType)
	Creates the desired resource of object type objType. Returns the created vrfobject.
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type.

Protected Attributes
const DtLaunchExpendableResourceControllerDescriptor *	myDesc
DtLaunchExpendableResourcePSR *	myProcessState
	Saved out in the Order of Battle file(.oob).This will save out how many resources we have left to fire.
double	myTimeInterval
DtString	myResourceName
int	myNumberPerInterval
DtLaunchExpendableResourceTask *	myAutoLaunchTask
DtManagedObjectListConstPtr	myAutoDetectObjectsList

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::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

End User Description: This controller handles DtLaunchExpendableResourceTask tasks.

When it receives this task, the entity will check if the resource is available and if so will launch it with desired intial velocity specified in the descriptor. Uses Descriptor Type: DtLaunchExpendableResourceControllerDescriptor

Constructor & Destructor Documentation

DtLaunchExpendableResourceController::DtLaunchExpendableResourceController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = NULL,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

virtual DtLaunchExpendableResourceController::~DtLaunchExpendableResourceController ( )

virtual

destructor

DtLaunchExpendableResourceController::DtLaunchExpendableResourceController

(

const DtLaunchExpendableResourceController &

orig

)

copy constructor

Member Function Documentation

DtLaunchExpendableResourceController& DtLaunchExpendableResourceController::operator=

(

const DtLaunchExpendableResourceController &

orig

)

assignment operator

virtual DtString DtLaunchExpendableResourceController::type ( ) const

virtual

This returns the string DtLaunchExpendableResourceControllerType, used to uniquely identify the type of component.

Implements DtTaskControllerComponent.

virtual void DtLaunchExpendableResourceController::registerTaskMsgCallbacks ( )

virtual

Register a callback for task notification.

Reimplemented from DtTaskControllerComponent.

static void DtLaunchExpendableResourceController::launchExpendableResourceTaskCallback ( DtSimMessage *  msg, void *  usr  )

static

Callback function (registered in registerTaskMsgCallbacks()) for DtLaunchExpendableResource task messages.

Calls processLaunchExpendableResourceTask() to actually handle the task.

static void DtLaunchExpendableResourceController::setAutoLaunchEnabledCallback ( DtSimMessage *  msg, void *  usr  )

static

virtual void DtLaunchExpendableResourceController::processLaunchExpendableResourceTask ( DtSimMessage *  msg )

virtual

Called by LaunchExpendableResourceTaskCallback() when a new DtLaunchExpendableResourceTask message is received.

virtual void DtLaunchExpendableResourceController::processSetAutoLaunchEnabled ( DtSimMessage *  msg )

virtual

Called by setAutoLaunchEnabledCallback, will enable or disable the autolaunch feature of this controller.

virtual bool DtLaunchExpendableResourceController::init ( )

virtual

Calculates myPoints, myArcRange from the descriptor parameters and stores them for use when the ExpendableResource is launched.

Reimplemented from DtControllerComponent.

virtual void DtLaunchExpendableResourceController::preFirstTickInit ( )

virtual

Sets up myTimeInterval and myResourceName based current the current task (if available).

If autolaunch is not specified in the PSR, it is setup based on the settings from the descriptor.

Reimplemented from DtSimComponent.

virtual void DtLaunchExpendableResourceController::tick ( )

virtual

Checks if the desired interval of time between firing of the resources has passed.

if so it will call launchExpendableResources and fire the next batch of resources

Reimplemented from DtSimComponent.

virtual void DtLaunchExpendableResourceController::taskComplete ( bool  success = true )

virtual

Override parent class so we can clean out auto launched subtasks properly.

Reimplemented from DtSingleTaskControllerComponent.

static DtSimComponent* DtLaunchExpendableResourceController::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc, DtReaderWriterRegistry *  parentRegistry  )

static

This is called by the factory.

virtual DtMunitionResource* DtLaunchExpendableResourceController::lookupExpendableResource ( const DtString &  resourceName )

virtual

Look up the desired resource to launch.

If found returns it. For this controller we use munition resources because they store the entity type of the resource as well as the amount of the resource. We use this in the launchExp

virtual bool DtLaunchExpendableResourceController::launchExpendableResources ( int  numberToFire )

virtual

Launch desired number of resources.

Looks up the resource name from the task via the above function. Next it creates the desired number of resource objects and depletes the resource and updates the process state's number left to fire. If there are not enough resources to launch this interval launch whatever remains. If there are no resources to launch or the resource entity could not be created this function will return false;

virtual bool DtLaunchExpendableResourceController::createPSR ( )

protectedvirtual

Called by init to create the process state repository.

virtual bool DtLaunchExpendableResourceController::autoLaunchTriggered ( )

protectedvirtual

Evaluates if the entity should automatically launch its resources.

Default is to check if any missiles are with auto launch range of the entity. If so the entity is in danger and it will launch its default task of counter measures. Will check the missile type to determine whether to launch chaff or flare.

virtual DtString DtLaunchExpendableResourceController::selectResourceForAutoLaunch ( const DtObjectType &  missileType )

protectedvirtual

virtual void DtLaunchExpendableResourceController::setupAutoLaunchTriggerList ( )

protectedvirtual

virtual void DtLaunchExpendableResourceController::setUpAutoLaunchTaskFromDescriptor ( )

protectedvirtual

DtVrfObject* DtLaunchExpendableResourceController::createResourceObject ( const DtObjectType &  objType )

protected

Creates the desired resource of object type objType. Returns the created vrfobject.

Member Data Documentation

const DtLaunchExpendableResourceControllerDescriptor* DtLaunchExpendableResourceController::myDesc

protected

DtLaunchExpendableResourcePSR* DtLaunchExpendableResourceController::myProcessState

protected

Saved out in the Order of Battle file(.oob).This will save out how many resources we have left to fire.

double DtLaunchExpendableResourceController::myTimeInterval

protected

DtString DtLaunchExpendableResourceController::myResourceName

protected

int DtLaunchExpendableResourceController::myNumberPerInterval

protected

DtLaunchExpendableResourceTask* DtLaunchExpendableResourceController::myAutoLaunchTask

protected

DtManagedObjectListConstPtr DtLaunchExpendableResourceController::myAutoDetectObjectsList

protected

---

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

• include/vrfmodel/launchExpendableResourceController.h