DtIndirectFireController Class Reference

DtIndirectFireController is responsible for processing the fire for effect tasks including fire for effect on entity, target, and location. More...

Inheritance diagram for DtIndirectFireController:

Public Member Functions
	DtIndirectFireController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtIndirectFireController ()
	destructor
virtual bool	init ()
	Overridden to call createWeaponController()
virtual bool	postAddComponentsInit ()
	Override to invoke postAddComponentsInit() for our weapon controller we're managing directly.
virtual bool	createWeaponController ()
	Initializes myWeaponController.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	Determines if the weapon is ready to fire based on speed and the state of the munition loader.
virtual void	clearTask ()
	Overridden to deactivate the port group on myWeaponController when this controller completes a task.
virtual void	setMyFuzeToUse (DtDetonatorFuze fuzeToUse)
	mutator for myFuzeToUse
virtual DtDetonatorFuze	fuzeToUse () const
	accessor for myFuzeToUse
virtual void	calculateDesiredElevation (double rangeToTarget)
	Finds elevation angle for gun based on distance and max range (which implies a muzzle velocity).
virtual void	calculateDesiredAzimuth ()
	Finds azimuth angle and calls setDesiredAzimuth on myWeaponController's mounting controller.
double	findBodyHeadingToLocalPosition (DtVector localTargetPosition) const
	Calculates and returns the body heading to the target local position.
virtual void	chooseMaxRange (DtReal rangeToTarget)
	Sets myCurrentMaxRange to the appropriate maxRange for the given range to target (essentially choosing the size of the charge to use).
virtual void	setCurrentMaxRange (DtReal currentMaxRange)
	Set the current max range.
virtual DtReal	currentMaxRange () const
	Get the current max range.
virtual DtReal	absoluteMaxRange () const
	Returns the largest max range in max range list.
virtual bool	initializeController (const DtString &ammoType, int numberOfRounds, DtReal heightAboveTerrain)
	Sets up the controller with the given parameters.
virtual void	setCurrentTargetLocation (const DtVector &location)
	Set the current target location in the DtVrfIndirectFirePSR.
virtual const DtVector &	currentTargetLocation ()
	Get the current target location from the DtVrfIndirectFirePSR.
virtual void	registerTaskMsgCallbacks ()
	Overrides this so it can register its interest in fire for effect commands.
virtual void	processUserTask (DtSimMessage *msg)
	Called by userTaskCallback.
virtual void	processFFETask (DtTaskMessage *tm)
	Called by each of the processFFE methods to process the arguments in the base class of each of the FFE types, DtFireForEffectTask.
virtual bool	haveAmmo (const DtString &ammoName) const
	Returns true if lookupMunitionResource() can locate a resource with the given ammoName && the resource is not empty.
virtual const DtString &	findDefaultAmmo () const
	Goes through the ammo list in myIndFireDescriptor and returns the first ammo type for which haveAmmo() returns true.
virtual void	getMunitionFromResourceName (const DtString &resourceName, DtSimMunition &munition) const
	If lookupMunitionResource is able to locate the given resourceName, the given munition parameter will be assigned it's munitionType().
virtual DtMunitionResource *	lookupMunitionResource (const DtString &resource) const
	Attempts to locate the given resource in the entity's state repository, and if it is a DtMunitionResource, it will be returned.
virtual bool	processFFEOnTargetTask (DtSimMessage *msg)
	Processes the given FFE task.
virtual bool	processFFEOnLocationTask (DtSimMessage *msg)
	Processes the given FFE task.
virtual bool	processFFEOnEntityTask (DtSimMessage *msg)
	Processes the given FFE task.
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	taskComplete (bool success=true)
	If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
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 void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
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	FFEOnTargetCallback (DtSimMessage *msg, void *usr)
	Registered by registerTaskMsgCallbacks, calls processFFEOnTargetTask.
static void	FFEOnEntityCallback (DtSimMessage *msg, void *usr)
	Registered by registerTaskMsgCallbacks, calls processFFEOnEntityTask.
static void	FFEOnLocationCallback (DtSimMessage *msg, void *usr)
	Registered by registerTaskMsgCallbacks, calls processFFEOnLocationTask.
static void	userTaskCallback (DtSimMessage *msg, void *usr)
	Registered by registerTaskMsgCallbacks, calls processUserTask.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions
virtual bool	createPortGroups ()
	Overridden to add port groups from myWeaponController, allowing OPD connections to be specified using the name of this component.
