 |
VR-Forces 4.3 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces 4.3 Class Documentation
|
DtWeaponController is a controller that extends the DtBaseWeaponController with the ability to accept a list of targets as input. More...
Public Member Functions | |
| DtWeaponController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| virtual | ~DtWeaponController () |
| destructor | |
| virtual DtString | type () const |
| Returns a string identifies the class type of component. | |
| virtual bool | createMountingController () |
| Overridden to create a DtMountingController. | |
| virtual bool | init () |
| Overridden to initialize values obtained from the descriptor. | |
| virtual void | tick () |
| If the myWaitingForFire flag is set and the munition loader is still loaded, the weapon has not fired yet and the function immediately returns. | |
| virtual void | fire () |
| updates weapon interface | |
| virtual DtVrfObject * | chooseTarget () |
| Called by tick() to find a target. | |
| virtual DtVrfObject * | chooseTarget (const DtEntityTargetList &targetList) const |
| Called by acceptSensorTargettingInput to choose a target from the list of potential target entities on myTargetListPort. | |
| virtual void | tickMunitionLoader (const DtVrfObject *target) |
| This method will set the flags myLoading, myUnloading, myLoaded as the load state of the weapon changes. | |
| virtual bool | acquireTarget (const DtVrfObject *target) |
| Returns true when target has been acquired. | |
| virtual void | maneuverRequiredToAcquireTarget (DtReal requiredHeading, DtReal requiredPitch, DtReal requiredMaxSpeed) |
| Not implemented in this class. | |
| virtual bool | loadedAmmoValidForTarget (const DtVrfObject *target) const |
| Called by tick() as part of the check to see if the trigger should be pulled. | |
| virtual bool | chooseAmmo (const DtEntityType &entityType, DtSimMunition &munitionOut, DtDetonatorFuze &fuzeOut, bool setCurrentMunition=true) |
| The chooseAmmo() function is passed a pointer to a target entity and returns the best ammunition to use for the target's entity type. | |
| virtual bool | acceptSensorTargettingInput () |
| Returns true if we get a viable target from the sensor. | |
| virtual bool | inSector (DtVrfObject *entity) const |
| Sets the trigger port value to true, sets myLoaded flag to false, and depletes the resource associated with the current munition type in the entity's local state repository. | |
| virtual void | findBodyHeadingElevationToTarget (const DtVrfObject *entity, DtReal &bodyHeadingOut, DtReal &bodyElevationOut) const |
| Given a target entity, computes the body heading (azimuth) and elevation angles to the target, in the body coordinates of the entity. | |
| virtual DtVrfObject * | easier (DtVrfObject *entity1, DtVrfObject *entity2) const |
| This function takes two DtVrfObject* entities as arguments, and returns the entity that is easier for the weapon to acquire. | |
 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 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 ¤tMunitionName) |
