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

DtLauncherController is a controller that accepts input from a target sensor, and provides ammunition type, load status, and trigger inputs to a missile launcher actuator. More...

Inheritance diagram for DtLauncherController:
Inheritance graph
[legend]

Public Member Functions

 DtLauncherController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtLauncherController ()
 destructor
virtual bool init ()
 Overridden to register a detonation callback and to initialize myCreateMissileInfo.
virtual const chartype () const
 Returns a string identifies the class type of component.
virtual void preFirstTickInit ()
 Looks through the current list of missiles from the object manager to see if any have a state repository which indicates that that the attackerId is the same as the objectId of the entity to which this controller is attached.
virtual void tick ()
 Calculate new control values.
virtual void tickMunitionLoader (const DtVrfObject *target)
 This method sets the flags myLoading, myUnloading, myLoaded as the load state of the weapon changes.
virtual bool createMissileIdPort ()
 These are called in init to create the ports used to communicate with the actuator.
virtual DtObjectIdOutputPortmissileIdPort () const
virtual bool createTargetPointPort ()
virtual DtVectorOutputPorttargetPointPort () const
virtual bool createTargetEntityIdPort ()
virtual DtObjectIdOutputPorttargetEntityIdPort () const
virtual void fire ()
 Creates and initializes a new missile object.
virtual void missileDetonated (DtDetonationInteraction *detInter)
 For removing missile entities from local list after they are destroyed.
virtual void disconnectMissileFromLauncher (const DtEntityIdentifier &missId)
 Takes a DtEntityIdentifier of a missile as an argument.
virtual void disconnectMissileFromLauncher (DtVrfObject *missile)
virtual DtVrfObjectmostRecentMissileFired ()
 Returns the most recent missile fired (and still connected) or NULL.
virtual bool lastMissilePassedTarget (DtVrfObject *lastMissile)
 Returns whether the last fired missile has passed it's target or not.
virtual double abandonPassedMissileDistance ()
virtual void setAbandonPassedMissileDistance (const double &distance)
- Public Member Functions inherited from DtWeaponController
 DtWeaponController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtWeaponController ()
 destructor
virtual bool createMountingController ()
 Overridden to create a DtMountingController.
virtual DtVrfObjectchooseTarget ()
 Called by tick() to find a target.