virtual void	addRangeItems ()
	Adds all items that have a range to the object state repository.
	DtIndirectFireController ()
	default constructor; not implemented
	DtIndirectFireController (const DtIndirectFireController &orig)
	copy constructor; not implemented
const DtIndirectFireController &	operator= (const DtIndirectFireController &orig)
	assignment operator; not implemented
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
DtDetonatorFuze	myFuzeToUse
	Set based on height above terrain value.
DtReal	myCurrentMaxRange
DtSimMunition	myMunitionToUse
	This could just be a stack variable in tick, but since these are expensive to construct, we create on and reuse it.
DtIndirectFireWeaponController *	myWeaponController
DtIndirectFireControllerDescriptor *	myIndFireDescriptor
bool	myFirstTick
	Set to true after first tick.

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

DtIndirectFireController is responsible for processing the fire for effect tasks including fire for effect on entity, target, and location.

Uses Descriptor Type: DtIndirectFireControllerDescriptor

Constructor & Destructor Documentation

DtIndirectFireController::DtIndirectFireController	(	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 DtIndirectFireController::~DtIndirectFireController ( )

virtual

destructor

DtIndirectFireController::DtIndirectFireController ( )

protected

default constructor; not implemented

DtIndirectFireController::DtIndirectFireController ( const DtIndirectFireController &  orig )

protected

copy constructor; not implemented

Member Function Documentation

virtual bool DtIndirectFireController::init ( )

virtual

Overridden to call createWeaponController()

Reimplemented from DtControllerComponent.

virtual bool DtIndirectFireController::postAddComponentsInit ( )

virtual

Override to invoke postAddComponentsInit() for our weapon controller we're managing directly.

Reimplemented from DtSimComponent.

virtual bool DtIndirectFireController::createWeaponController ( )

virtual

Initializes myWeaponController.

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

DtIndirectFireControllerType

Implements DtTaskControllerComponent.

virtual void DtIndirectFireController::tick ( )

virtual

Determines if the weapon is ready to fire based on speed and the state of the munition loader.

For a detailed description, please see the developer's guide. If myFirstTick is true, the checkpointed state of the controller is copied from the DtVrfIndirectFirePSR.

Reimplemented from DtSimComponent.

virtual void DtIndirectFireController::clearTask ( )

virtual

Overridden to deactivate the port group on myWeaponController when this controller completes a task.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtIndirectFireController::setMyFuzeToUse ( DtDetonatorFuze  fuzeToUse )

virtual

mutator for myFuzeToUse

virtual DtDetonatorFuze DtIndirectFireController::fuzeToUse ( ) const

virtual

accessor for myFuzeToUse

virtual void DtIndirectFireController::calculateDesiredElevation ( double  rangeToTarget )

virtual

Finds elevation angle for gun based on distance and max range (which implies a muzzle velocity).

Calls setDesiredElevation on myWeaponController's mounting controller.

virtual void DtIndirectFireController::calculateDesiredAzimuth ( )

virtual

Finds azimuth angle and calls setDesiredAzimuth on myWeaponController's mounting controller.

double DtIndirectFireController::findBodyHeadingToLocalPosition

(

DtVector

localTargetPosition

)

const

Calculates and returns the body heading to the target local position.

virtual void DtIndirectFireController::chooseMaxRange ( DtReal  rangeToTarget )

virtual

Sets myCurrentMaxRange to the appropriate maxRange for the given range to target (essentially choosing the size of the charge to use).

virtual void DtIndirectFireController::setCurrentMaxRange ( DtReal  currentMaxRange )

virtual

Set the current max range.

virtual DtReal DtIndirectFireController::currentMaxRange ( ) const

virtual

Get the current max range.

virtual DtReal DtIndirectFireController::absoluteMaxRange ( ) const

virtual

Returns the largest max range in max range list.

Assumes the maxRangeList is sorted in ascending order.

virtual bool DtIndirectFireController::initializeController ( const DtString &  ammoType, int  numberOfRounds, DtReal  heightAboveTerrain  )

virtual

Sets up the controller with the given parameters.

Should be called by processFFETask() when a task is received, or by tick() when a task is being restored by a checkpoint.

virtual void DtIndirectFireController::setCurrentTargetLocation ( const DtVector &  location )

virtual

Set the current target location in the DtVrfIndirectFirePSR.

virtual const DtVector& DtIndirectFireController::currentTargetLocation ( )

virtual

Get the current target location from the DtVrfIndirectFirePSR.

virtual void DtIndirectFireController::registerTaskMsgCallbacks ( )

virtual

Overrides this so it can register its interest in fire for effect commands.

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

Reimplemented from DtTaskControllerComponent.

static void DtIndirectFireController::FFEOnTargetCallback ( DtSimMessage *  msg, void *  usr  )

static

Registered by registerTaskMsgCallbacks, calls processFFEOnTargetTask.

static void DtIndirectFireController::FFEOnEntityCallback ( DtSimMessage *  msg, void *  usr  )

static

Registered by registerTaskMsgCallbacks, calls processFFEOnEntityTask.

static void DtIndirectFireController::FFEOnLocationCallback ( DtSimMessage *  msg, void *  usr  )

static

Registered by registerTaskMsgCallbacks, calls processFFEOnLocationTask.

static void DtIndirectFireController::userTaskCallback ( DtSimMessage *  msg, void *  usr  )

static

Registered by registerTaskMsgCallbacks, calls processUserTask.

virtual bool DtIndirectFireController::processFFEOnTargetTask ( DtSimMessage *  msg )

virtual

Processes the given FFE task.

Returns true if the message is processed, even if the processing is unsuccessful. Returns false if the processing cannot be immediately completed due to the required terrain not having yet been paged in. In that case the task will be stored in the PSR and the tick() function will keep re-trying the task until it returns true.

virtual bool DtIndirectFireController::processFFEOnLocationTask ( DtSimMessage *  msg )

virtual

Processes the given FFE task.

Returns true if the message is processed, even if the processing is unsuccessful. Returns false if the processing cannot be immediately completed due to the required terrain not having yet been paged in. In that case the task will be stored in the PSR and the tick() function will keep re-trying the task until it returns true.

virtual bool DtIndirectFireController::processFFEOnEntityTask ( DtSimMessage *  msg )

virtual

Processes the given FFE task.

Returns true if the message is processed, even if the processing is unsuccessful. Returns false if the processing cannot be immediately completed due to the required terrain not having yet been paged in. In that case the task will be stored in the PSR and the tick() function will keep re-trying the task until it returns true.

virtual void DtIndirectFireController::processUserTask ( DtSimMessage *  msg )

virtual

Called by userTaskCallback.

Accepts user task names of "ffe", "fft" and "ffl" for firing for effect on entity, target and location respectively. The first argument is the entity/target/location to shoot at. Creates a new task and forwards it to the appropriate "processFFE" method.

virtual void DtIndirectFireController::processFFETask ( DtTaskMessage *  tm )

virtual

Called by each of the processFFE methods to process the arguments in the base class of each of the FFE types, DtFireForEffectTask.

virtual bool DtIndirectFireController::haveAmmo ( const DtString &  ammoName ) const

virtual

Returns true if lookupMunitionResource() can locate a resource with the given ammoName && the resource is not empty.

virtual const DtString& DtIndirectFireController::findDefaultAmmo ( ) const

virtual

Goes through the ammo list in myIndFireDescriptor and returns the first ammo type for which haveAmmo() returns true.

virtual void DtIndirectFireController::getMunitionFromResourceName ( const DtString &  resourceName, DtSimMunition &  munition  ) const

virtual

If lookupMunitionResource is able to locate the given resourceName, the given munition parameter will be assigned it's munitionType().

virtual DtMunitionResource* DtIndirectFireController::lookupMunitionResource ( const DtString &  resource ) const

virtual

Attempts to locate the given resource in the entity's state repository, and if it is a DtMunitionResource, it will be returned.

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

virtual bool DtIndirectFireController::createPortGroups ( )

protectedvirtual

Overridden to add port groups from myWeaponController, allowing OPD connections to be specified using the name of this component.

Reimplemented from DtSimComponent.

virtual void DtIndirectFireController::addRangeItems ( )

protectedvirtual

Adds all items that have a range to the object state repository.

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

protected

assignment operator; not implemented

Member Data Documentation

DtDetonatorFuze DtIndirectFireController::myFuzeToUse

protected

Set based on height above terrain value.

DtReal DtIndirectFireController::myCurrentMaxRange

protected

DtSimMunition DtIndirectFireController::myMunitionToUse

protected

This could just be a stack variable in tick, but since these are expensive to construct, we create on and reuse it.

DtIndirectFireWeaponController* DtIndirectFireController::myWeaponController

protected

DtIndirectFireControllerDescriptor* DtIndirectFireController::myIndFireDescriptor

protected

bool DtIndirectFireController::myFirstTick

protected

Set to true after first tick.

---

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

• include/vrfmodel/indFireCtlr.h