DtIndirectFireWeaponController Class Reference

DtIndirectFireWeaponController is a controller that models firing an indirect fire weapon (e.g. More...

Inheritance diagram for DtIndirectFireWeaponController:

Public Member Functions
	DtIndirectFireWeaponController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtIndirectFireWeaponController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual bool	init ()
	Overridden to initialize values obtained from the descriptor.
virtual bool	createMountingController ()
	Overridden to create a DtMountingController.
virtual void	preFirstTickInit ()
	Restores the checkpointed values of myCurrentMunition and myCurrentFuze from the the munition loader of the DtVrfBalGunPSR.
virtual void	tick ()
	Sets the current dT on the base mounting controller and ticks it.
virtual bool	createTargetPointPort ()
	Creates a new DtVectorPort named "target-point-port".
virtual DtVectorOutputPort *	targetPointPort () const
	Accessor for the target point port.
virtual bool	createMaxRangePort ()
	Creates a new DtAnalogPort named "max-range-port".
virtual DtAnalogOutputPort *	maxRangePort () const
	Accessor for the max range port.
virtual bool	createAlignedDirectlyPort ()
	Creates a new DtBooleanPort named "aligned-directly-port".
virtual DtBooleanOutputPort *	alignedDirectlyPort () const
	Accessor for the max range port.
virtual DtVrfIndirectFirePSR *	indirectFireProcessState ()
virtual const DtVrfIndirectFirePSR *	indirectFireProcessState () const
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 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 void	addRangeItems ()
virtual bool	initializeController (const DtString &ammoType, DtReal heightAboveTerrain)
	Sets up the controller with the given parameters.
Public Member Functions inherited from DtBaseWeaponController
	DtBaseWeaponController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtBaseWeaponController ()
	destructor
virtual bool	postAddComponentsInit ()
	Override to call lookupAndCacheProcessSR() (another component creates it - we just look it up and keep a pointer to it).
virtual void	fire ()
	fires the weapon
virtual bool	waitingForFire ()
	Returns true if the trigger has been set but the actuator has not yet fired.
virtual void	setWaitingForFire (bool waiting)
	Sets myWaitingForFire.
virtual bool	createWeaponOutputPortGroup ()
	Initializes myWeaponOutputPortGroup.
virtual DtOutputPortGroup *	weaponOutputPortGroup ()
	Returns myWeaponOutputPortGroup.
virtual bool	createWeaponInputPortGroup ()
	Initializes myWeaponInputPortGroup.
virtual DtInputPortGroup *	weaponInputPortGroup ()
	Returns myWeaponInputPortGroup.
virtual bool	createTriggerPort ()
	These are called in init to create the ports used to communicate with the actuator.
virtual DtBooleanOutputPort *	triggerPort () const
virtual bool	createLoadAmmunitionPort ()
virtual DtAmmunitionOutputPort *	loadAmmunitionPort () const
virtual bool	createLoadedPort ()
virtual DtBooleanOutputPort *	loadedPort () const
virtual bool	createArtPartTypePort ()
virtual DtIntegerInputPort *	artPartTypePort () const
virtual void	setPreloadWeapon (bool doPreload)
	If setPreloadWeapon to true, the loader will load the first munition from the ammoselect table if there is no target.
virtual bool	preloadWeapon () const
virtual void	setLoadAmmoTime (DtTime loadAmmoTime)
virtual DtTime	loadAmmoTime () const
virtual void	setUnloadAmmoTime (DtTime unloadAmmoTime)
virtual DtTime	unloadAmmoTime () const
virtual void	setMaxVehicleSpeedToFire (DtReal maxVehicleSpeedToFire)
	Some vehicles must stop to shoot, others have a maximum speed to launch a munition.
virtual DtReal	maxVehicleSpeedToFire () const
virtual bool	weaponCorrectlyOriented () const
virtual void	setMaxAngleOffBoresight (DtReal maxAngleOffBoresight)
	Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target.
virtual DtReal	maxAngleOffBoresight () const
virtual void	initProcessSR ()
	Sets the load & unload ammo time from the component descriptor.
virtual DtBaseMountingController *	mountingController ()
	returns the DtBaseMountingController
virtual void	setCurrentMunitionName (const DtString &currentMunitionName)
	sets the current munition name in the DtVrfWeaponPSR
virtual const DtString &	currentMunitionName () const
	gets the current munition name from the DtVrfWeaponPSR
virtual DtVrfWeaponPSR *	weaponProcessState ()
	Returns the DtVrfWeaponPSR.
virtual const DtVrfWeaponPSR *	weaponProcessState () const
	Returns the DtVrfWeaponPSR.
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.
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	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 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 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 void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
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
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	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 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.
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 DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions
virtual bool	createPorts ()
	Overridden to call createTargetPointPort and createMaxRangePort.
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 myWeaponProcessState.
virtual void	getMunitionResources (std::list< DtString > &resourceList)
	Called when setting up the weapon component interface.
virtual void	updateResourceList ()
	Go thru the resource list to make sure resources are still viable.
	DtIndirectFireWeaponController ()
	default constructor; not implemented
	DtIndirectFireWeaponController (const DtIndirectFireWeaponController &orig)
	copy constructor; not implemented
const DtIndirectFireWeaponController &	operator= (const DtIndirectFireWeaponController &orig)
	assignment operator; not implemented
Protected Member Functions inherited from DtBaseWeaponController
virtual bool	createPortGroups ()
	Overridden to add port groups from myBaseMountingController, allowing OPD connections to be specified using the name of this component.
	DtBaseWeaponController ()
	default constructor; not implemented
	DtBaseWeaponController (const DtBaseWeaponController &orig)
	copy constructor; not implemented
const DtBaseWeaponController &	operator= (const DtBaseWeaponController &orig)
	assignment operator; not implemented
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
virtual void	setRadio (DtSimBaseRadio *radio)
Protected Member Functions inherited from DtSimComponent
bool	testInvariant () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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 DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtIndirectWeaponComponentInterface *	myWeaponComponentInterface
	Interface between this weapon controller and the entity's DtIndirectFireController.
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.
DtIndirectFireControllerDescriptor *	myIndFireDescriptor
DtVrfIndirectFirePSR *	myIndirectProcessState
Ports and Port Groups
DtVectorOutputPort *	myTargetPointPort
	Output Port Name: target-point-port Output Port Description: Local position to fire at.
DtAnalogOutputPort *	myMaxRangePort
	Output Port Name: max-range-port Output Port Description: Maximum range in meters.
DtBooleanOutputPort *	myAlignedDirectlyPort
	Output Port Name: aligned-directly-port Output Port Description: If the target is close enough for the gun to algin directly with the target and the gun is capable of doing so let the actuator know so the fly out will come out straight not arched Output Port Range: Output Port Default Value: false Output Group Parent:
DtMountingController *	myMountingController
	Output Port Name: target-point-port Output Port Description: Local position to fire at.
bool	myIsDirectFire
	If weapon is capable of directly firing on a target like a naval gun then check if the target is within the gun's minimum range and the first range entry.
Protected Attributes inherited from DtBaseWeaponController
bool	myDoWeaponPreload
	If myDoWeaponPreload is true, the loader will load the first munition from the ammoselect table if there is no target.
bool	myWaitingForFire
	This flag is set to true when the controller pulls the trigger, and set back to false when the controllers sees that the loaded munition has been unloaded (by the gun).
DtReal	myFireMaxVehicleSpeed
	Some vehicles must stop to shoot, others have a maximum speed to launch a munition.
DtReal	myMaxAngleOffBoresight
const DtBaseWeaponControllerDescriptor *	myBaseWeaponCtlrDesc
	Get ammo select tables from here.
DtBaseMountingController *	myBaseMountingController
DtVrfWeaponPSR *	myWeaponProcessState
	Pointer to a process state repository used to store state data associated with this component.
DtOutputPortGroup *	myWeaponOutputPortGroup
	Output Port Group Name: weapon-control Output Port Group Description:
DtAmmunitionOutputPort *	myLoadAmmunitionPort
	Output Port Name: ammunition Output Port Description: Type of ammunition to use Output Port Range: Output Port Default Value: Output Group Parent: weapon-control.
DtBooleanOutputPort *	myTriggerPort
	Output Port Name: trigger Output Port Description: True to fire.
DtBooleanOutputPort *	myLoadedPort
	Output Port Name: loaded Output Port Description: True if loaded.
DtInputPortGroup *	myWeaponInputPortGroup
	Input Port Group Name: weapon-info Input Port Group Description:
DtIntegerInputPort *	myArtPartTypePort
	Input Port Name: art-part-type Input Port Description: Type of articulated part.
Protected Attributes inherited from DtControllerComponent
DtSimBaseRadio *	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
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

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
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

DtIndirectFireWeaponController is a controller that models firing an indirect fire weapon (e.g.

a cannon).

Developer Description: Extends the DtBaseWeaponController with the additional ports needed to specify target location and maximum range.

Uses Descriptor Type: DtBaseWeaponControllerDescriptor

Constructor & Destructor Documentation

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

virtual

destructor

DtIndirectFireWeaponController::DtIndirectFireWeaponController ( )

protected

default constructor; not implemented

DtIndirectFireWeaponController::DtIndirectFireWeaponController ( const DtIndirectFireWeaponController &  orig )

protected

copy constructor; not implemented

Member Function Documentation

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

DtIndirectFireWeaponControllerType

Reimplemented from DtBaseWeaponController.

virtual bool DtIndirectFireWeaponController::init ( )

virtual

Overridden to initialize values obtained from the descriptor.

Reimplemented from DtBaseWeaponController.

virtual bool DtIndirectFireWeaponController::createMountingController ( )

virtual

Overridden to create a DtMountingController.

Reimplemented from DtBaseWeaponController.

virtual void DtIndirectFireWeaponController::preFirstTickInit ( )

virtual

Restores the checkpointed values of myCurrentMunition and myCurrentFuze from the the munition loader of the DtVrfBalGunPSR.

Calls setDisplayName on myWeaponComponentInterface with the value from the PSR.

Reimplemented from DtSimComponent.

virtual void DtIndirectFireWeaponController::tick ( )

virtual

Sets the current dT on the base mounting controller and ticks it.

Reimplemented from DtBaseWeaponController.

virtual bool DtIndirectFireWeaponController::createTargetPointPort ( )

virtual

Creates a new DtVectorPort named "target-point-port".

virtual DtVectorOutputPort* DtIndirectFireWeaponController::targetPointPort ( ) const

virtual

Accessor for the target point port.

virtual bool DtIndirectFireWeaponController::createMaxRangePort ( )

virtual

Creates a new DtAnalogPort named "max-range-port".

virtual DtAnalogOutputPort* DtIndirectFireWeaponController::maxRangePort ( ) const

virtual

Accessor for the max range port.

virtual bool DtIndirectFireWeaponController::createAlignedDirectlyPort ( )

virtual

Creates a new DtBooleanPort named "aligned-directly-port".

virtual DtBooleanOutputPort* DtIndirectFireWeaponController::alignedDirectlyPort ( ) const

virtual

Accessor for the max range port.

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

virtual DtVrfIndirectFirePSR* DtIndirectFireWeaponController::indirectFireProcessState ( )

virtual

virtual const DtVrfIndirectFirePSR* DtIndirectFireWeaponController::indirectFireProcessState ( ) const

virtual

virtual bool DtIndirectFireWeaponController::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& DtIndirectFireWeaponController::findDefaultAmmo ( ) const

virtual

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

virtual void DtIndirectFireWeaponController::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* DtIndirectFireWeaponController::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.

virtual void DtIndirectFireWeaponController::setMyFuzeToUse ( DtDetonatorFuze  fuzeToUse )

virtual

mutator for myFuzeToUse

virtual DtDetonatorFuze DtIndirectFireWeaponController::fuzeToUse ( ) const

virtual

accessor for myFuzeToUse

virtual void DtIndirectFireWeaponController::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 DtIndirectFireWeaponController::calculateDesiredAzimuth ( )

virtual

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

double DtIndirectFireWeaponController::findBodyHeadingToLocalPosition

(

DtVector

localTargetPosition

)

const

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

virtual void DtIndirectFireWeaponController::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 DtIndirectFireWeaponController::setCurrentMaxRange ( DtReal  currentMaxRange )

virtual

Set the current max range.

virtual DtReal DtIndirectFireWeaponController::currentMaxRange ( ) const

virtual

Get the current max range.

virtual DtReal DtIndirectFireWeaponController::absoluteMaxRange ( ) const

virtual

Returns the largest max range in max range list.

Assumes the maxRangeList is sorted in ascending order.

virtual void DtIndirectFireWeaponController::addRangeItems ( )

virtual

virtual bool DtIndirectFireWeaponController::initializeController ( const DtString &  ammoType, DtReal  heightAboveTerrain  )

virtual

Sets up the controller with the given parameters.

Called in preFirstTickInit to restore the controller if the task is being restored from a scenario load, and by tick() in response to a new fire task as signaled by weaponInterface->initializeWeapon.

virtual bool DtIndirectFireWeaponController::createPorts ( )

protectedvirtual

Overridden to call createTargetPointPort and createMaxRangePort.

Reimplemented from DtBaseWeaponController.

virtual void DtIndirectFireWeaponController::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 myWeaponProcessState.

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. Overridden from DtBaseWeaponController to print a warning if it can't be cast to the derived type of process state repository, DtVrfIndirectFirePSR.

Reimplemented from DtBaseWeaponController.

virtual void DtIndirectFireWeaponController::getMunitionResources ( std::list< DtString > &  resourceList )

protectedvirtual

Called when setting up the weapon component interface.

virtual void DtIndirectFireWeaponController::updateResourceList ( )

protectedvirtual

Go thru the resource list to make sure resources are still viable.

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

protected

assignment operator; not implemented

Member Data Documentation

DtIndirectWeaponComponentInterface* DtIndirectFireWeaponController::myWeaponComponentInterface

protected

Interface between this weapon controller and the entity's DtIndirectFireController.

DtDetonatorFuze DtIndirectFireWeaponController::myFuzeToUse

protected

Set based on height above terrain value.

DtReal DtIndirectFireWeaponController::myCurrentMaxRange

protected

DtSimMunition DtIndirectFireWeaponController::myMunitionToUse

protected

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

DtIndirectFireControllerDescriptor* DtIndirectFireWeaponController::myIndFireDescriptor

protected

DtVrfIndirectFirePSR* DtIndirectFireWeaponController::myIndirectProcessState

protected

DtVectorOutputPort* DtIndirectFireWeaponController::myTargetPointPort

protected

Output Port Name: target-point-port
Output Port Description: Local position to fire at.

Output Port Range:
Output Port Default Value:
Output Group Parent:

DtAnalogOutputPort* DtIndirectFireWeaponController::myMaxRangePort

protected

Output Port Name: max-range-port
Output Port Description: Maximum range in meters.

Output Port Range:
Output Port Default Value:
Output Group Parent:

DtBooleanOutputPort* DtIndirectFireWeaponController::myAlignedDirectlyPort

protected

Output Port Name: aligned-directly-port
Output Port Description: If the target is close enough for the gun to algin directly with the target and the gun is capable of doing so let the actuator know so the fly out will come out straight not arched
Output Port Range:
Output Port Default Value: false
Output Group Parent:

DtMountingController* DtIndirectFireWeaponController::myMountingController

protected

Output Port Name: target-point-port
Output Port Description: Local position to fire at.

Output Port Range:
Output Port Default Value:
Output Group Parent:

bool DtIndirectFireWeaponController::myIsDirectFire

protected

If weapon is capable of directly firing on a target like a naval gun then check if the target is within the gun's minimum range and the first range entry.

If so set this to true and the gun will not elevate for a parabolic artillery shot but will line up directly with the target.

---

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

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