VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtIndirectFireWeaponController Class Reference

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

Inheritance diagram for DtIndirectFireWeaponController:
Inheritance graph
[legend]

Public Member Functions

 DtIndirectFireWeaponController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtIndirectFireWeaponController ()
 destructor More...
 
virtual const chartype () const
 Returns a string identifies the class type of component. More...
 
virtual bool init ()
 Overridden to initialize values obtained from the descriptor. More...
 
virtual bool createMountingController ()
 Overridden to create a DtMountingController. More...
 
virtual void preFirstTickInit ()
 Restores the checkpointed values of myCurrentMunition and myCurrentFuze from the the munition loader of the DtVrfBalGunPSR. More...
 
virtual void tick ()
 Sets the current dT on the base mounting controller and ticks it. More...
 
virtual bool createTargetPointPort ()
 Creates a new DtVectorPort named "target-point-port". More...
 
virtual DtVectorOutputPorttargetPointPort () const
 Accessor for the target point port. More...
 
virtual bool createMuzzleSpeedPort ()
 Creates a new DtAnalogPort named "muzzle-speed-port". More...
 
virtual DtAnalogOutputPortmuzzleSpeedPort () const
 Accessor for the muzzle speed port. More...
 
virtual bool createAngleOfFirePort ()
 Creates a new DtAnalogPort named "angle-of-fire-port". More...
 
virtual DtAnalogOutputPortangleOfFirePort () const
 Accessor for the muzzle speed port. More...
 
virtual bool createAlignedDirectlyPort ()
 Creates a new DtBooleanPort named "aligned-directly-port". More...
 
virtual DtBooleanOutputPortalignedDirectlyPort () const
 Accessor for the max range port. More...
 
virtual bool createMuzzleOffsetPort ()
 Creates a new DtVectorInputPort named "muzzle-offset-port". More...
 
virtual DtVectorInputPortmuzzleOffsetPort () const
 Accessor for the muzzle offset port. More...
 
virtual DtVrfIndirectFirePSRindirectFireProcessState ()
 
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. More...
 
virtual const DtStringfindDefaultAmmo () const
 Goes through the ammo list in myIndFireDescriptor and returns the first ammo type for which haveAmmo() returns true. More...
 
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(). More...
 