| 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 DtSimRadio * | radio () |
| The radio this component is listening to. | |
| virtual void | taskNotify (const DtSimTask &task) |
| This is used by the entity to notify all controllers that a new task has been received. | |
| virtual void | clearTask () |
| Called when you want to clear out this component's task state. | |
| Public Member Functions inherited from DtSimComponent | |
| DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtSimComponent () |
| destructor | |
| void | setParentSystem (DtComponentSystem *system) |
| Sets the parent system of this component. | |
| virtual void | registerAttributeFunctions () |
| Called to register functions that provide system attribute values. | |
| virtual void | preprocess () |
| Perform parallel preprocessing prior to tick and similar computations. | |
| virtual void | parallelTick () |
| called in parallel | |
| virtual void | preFirstTickInit () |
| called from preprocess if appropriate | |
| virtual void | postTick () |
| This function is called immediately after tick() is called. | |
| virtual void | timedTick () |
| This version of tick checks to see if the time to tick has arrived. | |
| virtual void | setMinTickPeriod (double minTickPeriod) |
| specifies a minimum tick period (which can also be thought of as | |
| virtual double | minTickPeriod () const |
| access the minimum tick period | |
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| set the variance in the minimum tick time | |
| virtual double | minTickPeriodVariance () const |
| access the variance in the minimum tick period | |
| virtual void | setNextTickTime (double nextTickTime) |
| The next tick time is normally calculated internally. | |
| virtual double | nextTickTime () const |
| access the next tick time | |
| virtual double | calculateNextTickTime () const |
| The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. | |
| virtual double | calculateFirstTickTime () const |
| Returns the first time value that the component should tick at. | |
| virtual void | setEntity (DtVrfObject *entity) |
| The entity's state repository is the place that actuator components make updates and other components look to see our current state. | |
| virtual DtSimComponent * | nextComponent () |
| List management functions. | |
| virtual DtSimComponent * | prevComponent () |
| virtual void | setListItem (DtListItem *item) |
| Used by DtComponentList. | |
| virtual DtListItem * | listItem () |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actual stored. | |
| virtual void | addInputPort (DtInputPort *port) |
| Adds this input port to the components input port list so that other components can look it up and attach to it. | |
| virtual void | removeInputPort (DtInputPort *port) |
| virtual DtInputPort * | lookupInputPort (const DtString &portName) |
| Returns a pointer to the input port registered on this component with the specified name. | |
| virtual DtList | inputPortList () const |
| Returns the list of DtInputPorts registered on this component. | |
| virtual void | addOutputPort (DtOutputPort *port) |
| Adds this output port to the components output port list so that other components can look it up and attach to it. | |
| virtual void | removeOutputPort (DtOutputPort *port) |
| virtual DtOutputPort * | lookupOutputPort (const DtString &portName) |
| Returns a pointer to the output port registered on this component with the specified name. | |
| virtual DtList | outputPortList () const |
| Returns the list of DtOutputPorts registered on this component. | |
| virtual void | addInputPortGroup (DtInputPortGroup *group) |
| Adds this input port to the components input port list so that other components can look it up and attach to it. | |
| virtual void | removeInputPortGroup (DtInputPortGroup *group) |
| virtual DtInputPortGroup * | lookupInputPortGroup (const DtString &groupName) |
| Returns a pointer the input port group registered on this component with the specified name. | |
| virtual DtList | inputPortGroupList () const |
| Returns the list of DtInputPortGroups registered on this component. | |
| virtual void | addOutputPortGroup (DtOutputPortGroup *group) |
| Adds this output port group to the components output port group list so that other components can look it up and attach to it. | |
| virtual void | removeOutputPortGroup (DtOutputPortGroup *group) |
| virtual DtOutputPortGroup * | lookupOutputPortGroup (const DtString &groupName) |
| Returns a pointer the output port group registered on this component with the specified name. | |
| virtual DtList | outputPortGroupList () const |
| Returns the list of DtOutputPortGroups registered on this component. | |
| virtual int | priority () const |
| Return the current connection priority for this component. | |
| virtual void | setPriority (int priority) |
| Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value. | |
| double | dT () const |
| This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. | |
| virtual void | setDT (double deltaT) |
| Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary. | |
| virtual void | setComponentDescriptor (DtComponentDescriptor *componentDescriptor) |
| The component descriptor specified in the order of battle file or parameter file that was used to create this component. | |
| virtual const DtComponentDescriptor * | componentDescriptor () const |
| 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) | |
| pseudo-copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| virtual void | writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| virtual bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op. | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. | |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| Returns true if this variable has a child p in it's chain. | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. | |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| Checks to see if this RW object is a variable reference that can be bound using the provided bindings. | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| The specified flags are used for optional values. | |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| The variable name, if this object is a variable reference. | |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual DtReaderWriter * | defaultRWValue () |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restires object from given xml file. | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. | |
Static Public Member Functions | |
| static 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 create the local ports. | |
| virtual void | addRangeItems () |
| Adds all items that have a range to the object state repository. | |
| DtWeaponController () | |
| default constructor; not implemented | |
| DtWeaponController (const DtWeaponController &orig) | |
| copy constructor; not implemented | |
| const DtWeaponController & | operator= (const DtWeaponController &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. | |
| 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. | |
| 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 (DtSimRadio *radio) |
| Protected Member Functions inherited from DtSimComponent | |
| virtual double | computeCurrentTime () |
| Compute current time and myDT, common between preprocess and timedTick. | |
| bool | testInvariant () const |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter > | |
| DtObjectDebugger () | |
| DtObjectDebugger (const DtObjectDebugger &) | |
| ~DtObjectDebugger () | |
| Protected Member Functions inherited from DtObjectDebugger< DtSimComponent > | |
| DtObjectDebugger () | |
| DtObjectDebugger (const DtObjectDebugger &) | |
| ~DtObjectDebugger () | |
Protected Attributes | |
| DtEntityIdentifier | myCurrentTarget |
| DtMountingController * | myMountingController |
| const DtWeaponControllerDescriptor * | myWeaponCtlrDesc |
| DtWeaponComponentInterface * | myWeaponComponentInterface |
Ports and Port Groups | |
| DtEntityListInputPort * | myTargetListPort |
| Input Port Name: target-list Input Port Description: List of targets detected. | |
| DtBooleanInputPort * | myWeaponsHoldPort |
| Input Port Name: weapons-hold Input Port Description: When true, all firing of missiles is disabled. | |
| 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 | |
| DtSimRadio * | myRadio |
| Controller components can send messages. | |
| Protected Attributes inherited from DtSimComponent | |
| DtVrfObject * | myEntity |
| DtVrfObjectStateRepository * | myLocalStateRepository |
| DtSimManager * | mySimManager |
| DtComponentSystem * | mySystem |
| Pointer to the DtComponentSystem that this component belongs. | |
| DtListItem * | myListItem |
| DtInputPortMap | myInputPortList |
| DtOutputPortMap | myOutputPortList |
| DtInputPortGroupMap | myInputPortGroupList |
| DtOutputPortGroupMap | myOutputPortGroupList |
| int | myPriority |
| double | myMinTickPeriod |
| double | myMinTickPeriodVariance |
| double | myNextTickTime |
| double | myLastTickSimTime |
| double | myDT |
| bool | myIsEnabled |
| Indicates whether this component should be enabled for ticking or not. | |
| bool | myFirstTick |
| Initialized to true in the constructor, set to false by the first call to postTick. | |
| const DtComponentDescriptor * | myComponentDescriptor |
| Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| DtReaderWriterRegistry * | myParentRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| DtReaderWriter * | myDefaultValue |
| aliasContainer | myAliases |
| Container for the aliases which represent alternative names for the object. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
Additional Inherited Members | |
| Public Types inherited from DtReaderWriter | |
| typedef std::vector < DtSymbolString > | aliasContainer |
| typedef std::vector < DtSymbolString >::iterator | aliasIter |
| typedef std::vector < DtSymbolString > ::const_iterator | aliasConstIter |
| typedef std::vector< DtFilename > | SearchPaths |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
| Protected Types inherited from DtSimComponent | |
| typedef std::map< DtString, DtInputPort * > | DtInputPortMap |
| typedef std::map< DtString, DtOutputPort * > | DtOutputPortMap |
| typedef std::map< DtString, DtInputPortGroup * > | DtInputPortGroupMap |
| typedef std::map< DtString, DtOutputPortGroup * > | DtOutputPortGroupMap |
| Static Protected Attributes inherited from DtSimComponent | |
| static DtSimComponentFactory * | myFactory |
DtWeaponController is a controller that extends the DtBaseWeaponController with the ability to accept a list of targets as input.
End User Description: The weapon controller accepts input from a target sensor, and provides ammunition type, load status, and trigger inputs to a weapon actuator. It also provides azimuth and elevation inputs to corresponding azimuth and elevation mount actuators (moveable components upon which a weapon may be mounted).The weapon controller designates its target as the first target that appears in the entity's sector of responsibility. Based on the target type, it loads the appropriate munition type. If a change in target occurs, requiring a change in munition type, or fuze type, or both (that is, the new target detected is of a different type than the original target), the weapon unloads the old munition, and then fuse type, or both (that is, the new target loads the new type of munition. If no target is available, and the preload-weapon parameter is set, then the first munition type specified in the munition table is loaded. The target is acquired when the azimuth and elevation of the weapon align with the azimuth and elevation to the target, within the ranges specified by the munition-maneuver-margin parameter. The controller reorients the weapon in azimuth and elevation as needed. Once a target has been acquired, the weapon is loaded, and the entity has permission to fire (given by the entity's rules of engagement, for example, “fire-at-will”), the weapon controller fires. It sets the trigger port to true, and depletes the resource associated with the munition type.
Uses Descriptor Type: DtWeaponControllerDescriptor
| DtWeaponController::DtWeaponController | ( | const DtString & | name, |
| DtVrfObject * | owner, | ||
| DtSimManager * | simManager, | ||
| DtComponentDescriptor * | desc = 0, |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
(const DtString&,DtVrfObject*,DtSimManager*,
| 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). |
|
virtual |
destructor
|
protected |
default constructor; not implemented
|
protected |
copy constructor; not implemented
|
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.
Reimplemented from DtBaseWeaponController.
Reimplemented in DtLauncherController, and DtVerticalLauncherController.
|
virtual |
Overridden to create a DtMountingController.
Reimplemented from DtBaseWeaponController.
|
virtual |
Overridden to initialize values obtained from the descriptor.
Reimplemented from DtBaseWeaponController.
Reimplemented in DtLauncherController.
|
virtual |
If the myWaitingForFire flag is set and the munition loader is still loaded, the weapon has not fired yet and the function immediately returns.
Otherwise myWaitingForFire is set to false. If the output port group is activated and the simulation is not paused, chooseTarget() is called, the munition loader is ticked, and myLoadedPort is updated. If acquireTarget() and loadedAmmoValidForTarget() return true, fire() is called.
Reimplemented from DtBaseWeaponController.
Reimplemented in DtLauncherController.
|
virtual |
updates weapon interface
Reimplemented from DtBaseWeaponController.
Reimplemented in DtLauncherController.
|
virtual |
Called by tick() to find a target.
Calls acceptSensorTargettingInput(), to see if it has a target. If this function returns true, it looks up the target DtObjectId in myWeaponProcessState, and then looks up the DtVrfObject* for that ID in the DtVrfObjectManager. If the entity is found, it is set in the process state repository by calling myWeaponProcessState->setCurrentTarget and then the pointer is returned. If not, the current target is set to DtEntityIdentifier::nullId(), and a NULL pointer is returned.
|
virtual |
Called by acceptSensorTargettingInput to choose a target from the list of potential target entities on myTargetListPort.
The target is chosen based on whether or not the target is in the sector of responsibility. Targets in-sector (the entity's sector of responsibility) are selected over out-of-sector targets. It calls inSector() to determine if a given target is in the entity's sector of responsibility. It calls easier() to choose between two given target entities. It returns a pointer to the DtVrfObject* target that best met this criteria.
|
virtual |
This method will set the flags myLoading, myUnloading, myLoaded as the load state of the weapon changes.
The parameter is the entity object of the current target for the weapon. The loader will only perform an activity if it has a target, otherwise it remains idle.
Reimplemented in DtLauncherController.
|
virtual |
Returns true when target has been acquired.
If the target cannot be acquired given the azimuthSweep or elevationRange limitations of the weapon mounting, this method will invoke the method "maneuverToAcquireTarget" method. This function returns true if a given DtSimBaseEntity* target can be acquired, false if not. It starts by calling findBodyAzimuthElevationToTargetPoint() to get the azimuth and elevation angles to the target, in terms of the body coordinate system of the entity. It then calls desiredOrientationIsInRange(), testing to see if the azimuth and elevation angles are within the angular range given by myMunitionManeuverMargin (a parameter specified in the component descriptor). If this function return false, it calls maneuverRequiredToAcquireTarget(). Note: The base class version of this function is not implemented. Derived classes may implement a version that maneuvers the entity such that it can acquire the target. Similarly, if the entity is exceeding the maximum speed at which it can fire (myFireMaxVehicleSpeed), it calls maneuverRequiredToAcquireTarget(). If the target lies within myMunitionManeuverMargin, both in azimuth and elevation, it calls setTargetAcquired() in the entity local state repository, and returns true.
Reimplemented in DtVerticalLauncherController.
|
virtual |
Not implemented in this class.
Subclasses should implement this method to tie into their entity maneuver controllers to maneuver their vehicle to line up for a shot.
|
virtual |
Called by tick() as part of the check to see if the trigger should be pulled.
Returns false if the munition loader is not loaded. Otherwise it checks the ammo selection table to make sure that the currently loaded munition matches the entity type of the target parameter.
|
virtual |
The chooseAmmo() function is passed a pointer to a target entity and returns the best ammunition to use for the target's entity type.
Type of ammunition and availability, if any, is from the Ammo Select Table specified in the DtWeaponControllerDescriptor. The Ammo Select Table provides a list of ammunition types that are appropriate for a given target type, in order from most preferred to least preferred. The chooseAmmo() function starts at the beginning of the list of appropriate ammunition types, and returns the first one for which the resource is available. Note: Fuze types are not supported in the current version of VR-Forces; DtFuzeOther is returned for the fuze. If an entity type of DtEntityType::nullType() is passed in, the first munition in the Ammo Select Table is chosen.
If setCurrentMunition is false, then, this routine can be used to simply check to see if the munition exists for the particular entity without actually selecting it
|
virtual |
Returns true if we get a viable target from the sensor.
Checks to see if the entity already has a target by calling DtVrfWeaponPSR::currentTarget on myWeaponProcessState. If the entity does not currently have a target, it calls chooseTarget() to try to find one. If chooseTarget returns the valid DtObjectId of a target, it sets the target in myWeaponProcessState. Otherwise it calls setTargetAquired to indicate no target was aquired. If the entity already has a target specified in myWeaponProcessState, it checks the sensor input port to see if the target has been "forgotten" by the sensor (that is, the target ID is missing from the list of target entities present on the sensor input port). If it has been forgotten, it clears the target in myWeaponProcessState, setting its targetAcquired state to false, and its current target ID to DtObjectId::nullId(). It calls dataReceived on myTargetListPort before exiting.
|
virtual |
Sets the trigger port value to true, sets myLoaded flag to false, and depletes the resource associated with the current munition type in the entity's local state repository.
|
virtual |
Given a target entity, computes the body heading (azimuth) and elevation angles to the target, in the body coordinates of the entity.
|
virtual |
This function takes two DtVrfObject* entities as arguments, and returns the entity that is easier for the weapon to acquire.
In this base class function, it chooses the first entity argument, and returns it.
|
static |
(const DtString&,DtVrfObject*,DtSimManager*,
| 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). |
Reimplemented from DtBaseWeaponController.
Reimplemented in DtLauncherController, and DtVerticalLauncherController.
|
protectedvirtual |
Overridden to create the local ports.
Reimplemented from DtBaseWeaponController.
Reimplemented in DtLauncherController.
|
protectedvirtual |
Adds all items that have a range to the object state repository.
|
protected |
assignment operator; not implemented
|
protected |
|
protected |
Input Port Name: target-list
Input Port Description: List of targets detected.
Input Port Range:
Input Port Default Value:
Input Group Parent:
|
protected |
Input Port Name: weapons-hold
Input Port Description: When true, all firing of missiles is disabled.
Connecting to this port is optional. If no connection is made, it will default to false.
Input Port Range: True/False
Input Port Default Value: False
|
protected |
|
protected |
|
protected |