virtual DtVrfObjectchooseTarget (const DtEntityTargetList &targetList) const
 Called by acceptSensorTargettingInput to choose a target from the list of potential target entities on myTargetListPort.
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 DtVrfObjecteasier (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 DtOutputPortGroupweaponOutputPortGroup ()
 Returns myWeaponOutputPortGroup.
virtual bool createWeaponInputPortGroup ()
 Initializes myWeaponInputPortGroup.
virtual DtInputPortGroupweaponInputPortGroup ()
 Returns myWeaponInputPortGroup.
virtual bool createTriggerPort ()
 These are called in init to create the ports used to communicate with the actuator.
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.
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 DtBaseMountingControllermountingController ()
 returns the DtBaseMountingController
virtual void setCurrentMunitionName (const DtString &currentMunitionName)
 sets the current munition name in the DtVrfWeaponPSR
virtual const DtStringcurrentMunitionName () const
 gets the current munition name from the DtVrfWeaponPSR
virtual DtVrfWeaponPSRweaponProcessState ()
 Returns the DtVrfWeaponPSR.
virtual const DtVrfWeaponPSRweaponProcessState () 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 DtSimRadioradio ()
 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 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 DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
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.
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 DtInputPortlookupInputPort (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 DtOutputPortlookupOutputPort (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 DtInputPortGrouplookupInputPortGroup (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 DtOutputPortGrouplookupOutputPortGroup (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.
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_SystemcoordinateSystem ()
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 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
 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 DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
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.
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 (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.
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 void addAlias (const DtString &alias)
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () 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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () 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 void detonationCallback (DtDetonationInteraction *detInter, void *usr)
 This callback function is registered with the exercise connection to handle incoming DtDetonationInteractions.

Protected Attributes

double myAbandonPassedMissileDistance
 If the missile passes its target within this distance, it will be abandoned and disconnected from the launcher.
Ports and Port Groups
DtObjectIdOutputPortmyMissileIdPort
 Output Port Name: missile-id
Output Port Description: Object id of the missile.
DtObjectIdOutputPortmyTargetEntityIdPort
 Output Port Name: target-entity
Output Port Description: Object id of the target.
DtVectorOutputPortmyTargetPointPort
 Output Port Name: target-point
Output Port Description: Local position of the target.
- Protected Attributes inherited from DtWeaponController
DtUUID myCurrentTarget
DtMountingControllermyMountingController
const
DtWeaponControllerDescriptor
myWeaponCtlrDesc
DtWeaponComponentInterfacemyWeaponComponentInterface
DtEntityListInputPortmyTargetListPort
 Input Port Name: target-list
Input Port Description: List of targets detected.
DtBooleanInputPortmyWeaponsHoldPort
 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.
DtBaseMountingControllermyBaseMountingController
DtVrfWeaponPSRmyWeaponProcessState
 Pointer to a process state repository used to store state data associated with this component.
DtOutputPortGroupmyWeaponOutputPortGroup
 Output Port Group Name: weapon-control
Output Port Group Description:
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.
DtBooleanOutputPortmyTriggerPort
 Output Port Name: trigger
Output Port Description: True to fire.
DtBooleanOutputPortmyLoadedPort
 Output Port Name: loaded
Output Port Description: True if loaded.
DtInputPortGroupmyWeaponInputPortGroup
 Input Port Group Name: weapon-info
Input Port Group Description:
DtIntegerInputPortmyArtPartTypePort
 Input Port Name: art-part-type
Input Port Description: Type of articulated part.
- Protected Attributes inherited from DtControllerComponent
DtSimRadiomyRadio
 Controller components can send messages.
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
DtVrfObjectStateRepositorymyLocalStateRepository
DtSimManagermySimManager
DtComponentSystemmySystem
 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.
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.
const DtComponentDescriptormyComponentDescriptor
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed.
bool myTickEveryFrame
 Flag indicating that tickPeriod is set to 0, and the component will tick every frame.
- 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.
bool myInvalid
 Set to true if there is a problem reading this item.
DtIfCreateVrfObject myCreateMissileInfo
 Attribute functions:Overrides the simComponent version to register the functions below.
DtList myActiveMissiles
 Attribute functions:Overrides the simComponent version to register the functions below.
virtual void registerAttributeFunctions ()
 Attribute functions:Overrides the simComponent version to register the functions below.
static DtReaderWriterprovideLastMissileName (void *controller)
 Function to be registered as a provider with the parent component system for the launched-munition-name attribute.
static DtReaderWriterprovideMissilePassedTarget (void *controller)
 Function to be registered as a provider with the parent component system for the missile-passed-target attribute.
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual bool createPorts ()
 Overridden to create the launcher's ports.
virtual DtReaderWriterprocessProvideLastMissileName ()
 Provides the name (DtRwString) of the missile that was last launched.
virtual DtReaderWriterprocessProvideMissilePassedTarget ()
 Provides result of whether the current missile has passed the target or not (DtRwBoolean)
virtual void removeMissileFromActiveList (const DtEntityIdentifier &removeId)
 Removes the DtObjectId of a given missile from myActiveMissiles list.
 DtLauncherController ()
 default constructor; not implemented
 DtLauncherController (const DtLauncherController &orig)
 copy constructor; not implemented
const DtLauncherControlleroperator= (const DtLauncherController &orig)
 assignment operator; not implemented

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
- Protected Member Functions inherited from DtWeaponController
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 DtWeaponControlleroperator= (const DtWeaponController &orig)
 assignment operator; not implemented
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

DtLauncherController is a controller that accepts input from a target sensor, and provides ammunition type, load status, and trigger inputs to a missile launcher actuator.

End User Description: It also provides azimuth and elevation inputs to corresponding azimuth and elevation mount actuators (moveable components upon which the launcher may be mounted). The launcher 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 fuse 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 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.

When a guided missile is fired, reloading is suspended while the missile is active. Once the missile detonates or passes the target, reloading may resume.

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 creates a new missile entity, sets the ID of the missile entity in the missile ID port, sets the trigger port to true, and depletes the resource associated with the missile type.

Uses Descriptor Type: DtWeaponControllerDescriptor

Constructor & Destructor Documentation

DtLauncherController::DtLauncherController ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

(const DtString&,DtVrfObject*,DtSimManager*,

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).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtLauncherController::~DtLauncherController ( )
virtual

destructor

DtLauncherController::DtLauncherController ( )
protected

default constructor; not implemented

DtLauncherController::DtLauncherController ( const DtLauncherController orig)
protected

copy constructor; not implemented

Member Function Documentation

virtual bool DtLauncherController::init ( )
virtual

Overridden to register a detonation callback and to initialize myCreateMissileInfo.

Reimplemented from DtWeaponController.

virtual const char* DtLauncherController::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
DtLauncherControllerType

Reimplemented from DtWeaponController.

Reimplemented in DtVerticalLauncherController.

virtual void DtLauncherController::preFirstTickInit ( )
virtual

Looks through the current list of missiles from the object manager to see if any have a state repository which indicates that that the attackerId is the same as the objectId of the entity to which this controller is attached.

If so the ID of the missile is added to myActiveMissiles.

Reimplemented from DtSimComponent.

virtual void DtLauncherController::tick ( )
virtual

Calculate new control values.

Reimplemented from DtWeaponController.

virtual void DtLauncherController::tickMunitionLoader ( const DtVrfObject target)
virtual

This method sets 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. This override of the base performs pre-loading of the launcher even if there is no target. Overrides DtWeaponController::tickMunitionLoader(). Before calling down to the base class's version of this function, it checks to see if the last guided missile fired has missed its target. If no such missile exists, or if it is a fire-and-forget type of missile, the function calls down to the base class's tickMunitionLoader() to continue the loading process. If the last missile fired is a guided missile, and it has not passed its target, it returns without calling the base class tickMunitionLoader(). This has the effect of suspending load operations while an operator-guided missile is still active. Otherwise, if the missile has passed it's target disconnectMissileFromLauncher is called.

Reimplemented from DtWeaponController.

virtual bool DtLauncherController::createMissileIdPort ( )
virtual

These are called in init to create the ports used to communicate with the actuator.

virtual DtObjectIdOutputPort* DtLauncherController::missileIdPort ( ) const
virtual
virtual bool DtLauncherController::createTargetPointPort ( )
virtual
virtual DtVectorOutputPort* DtLauncherController::targetPointPort ( ) const
virtual
virtual bool DtLauncherController::createTargetEntityIdPort ( )
virtual
virtual DtObjectIdOutputPort* DtLauncherController::targetEntityIdPort ( ) const
virtual
virtual void DtLauncherController::fire ( )
virtual

Creates and initializes a new missile object.

It sets the DtObjectId of the new missile object in myMissileIdPort, sets the trigger value to true in myTriggerPort, and adds the missile's ID to the myActiveMissiles list. Finally, it looks up the resource corresponding to the missile type in the entity's local state repository, and decrements the count on that resource.

Reimplemented from DtWeaponController.

virtual void DtLauncherController::missileDetonated ( DtDetonationInteraction detInter)
virtual

For removing missile entities from local list after they are destroyed.

Takes a DtDetonationInteraction as an argument. It goes through its list of active missiles (myActiveMissiles), searching for an ID that matches the munition ID specified in the DtDetonationInteraction. If it is found, it calls removeMissileFromActiveList(), to remove and delete the missile DtObjectId in the myActiveMissiles list.

static void DtLauncherController::detonationCallback ( DtDetonationInteraction detInter,
void *  usr 
)
static

This callback function is registered with the exercise connection to handle incoming DtDetonationInteractions.

It calls missileDetonated() to process the interaction.

virtual void DtLauncherController::disconnectMissileFromLauncher ( const DtEntityIdentifier &  missId)
virtual

Takes a DtEntityIdentifier of a missile as an argument.

If the missile is found in the myActiveMissiles list, it looks up the missile object by DtEntityIdentifier in the DtVrfObjectManager. If found, it calls DtMissileStateRepository::setDisconnectedFromLauncher(), and removes and deletes the missile DtEntityIdentifier from the myActiveMissiles list. The second version of this function takes a missile object as an argument. It calls down to the first version of the function to perform the actual work.

virtual void DtLauncherController::disconnectMissileFromLauncher ( DtVrfObject missile)
virtual
virtual DtVrfObject* DtLauncherController::mostRecentMissileFired ( )
virtual

Returns the most recent missile fired (and still connected) or NULL.

virtual bool DtLauncherController::lastMissilePassedTarget ( DtVrfObject lastMissile)
virtual

Returns whether the last fired missile has passed it's target or not.

virtual double DtLauncherController::abandonPassedMissileDistance ( )
virtual
virtual void DtLauncherController::setAbandonPassedMissileDistance ( const double &  distance)
virtual
virtual void DtLauncherController::registerAttributeFunctions ( )
virtual

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

Reimplemented from DtSimComponent.

static DtReaderWriter* DtLauncherController::provideLastMissileName ( void *  controller)
static

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

Calls processProvideLastMissileName.

static DtReaderWriter* DtLauncherController::provideMissilePassedTarget ( void *  controller)
static

Function to be registered as a provider with the parent component system for the missile-passed-target attribute.

Calls processProvideMissilePassedTarget.

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

(const DtString&,DtVrfObject*,DtSimManager*,

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).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.

Reimplemented from DtWeaponController.

Reimplemented in DtVerticalLauncherController.

virtual bool DtLauncherController::createPorts ( )
protectedvirtual

Overridden to create the launcher's ports.

Reimplemented from DtWeaponController.

virtual DtReaderWriter* DtLauncherController::processProvideLastMissileName ( )
protectedvirtual

Provides the name (DtRwString) of the missile that was last launched.

virtual DtReaderWriter* DtLauncherController::processProvideMissilePassedTarget ( )
protectedvirtual

Provides result of whether the current missile has passed the target or not (DtRwBoolean)

virtual void DtLauncherController::removeMissileFromActiveList ( const DtEntityIdentifier &  removeId)
protectedvirtual

Removes the DtObjectId of a given missile from myActiveMissiles list.

It deletes the DtObjectId data in the list entry.

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

assignment operator; not implemented

Member Data Documentation

DtIfCreateVrfObject DtLauncherController::myCreateMissileInfo
protected

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

DtList DtLauncherController::myActiveMissiles
protected

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

DtObjectIdOutputPort* DtLauncherController::myMissileIdPort
protected

Output Port Name: missile-id
Output Port Description: Object id of the missile.


Output Port Range:
Output Port Default Value:
Output Group Parent: weapon-control

DtObjectIdOutputPort* DtLauncherController::myTargetEntityIdPort
protected

Output Port Name: target-entity
Output Port Description: Object id of the target.


Output Port Range:
Output Port Default Value:
Output Group Parent: weapon-control

DtVectorOutputPort* DtLauncherController::myTargetPointPort
protected

Output Port Name: target-point
Output Port Description: Local position of the target.


Output Port Range:
Output Port Default Value:
Output Group Parent: weapon-control

double DtLauncherController::myAbandonPassedMissileDistance
protected

If the missile passes its target within this distance, it will be abandoned and disconnected from the launcher.

Defaults to 100 meters.


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

Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)