virtual DtMunitionResourcelookupMunitionResource (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. More...
 
virtual void setMyFuzeToUse (DtDetonatorFuze fuzeToUse)
 mutator for myFuzeToUse More...
 
virtual DtDetonatorFuze fuzeToUse () const
 accessor for myFuzeToUse More...
 
virtual void setCurrentMuzzleSpeed (DtReal speed)
 Set the current muzzle speed. More...
 
virtual DtReal currentMuzzleSpeed () const
 Get the current muzzle speed. More...
 
virtual void addRangeItems ()
 
virtual bool initializeController (const DtString &ammoType, DtReal heightAboveTerrain, const DtUUID &targetName, bool &waitingForTerrain)
 Sets up the controller with the given parameters. More...
 
- Public Member Functions inherited from DtBaseWeaponController
 DtBaseWeaponController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtBaseWeaponController ()
 destructor More...
 
virtual bool postAddComponentsInit ()
 Override to call lookupAndCacheProcessSR() (another component creates it - we just look it up and keep a pointer to it). More...
 
virtual void fire ()
 fires the weapon More...
 
virtual bool waitingForFire ()
 Returns true if the trigger has been set but the actuator has not yet fired. More...
 
virtual void setWaitingForFire (bool waiting)
 Sets myWaitingForFire. More...
 
virtual bool createWeaponOutputPortGroup ()
 Initializes myWeaponOutputPortGroup. More...
 
virtual DtOutputPortGroupweaponOutputPortGroup ()
 Returns myWeaponOutputPortGroup. More...
 
virtual bool createWeaponInputPortGroup ()
 Initializes myWeaponInputPortGroup. More...
 
virtual DtInputPortGroupweaponInputPortGroup ()
 Returns myWeaponInputPortGroup. More...
 
virtual bool createTriggerPort ()
 These are called in init to create the ports used to communicate with the actuator. More...
 
virtual DtBooleanOutputPorttriggerPort () const
 
virtual bool createLoadAmmunitionPort ()
 
virtual DtAmmunitionOutputPortloadAmmunitionPort () const
 
virtual bool createLoadedPort ()
 
virtual DtBooleanOutputPortloadedPort () const
 
virtual bool createArtPartTypePort ()
 
virtual DtIntegerInputPortartPartTypePort () 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. More...
 
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. More...
 
virtual DtReal maxVehicleSpeedToFire () const
 
virtual bool weaponCorrectlyOriented () const
 
virtual void initProcessSR ()
 Sets the load & unload ammo time from the component descriptor. More...
 
virtual DtBaseMountingControllermountingController ()
 returns the DtBaseMountingController More...
 
virtual void setCurrentMunitionName (const DtString &currentMunitionName)
 sets the current munition name in the DtVrfWeaponPSR More...
 
virtual const DtStringcurrentMunitionName () const
 gets the current munition name from the DtVrfWeaponPSR More...
 
virtual DtVrfWeaponPSRweaponProcessState ()
 Returns the DtVrfWeaponPSR. More...
 
virtual const DtVrfWeaponPSRweaponProcessState () const
 Returns the DtVrfWeaponPSR. More...
 
virtual void setMaxAzimuthAngleOffBoresight (DtReal maxAngle)
 Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. More...
 
virtual DtReal maxAzimuthAngleOffBoresight () const
 
virtual void setMaxElevationAngleOffBoresight (DtReal maxAngle)
 
virtual DtReal maxElevationAngleOffBoresight () const
 
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtControllerComponent ()
 destructor More...
 
virtual DtSimRadioradio ()
 The radio this component is listening to. More...
 
virtual void taskNotify (const DtSimTask &task)
 This is used by the entity to notify all controllers that a new task has been received. More...
 
virtual void clearTask ()
 Called when you want to clear out this component's task state. More...
 
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSimComponent ()
 destructor More...
 
virtual void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component. More...
 
DtComponentSystemparentSystem () const
 
virtual void postTick ()
 This function is called immediately after tick() is called. More...
 
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived. More...
 
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as More...
 
virtual double minTickPeriod () const
 access the minimum tick period More...
 
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time More...
 
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period More...
 
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally. More...
 
virtual double nextTickTime () const
 access the next tick time More...
 
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...
 
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at. More...
 
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. More...
 
virtual DtSimComponentnextComponent ()
 List management functions. More...
 
virtual DtSimComponentprevComponent ()
 
virtual void setListItem (DtListItem *item)
 Used by DtComponentList. More...
 
virtual DtListItem * listItem ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class. More...
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actual stored. More...
 
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. More...
 
virtual void removeInputPort (DtInputPort *port)
 
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name. More...
 
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component. More...
 
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. More...
 
virtual void removeOutputPort (DtOutputPort *port)
 
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name. More...
 
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component. More...
 
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. More...
 
virtual void removeInputPortGroup (DtInputPortGroup *group)
 
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name. More...
 
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component. More...
 
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. More...
 
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
 
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name. More...
 
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component. More...
 
virtual int priority () const
 Return the current connection priority for this component. More...
 
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. More...
 
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...
 
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. More...
 
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. More...
 
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. More...
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in. More...
 
const DtPhysicalWorldphysicalWorld () const
 
DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any. More...
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtVrfObjectentity ()
 Gets the entity. More...
 
const DtVrfObjectentity () const
 
const DtVrfObjectconst_entity () const
 You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...
 
DtSimManagersimManager ()
 Gets the sim manager. More...
 
const DtSimManagersimManager () const
 
const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
 
DtVrfObjectStateRepositorylocalStateRepository ()
 Gets the local state repository. More...
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
const DtVrfObjectStateRepositoryconst_localStateRepository () const
 You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...
 
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component. More...
 
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component. More...
 
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component. More...
 
virtual bool isThreadSafe () const
 Returns true if this component is marked as being thread safe. More...
 
virtual void addVRLinkDeferredJob (const boost::function< void()> &callback)
 Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More...
 
virtual bool isEnabled ()
 
virtual void setIsEnabled (bool yesNo)
 
virtual DtOutputStream & objectConsoleDebug (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleVerbose (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleInfo (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleWarn (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleError (const DtString &channel="") const
 
virtual DtSimResourceManagerresourceManager ()
 
virtual const
DtSimResourceManager
resourceManager () const
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file. More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream. More...
 
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op. More...
 
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op. More...
 
virtual void writeSelf (std::string &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. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 Set read-only flag. More...
 
bool isReadonly () const
 
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
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. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
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. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value. More...
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtBaseWeaponController
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentMarkThreadSafe (DtSimComponent *)
 Marks an instance of a component as being thread safe. More...
 
static DtSimComponentFactoryfactory ()
 A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...
 
static void addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
 Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 

Protected Member Functions

virtual bool createPorts ()
 Overridden to call createTargetPointPort and createMaxRangePort. More...
 
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. More...
 
virtual bool calculateTrajectory (const DtVector &shooterLoc, const DtVector &detonationLoc, const double maxRange)
 Calculates a trajectory for the munition in order to reach a specified detonation location from a specified shooter location, in local coordinates. More...
 
virtual void calculateTrajectoryWithHeight (double horizontalDist, double verticalDist, double maxHeight, double &muzzleSpeed, double &launchAngle, double &flightTime)
 Calculates a trajectory for the munition in order to reach a target at the given horizontal and vertical distance from the shooter, with the peak of the arc happening at the specified height above the shooter. More...
 
virtual bool calculateElevationAngle (double lateralDist, double verticalDist, double muzzleSpeed, double &angle, double &flightTime, double &maxHeight) const
 Calculates the gun elevation angle needed to hit a point at the given distance with the given muzzle speed. More...
 
virtual bool checkMuzzleSpeedAndAngle (double lateralDist, double verticalDist, double speed, double angle, double &flightTime, double &maxHeight) const
 Determines the acceptability of a shot with the given muzzle speed and elevation angle for a target at the given lateral and vertical distance. More...
 
virtual void getMunitionResources (std::list< DtString > &resourceList)
 Called when setting up the weapon component interface. More...
 
virtual void updateResourceList ()
 Go through the resource list and remove any with amounts = 0. More...
 
virtual DtVector computeLeadPosition (const DtVector &position, const DtVector &velocity)
 Computes a position in front of a moving target that the gun should hit given the flight time of the shell. More...
 
virtual const DtVectormuzzleLocalPosition ()
 Computes the current local muzzle position based on the data on the myMuzzleOffsetPort and the current position of the articulated part referenced on the myArtPartTypePort. More...
 
virtual DtReaderWriterprocessProvideWeaponName ()
 Provides the display name (a new DtRwString) of the weapon component interface for this weapon. More...
 
virtual double preferredAltitude () const
 Returns the preferred altitude above shooter and target that the munition's trajectory should reach at its peak. More...
 
 DtIndirectFireWeaponController ()
 default constructor; not implemented More...
 
 DtIndirectFireWeaponController (const DtIndirectFireWeaponController &orig)
 copy constructor; not implemented More...
 
const
DtIndirectFireWeaponController
operator= (const DtIndirectFireWeaponController &orig)
 assignment operator; not implemented More...
 
virtual void enable ()
 Is this component enabled or not. More...
 
virtual void disable ()
 
- 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. More...
 
 DtBaseWeaponController ()
 default constructor; not implemented More...
 
 DtBaseWeaponController (const DtBaseWeaponController &orig)
 copy constructor; not implemented More...
 
const DtBaseWeaponControlleroperator= (const DtBaseWeaponController &orig)
 assignment operator; not implemented More...
 
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor More...
 
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor More...
 
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator More...
 
virtual void onRestore ()
 Override to iterate over the descriptor to see if there are any targetting control tables. More...
 
virtual void initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
 
virtual void setRadio (DtSimRadio *radio)
 
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT. More...
 
bool testInvariant () const
 
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager. More...
 
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick. More...
 
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component. More...
 
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization. More...
 
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name. More...
 
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name. More...
 
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name. More...
 
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name. More...
 
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked. More...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 

Protected Attributes

DtIndirectWeaponComponentInterfacemyWeaponComponentInterface
 Interface between this weapon controller and the entity's DtIndirectFireController. More...
 
DtDetonatorFuze myFuzeToUse
 Set based on height above terrain value. More...
 
DtReal myCurrentMuzzleSpeed
 The muzzle speed selected for the next shot. More...
 
DtReal myCurrentMunitionFlightTime
 The expected flight time for the next shot. More...
 
DtReal myCurrentElevationAngle
 The elevation angle selected for the next shot. More...
 
bool myWeaponIsAimed
 Whether the weapon is fully aimed at the target, or if adjustments still need to be made. More...
 
DtSimMunition myMunitionToUse
 This could just be a stack variable in tick, but since these are expensive to construct, we create on and reuse it. More...
 
DtIndirectFireControllerDescriptormyIndFireDescriptor
 
Ports and Port Groups
DtVectorOutputPortmyTargetPointPort
 Output Port Name: target-point-port
Output Port Description: Local position to fire at. More...
 
DtAnalogOutputPortmyMuzzleSpeedPort
 Output Port Name: muzzle-speed-port
Output Port Description: Muzzle speed in m/s. More...
 
DtAnalogOutputPortmyAngleOfFirePort
 Output Port Name: angle-of-fire-port
Output Port Description: The elevation angle of fire, in radians. More...
 
DtBooleanOutputPortmyAlignedDirectlyPort
 Output Port Name: aligned-directly-port
Output Port Description: If the target is close enough for the gun to align 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: More...
 
DtVectorInputPortmyMuzzleOffsetPort
 Input Port Name: muzzle-offset-port
Input Port Description: The entity's muzzle offset location. More...
 
DtMountingControllermyMountingController
 
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. More...
 
- 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. More...
 
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). More...
 
DtReal myFireMaxVehicleSpeed
 Some vehicles must stop to shoot, others have a maximum speed to launch a munition. More...
 
DtReal myMaxAzimuthAngleOffBoresight
 
DtReal myMaxElevationAngleOffBoresight
 
const
DtBaseWeaponControllerDescriptor
myBaseWeaponCtlrDesc
 Get ammo select tables from here. More...
 
DtBaseMountingControllermyBaseMountingController
 
DtVrfWeaponPSRmyWeaponProcessState
 Pointer to a process state repository used to store state data associated with this component. More...
 
DtOutputPortGroupmyWeaponOutputPortGroup
 Output Port Group Name: weapon-control
Output Port Group Description: More...
 
DtAmmunitionOutputPortmyLoadAmmunitionPort
 Output Port Name: ammunition
Output Port Description: Type of ammunition to use
Output Port Range:
Output Port Default Value:
Output Group Parent: weapon-control. More...
 
DtBooleanOutputPortmyTriggerPort
 Output Port Name: trigger
Output Port Description: True to fire. More...
 
DtBooleanOutputPortmyLoadedPort
 Output Port Name: loaded
Output Port Description: True if loaded. More...
 
DtInputPortGroupmyWeaponInputPortGroup
 Input Port Group Name: weapon-info
Input Port Group Description: More...
 
DtIntegerInputPortmyArtPartTypePort
 Input Port Name: art-part-type
Input Port Description: Type of articulated part. More...
 
- Protected Attributes inherited from DtControllerComponent
DtSimRadiomyRadio
 Controller components can send messages. More...
 
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
 
DtVrfObjectStateRepositorymyLocalStateRepository
 
DtSimManagermySimManager
 
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs. More...
 
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. More...
 
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick. More...
 
bool myIsThreadSafe
 Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...
 
const DtComponentDescriptormyComponentDescriptor
 
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...
 
bool myTickEveryFrame
 Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...
 
DtTaskVisualizationMap myTaskVisualizations
 The visualization objects to be drawn for this component. More...
 
double myNextTaskVisTickTime
 The next tick time for updating the task visualizations. More...
 
DtSymbolString myFullComponentName
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 
virtual void registerAttributeFunctions ()
 Attribute functions:Overrides the simComponent version to register the functions below. More...
 
static DtReaderWriterprovideWeaponName (void *controller)
 Function to be registered as a provider with the parent component system for the weapon-name attribute. More...
 
virtual void processSetResource (DtSimMessage *msg)
 
static void setResourceCallback (DtSimMessage *msg, void *usrData)
 A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored. More...
 
virtual void processSetRestore (DtSimMessage *msg)
 
static void setRestoreCallback (DtSimMessage *msg, void *usrData)
 A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored. More...
 
virtual void processSetPreferredAltitude (DtSimMessage *msg)
 
static void setPreferredAltitudeCallback (DtSimMessage *msg, void *usrData)
 Processes user commands to change the preferred altitude of the trajectory. More...
 

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
 
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
 
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
 
typedef std::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- Protected Types inherited from DtSimComponent
typedef std::map< DtString,
DtInputPort * > 
DtInputPortMap
 
typedef std::map< DtString,
DtOutputPort * > 
DtOutputPortMap
 
typedef std::map< DtString,
DtInputPortGroup * > 
DtInputPortGroupMap
 
typedef std::map< DtString,
DtOutputPortGroup * > 
DtOutputPortGroupMap
 
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

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 
)

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
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 const char* 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. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

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::createMuzzleSpeedPort ( )
virtual

Creates a new DtAnalogPort named "muzzle-speed-port".

virtual DtAnalogOutputPort* DtIndirectFireWeaponController::muzzleSpeedPort ( ) const
virtual

Accessor for the muzzle speed port.

virtual bool DtIndirectFireWeaponController::createAngleOfFirePort ( )
virtual

Creates a new DtAnalogPort named "angle-of-fire-port".

virtual DtAnalogOutputPort* DtIndirectFireWeaponController::angleOfFirePort ( ) const
virtual

Accessor for the muzzle speed 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.

virtual bool DtIndirectFireWeaponController::createMuzzleOffsetPort ( )
virtual

Creates a new DtVectorInputPort named "muzzle-offset-port".

virtual DtVectorInputPort* DtIndirectFireWeaponController::muzzleOffsetPort ( ) const
virtual

Accessor for the muzzle offset port.

static DtSimComponent* DtIndirectFireWeaponController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
Returns
New instance of this class.
virtual DtVrfIndirectFirePSR* DtIndirectFireWeaponController::indirectFireProcessState ( )
virtual
virtual const DtVrfIndirectFirePSR* DtIndirectFireWeaponController::indirectFireProcessState ( ) const
virtual
virtual void DtIndirectFireWeaponController::registerAttributeFunctions ( )
virtual

Attribute functions:Overrides the simComponent version to register the functions below.

Reimplemented from DtSimComponent.

static DtReaderWriter* DtIndirectFireWeaponController::provideWeaponName ( void *  controller)
static

Function to be registered as a provider with the parent component system for the weapon-name attribute.

This name is used in indirect fire tasks (along with an optional munition name) to identify the entity weapon to fire. This distinction is needed when there are multiple weapons, e.g. ship turrets. Calls processProvideWeaponName.

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::setCurrentMuzzleSpeed ( DtReal  speed)
virtual

Set the current muzzle speed.

virtual DtReal DtIndirectFireWeaponController::currentMuzzleSpeed ( ) const
virtual

Get the current muzzle speed.

virtual void DtIndirectFireWeaponController::addRangeItems ( )
virtual
virtual bool DtIndirectFireWeaponController::initializeController ( const DtString ammoType,
DtReal  heightAboveTerrain,
const DtUUID targetName,
bool waitingForTerrain 
)
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 bool DtIndirectFireWeaponController::calculateTrajectory ( const DtVector shooterLoc,
const DtVector detonationLoc,
const double  maxRange 
)
protectedvirtual

Calculates a trajectory for the munition in order to reach a specified detonation location from a specified shooter location, in local coordinates.

Returns true if successful. Populates myCurrentMuzzleSpeed, myCurrentMunitionFlightTime, and myCurrentElevationAngle with the calculated values. Also calls setDesiredElevation on the mounting controller. If there is not a set list of muzzle speeds( i.e. various range trajectories) which is the case for grenades, will need to use range passed in to ensure say within max range capability of human throwing.

virtual void DtIndirectFireWeaponController::calculateTrajectoryWithHeight ( double  horizontalDist,
double  verticalDist,
double  maxHeight,
double muzzleSpeed,
double launchAngle,
double flightTime 
)
protectedvirtual

Calculates a trajectory for the munition in order to reach a target at the given horizontal and vertical distance from the shooter, with the peak of the arc happening at the specified height above the shooter.

virtual bool DtIndirectFireWeaponController::calculateElevationAngle ( double  lateralDist,
double  verticalDist,
double  muzzleSpeed,
double angle,
double flightTime,
double maxHeight 
) const
protectedvirtual

Calculates the gun elevation angle needed to hit a point at the given distance with the given muzzle speed.

Fills in the flightTime and maxHeight of the trajectory. Returns false if no valid angle could be found.

virtual bool DtIndirectFireWeaponController::checkMuzzleSpeedAndAngle ( double  lateralDist,
double  verticalDist,
double  speed,
double  angle,
double flightTime,
double maxHeight 
) const
protectedvirtual

Determines the acceptability of a shot with the given muzzle speed and elevation angle for a target at the given lateral and vertical distance.

If shot is acceptable, fills in flightTime with the expected munition flight time and maxHeight with the height at the peak of the trajectory.

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

Called when setting up the weapon component interface.

Gets all resources in the component that have amounts > 0.

virtual void DtIndirectFireWeaponController::updateResourceList ( )
protectedvirtual

Go through the resource list and remove any with amounts = 0.

static void DtIndirectFireWeaponController::setResourceCallback ( DtSimMessage msg,
void *  usrData 
)
staticprotected

A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored.

virtual void DtIndirectFireWeaponController::processSetResource ( DtSimMessage msg)
protectedvirtual
static void DtIndirectFireWeaponController::setRestoreCallback ( DtSimMessage msg,
void *  usrData 
)
staticprotected

A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored.

virtual void DtIndirectFireWeaponController::processSetRestore ( DtSimMessage msg)
protectedvirtual
static void DtIndirectFireWeaponController::setPreferredAltitudeCallback ( DtSimMessage msg,
void *  usrData 
)
staticprotected

Processes user commands to change the preferred altitude of the trajectory.

virtual void DtIndirectFireWeaponController::processSetPreferredAltitude ( DtSimMessage msg)
protectedvirtual
virtual DtVector DtIndirectFireWeaponController::computeLeadPosition ( const DtVector position,
const DtVector velocity 
)
protectedvirtual

Computes a position in front of a moving target that the gun should hit given the flight time of the shell.

virtual const DtVector& DtIndirectFireWeaponController::muzzleLocalPosition ( )
protectedvirtual

Computes the current local muzzle position based on the data on the myMuzzleOffsetPort and the current position of the articulated part referenced on the myArtPartTypePort.

virtual DtReaderWriter* DtIndirectFireWeaponController::processProvideWeaponName ( )
protectedvirtual

Provides the display name (a new DtRwString) of the weapon component interface for this weapon.

virtual double DtIndirectFireWeaponController::preferredAltitude ( ) const
protectedvirtual

Returns the preferred altitude above shooter and target that the munition's trajectory should reach at its peak.

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

assignment operator; not implemented

virtual void DtIndirectFireWeaponController::enable ( )
protectedvirtual

Is this component enabled or not.

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

Reimplemented from DtSimComponent.

virtual void DtIndirectFireWeaponController::disable ( )
protectedvirtual

Reimplemented from DtSimComponent.

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::myCurrentMuzzleSpeed
protected

The muzzle speed selected for the next shot.

DtReal DtIndirectFireWeaponController::myCurrentMunitionFlightTime
protected

The expected flight time for the next shot.

DtReal DtIndirectFireWeaponController::myCurrentElevationAngle
protected

The elevation angle selected for the next shot.

bool DtIndirectFireWeaponController::myWeaponIsAimed
protected

Whether the weapon is fully aimed at the target, or if adjustments still need to be made.

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
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::myMuzzleSpeedPort
protected

Output Port Name: muzzle-speed-port
Output Port Description: Muzzle speed in m/s.


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

DtAnalogOutputPort* DtIndirectFireWeaponController::myAngleOfFirePort
protected

Output Port Name: angle-of-fire-port
Output Port Description: The elevation angle of fire, in radians.


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

DtVectorInputPort* DtIndirectFireWeaponController::myMuzzleOffsetPort
protected

Input Port Name: muzzle-offset-port
Input Port Description: The entity's muzzle offset location.


Input Port Range:
Input Port Default Value:
Input Group Parent:

DtMountingController* DtIndirectFireWeaponController::myMountingController
protected
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:

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)