 |
VR-Forces 4.10 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.10 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) | |
| virtual | ~DtWeaponController () |
| destructor More... | |
| virtual const char * | type () const |
| Returns a string identifies the class type of component. More... | |
| virtual bool | createMountingController () |
| Overridden to create a DtMountingController. More... | |
| virtual bool | init () |
| Overridden to initialize values obtained from the descriptor. More... | |
| virtual void | preFirstTickInit () |
| Starts with weapon loaded, if the weapon has a full complement of ammunition. More... | |
| 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. More... | |
| virtual void | fire () |
| updates weapon interface More... | |
| virtual const DtVrfObject * | chooseTarget () |
| Called by tick() to find a target. More... | |
| virtual const DtVrfObject * | chooseTarget (const DtEntityTargetList &targetList) const |
| Calls acceptSensorTargettingInput to get a target from the weapon interface and put it in the PSR as the current target (this has nothing to do with sensors). More... | |
| virtual void | tickMunitionLoader (const DtVrfObject *target) |
| This method will set the flags myLoading, myUnloading, myLoaded as the load state of the weapon changes. More... | |
| virtual bool | acquireTarget (const DtVrfObject *target) |
| Returns true when target has been acquired. More... | |
| virtual void | maneuverRequiredToAcquireTarget (DtReal requiredHeading, DtReal requiredPitch, DtReal requiredMaxSpeed) |
| Not implemented in this class. More... | |
| bool | outOfAmmo () const |
| Returns true if this weapon is entirely out of ammunition. More... | |
| virtual bool | loadedAmmoValidForTarget (const DtVrfObject *target) const |
| Called by tick() as part of the check to see if the trigger should be pulled. More... | |
| 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. More... | |
| virtual bool | acceptSensorTargettingInput () |
| Returns true if we get a viable target from the weapon interface and sets this target in the PSR. More... | |
| virtual bool | inSector (const 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. More... | |
| 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. More... | |
| virtual const DtVrfObject * | easier (const DtVrfObject *entity1, const DtVrfObject *entity2) const |
| This function takes two DtVrfObject* entities as arguments, and returns the entity that is easier for the weapon to acquire. More... | |
| virtual void | enable () |
| Is this component enabled or not. More... | |
| virtual void | disable () |
 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 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 DtOutputPortGroup * | weaponOutputPortGroup () |
| Returns myWeaponOutputPortGroup. More... | |
| virtual bool | createWeaponInputPortGroup () |
| Initializes myWeaponInputPortGroup. More... | |
| virtual DtInputPortGroup * | weaponInputPortGroup () |
| Returns myWeaponInputPortGroup. More... | |
| virtual bool | createTriggerPort () |
| These are called in init to create the ports used to communicate with the actuator. More... | |
| 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. 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 DtBaseMountingController * | mountingController () |
| returns the DtBaseMountingController More... | |
| virtual void | setCurrentMunitionName (const DtString ¤tMunitionName) |
| sets the current munition name in the DtVrfWeaponPSR More... | |
| virtual const DtString & | currentMunitionName () const |
| gets the current munition name from the DtVrfWeaponPSR More... | |
| virtual DtVrfWeaponPSR * | weaponProcessState () |
| Returns the DtVrfWeaponPSR. More... | |
| virtual const DtVrfWeaponPSR * | weaponProcessState () 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 DtSimRadio * | radio () |
| 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... | |
| DtComponentSystem * | parentSystem () const |
| virtual void | registerAttributeFunctions () |
| Called to register functions that provide system attribute values. More... | |
| 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 DtSimComponent * | nextComponent () |
| List management functions. More... | |
| virtual DtSimComponent * | prevComponent () |
| 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 DtInputPort * | lookupInputPort (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 DtOutputPort * | lookupOutputPort (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 DtInputPortGroup * | lookupInputPortGroup (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 DtOutputPortGroup * | lookupOutputPortGroup (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... | |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| virtual const DtSymbolString & | componentFullName () const |
| DtPhysicalWorld * | physicalWorld () |
| Gets the physical world that this component's entity exists in. More... | |
| const DtPhysicalWorld * | physicalWorld () const |
| DtAttachedTerrain * | terrainAttachedTo () |
| Gets the terrain that this component's entity is attached to, if any. More... | |
| const DtAttachedTerrain * | terrainAttachedTo () const |
| DtVrfObject * | entity () |
| Gets the entity. More... | |
| const DtVrfObject * | entity () const |
| const DtVrfObject * | const_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... | |
| DtSimManager * | simManager () |
| Gets the sim manager. More... | |
| const DtSimManager * | simManager () const |
| const Coordinate_System * | coordinateSystem () const |
| Gets the coordinate system, as it should always exist if the physical world is in a valid state! More... | |
| DtVrfObjectStateRepository * | localStateRepository () |
| Gets the local state repository. More... | |
| const DtVrfObjectStateRepository * | localStateRepository () const |
| const DtVrfObjectStateRepository * | const_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 DtTaskVisualizationMap & | taskVisualizations () |
| 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 DtSimResourceManager & | resourceManager () |
| 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 DtReaderWriter & | operator= (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 aliasContainer & | aliases () 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 char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. More... | |
| virtual const char * | xmlType () 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 DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. More... | |
| virtual DtReaderWriter * | defaultRWValue () |
| 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 DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. More... | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () 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 DtSimComponent * | creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| Static Public Member Functions inherited from DtBaseWeaponController | |
| static DtSimComponent * | creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| Static Public Member Functions inherited from DtSimComponent | |
| static DtSimComponent * | MarkThreadSafe (DtSimComponent *) |
| Marks an instance of a component as being thread safe. More... | |
| static DtSimComponentFactory * | factory () |
| A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More... | |
| static void | setFactory (DtSimComponentFactory *factory) |
| static DtSimComponent * | createComponent (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 char * | theXmlType () |
| 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 DtReaderWriterFactory * | factory () |
| static void | setOutputStream (DtOutputStream *stream) |
| static DtOutputStream & | outputStream () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| Given a filename, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromEnvironment (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 create the local ports. More... | |
| virtual void | addRangeItems () |
| Adds all items that have a range to the object state repository. More... | |
| DtWeaponController () | |
| default constructor; not implemented More... | |
| DtWeaponController (const DtWeaponController &orig) | |
| copy constructor; not implemented More... | |
| const DtWeaponController & | operator= (const DtWeaponController &orig) |
| assignment operator; not implemented More... | |
| 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... | |
| 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... | |
| DtBaseWeaponController () | |
| default constructor; not implemented More... | |
| DtBaseWeaponController (const DtBaseWeaponController &orig) | |
| copy constructor; not implemented More... | |
| const DtBaseWeaponController & | operator= (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 DtControllerComponent & | operator= (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 |
| DtVrfProcessStateRepository * | createComponentPsr (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 | |
| DtUUID | myCurrentTarget |
| DtMountingController * | myMountingController |
| const DtWeaponControllerDescriptor * | myWeaponCtlrDesc |
| DtWeaponComponentInterface * | myWeaponComponentInterface |
| std::map< DtString, DtSimMunition > | myUsableMunitions |
| double | myMaxMunitionEffectiveRange |
Ports and Port Groups | |
| DtEntityListInputPort * | myTargetListPort |
| Input Port Name: target-list Input Port Description: List of targets detected. More... | |
| DtBooleanInputPort * | myWeaponsHoldPort |
| Input Port Name: weapons-hold Input Port Description: When true, all firing of missiles is disabled. 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... | |
| DtBaseMountingController * | myBaseMountingController |
| DtVrfWeaponPSR * | myWeaponProcessState |
| Pointer to a process state repository used to store state data associated with this component. More... | |
| DtOutputPortGroup * | myWeaponOutputPortGroup |
| Output Port Group Name: weapon-control Output Port Group Description: More... | |
| 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. More... | |
| DtBooleanOutputPort * | myTriggerPort |
| Output Port Name: trigger Output Port Description: True to fire. More... | |
| DtBooleanOutputPort * | myLoadedPort |
| Output Port Name: loaded Output Port Description: True if loaded. More... | |
| DtInputPortGroup * | myWeaponInputPortGroup |
| Input Port Group Name: weapon-info Input Port Group Description: More... | |
| DtIntegerInputPort * | myArtPartTypePort |
| Input Port Name: art-part-type Input Port Description: Type of articulated part. More... | |
| Protected Attributes inherited from DtControllerComponent | |
| DtSimRadio * | myRadio |
| Controller components can send messages. More... | |
| Protected Attributes inherited from DtSimComponent | |
| DtVrfObject * | myEntity |
| DtVrfObjectStateRepository * | myLocalStateRepository |
| DtSimManager * | mySimManager |
| DtComponentSystem * | mySystem |
| 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 DtComponentDescriptor * | myComponentDescriptor |
| 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 |
| 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. 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... | |
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 |
||
| ) |
| 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. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.
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 |
Starts with weapon loaded, if the weapon has a full complement of ammunition.
Reimplemented from DtSimComponent.
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 DtUUID::nullUUID(), and a NULL pointer is returned.
|
virtual |
Calls acceptSensorTargettingInput to get a target from the weapon interface and put it in the PSR as the current target (this has nothing to do with sensors).
Given this target (or null), the mounting controller targetPoint or useTargetPoint is set.
|
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.
|
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.
| bool DtWeaponController::outOfAmmo | ( | ) | const |
Returns true if this weapon is entirely out of ammunition.
|
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 weapon interface and sets this target in the PSR.
If there is no target in the WI, then null is set into the PSR. Note: the "sensor" part of this is obsolete; there is not connection to sensors.
|
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 |
| 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 |
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 |
Reimplemented from DtSimComponent.
|
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 |
|
protected |
|
protected |