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 Member Functions | Protected Attributes
DtIndirectFireActuator Class Reference

DtIndirectFireActuator is an actuator that provides a simple model of a cannon. More...

Inheritance diagram for DtIndirectFireActuator:
Inheritance graph
[legend]

Public Member Functions

 DtIndirectFireActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtIndirectFireActuator ()
 destructor
virtual void preFirstTickInit ()
 Override to call initPendingDetonations() in the first tick, to schedule any outstanding detonations saved in our process state.
virtual void initPendingDetonations ()
 Called in the first tick.
virtual const chartype () const
 Returns a string identifies the class type of component.
virtual DtFireInteraction * createFireInteraction ()
 Overrides the DtWeaponActuator to create a DtFireInteraction based on the values from the input ports.
virtual DtDetonationInteractioncreateDetonationInteraction (DtTime &detTime)
 Instantiates a DtDetonationInteraction and fills out its values based on the values from the input ports.
virtual void scheduleDetonation (DtDetonationInteraction *detInter, DtTime detTime)
 Creates a DtDetonationTimerData object from detInter which is put into a DtTimer which generates a one-time callback to detonationCallback after detTime seconds.
virtual void fireTheWeapon ()
 DtWeaponActuator::fireTheWeapon is overridden to schedule a detonation interaction in addition to creating a fire interaction like the base class does.
virtual DtVrfObjectcreateMissileObject ()
 Creates a new vrf object for the artillery shell using the type and offset parameters specified in the descriptor.
virtual double calculateAngleOfFire (double distanceToTarget, DtVector &localFirerPosition, double HeightDifference, double launchSpeed)
 Calculate the angle of fire in order to hit a target that's a certain distance and possibly higher or lower than the launching unit.
virtual void addDispersion (DtVector &detLocation, bool addHeightDispersion)
 Adjusts detLocation based on the range and displacement error probabilities in myIndirectFireActuatorDescriptor.
virtual DtDetonationInteractioncreateDetonationInteraction (const DtDetonationDescriptor &desc, DtTime &detTime)
 Creates a new DtDetonationInteraction, given a DtDetonationDescriptor.
virtual DtDetonationDescriptorcreateDetonationDescriptor (DtDetonationInteraction *detInter, DtTime simTime)
 Creates and fills out a new DtDetonationDescriptor, given a DtDetonationInteraction and a time (simulation time to fire, in seconds).
virtual void processObjectAdded (DtVrfObject *vrfObject)
 Checks pending detonation list (in the process state repository) for target with same name as new object.
- Public Member Functions inherited from DtWeaponActuator
 DtWeaponActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtWeaponActuator ()
 destructor
virtual bool init ()
 to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports.
virtual void tick ()
 Fire if requested.
virtual bool postAddComponentsInit ()
 Overridden to initialize the value on myArtPartTypePort.
virtual void setProjectileStartSpeed (DtReal startSpeed)
virtual DtReal projectileStartSpeed ()
virtual void setMuzzleOffset (const DtVector &muzzleOffset)
virtual const DtVectormuzzleOffset ()
virtual const DtVectormuzzleLocalPosition ()
 Returns the weapon muzzle’s position in local coordinates.
virtual const DtDcm & weaponOrientation ()
 Returns the rotation matrix needed to rotate a vector from body coordinates of the weapon to local coordinates.
virtual
DtArticulatedPartStateRepository
getWeaponSimBody ()
 Looks up the DtSimBody* for the weapon in the entity’s state repository.
- Public Member Functions inherited from DtActuatorComponent
virtual ~DtActuatorComponent ()
 destructor
virtual DtSimRadioradio ()
virtual bool tickWhileDestroyed () const
 By default, all actuators tick when the entity is destroyed.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void postTick ()
 This function is called immediately after tick() is called.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
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 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
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 (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 void addAlias (const DtString &alias)
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () 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 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 (DtTimer *timer)
 Extracts and sends the DtDetonationInteraction stored in the DtTimer.
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
static void objectAddedCb (DtVrfObject *vrfObject, void *usr)
 Calls processObjectAdded().

Protected Member Functions

virtual bool createPorts ()
 Creates the input ports and adds them to the component.
virtual bool createPSR ()
 Creates #myProcessState data member, and adds it to our process state repository manager.
 DtIndirectFireActuator ()
 default constructor; not implemented
 DtIndirectFireActuator (const DtIndirectFireActuator &orig)
 copy constructor; not implemented
const DtIndirectFireActuatoroperator= (const DtIndirectFireActuator &orig)
 assignment operator; not implemented
- Protected Member Functions inherited from DtWeaponActuator
virtual bool createPortGroups ()
 Creates the local port groups.
 DtWeaponActuator ()
 default constructor; not implemented
 DtWeaponActuator (const DtWeaponActuator &orig)
 copy constructor; not implemented
const DtWeaponActuatoroperator= (const DtWeaponActuator &orig)
 assignment operator; not implemented
- Protected Member Functions inherited from DtActuatorComponent
 DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
 DtActuatorComponent (const DtActuatorComponent &orig)
 copy constructor
const DtActuatorComponentoperator= (const DtActuatorComponent &orig)
 assignment operator
virtual void setRadio (DtSimRadio *radio)
 DtActuatorComponent ()
 Default constructor; should not be called.
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT.
bool testInvariant () const
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager.
- 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

DtReal myMuzzleSpeed
DtList myTimerList
DtIndirectFireActuatorDescriptormyIndirectFireActuatorDescriptor
DtVrfIndirectFirePSRmyIndirectFireProcessState
 We've overrode createPSR() to create derived kind of DtVrfWeaponPSR.
Ports and Port Groups
DtVectorInputPortmyTargetPointPort
 Input Port Name: target-point-port
Input Port Description: Local position to fire at.
DtAnalogInputPortmyMaxRangePort
 Input Port Name: max-range-port
Input Port Description: Maximum range in meters.
DtBooleanInputPortmyAlignedDirectlyPort
 Input Port Name: aligned-directly-port
Input Port Description: Whether this gun can align directly with the target if it is close in
Input Port Range:
Input Port Default Value:
Input Group Parent:
- Protected Attributes inherited from DtWeaponActuator
DtWeaponActuatorDescriptormyWeaponActuatorDescriptor
DtReal myProjectileStartSpeed
DtVector myMuzzleOffset
DtSharedVrfObjectReference myCurrentEntityTarget
 These are set by createFireInteraction and used by createDetonationInteraction.
DtEventId myCurrentEventId
DtReal myCurrentRange
DtVrfWeaponPSRmyWeaponProcessState
DtInputPortGroupmyWeaponInputPortGroup
 Input Port Group Name: weapon-control
Input Port Group Description:
DtAmmunitionInputPortmyAmmunitionPort
 Input Port Name: ammunition
Input Port Description: Type of ammo to fire.
DtConstrainedIntegerInputPortmyFusePort
 Input Port Name: fuze
Input Port Description: DIS Enumeration for fuze (see DIS Enumeration and Bit Encoded Values document for values).
DtBooleanInputPortmyTriggerPort
 Input Port Name: trigger
Input Port Description: True to fire.
DtBooleanInputPortmyLoadedPort
 Input Port Name: loaded
Input Port Description: True if loaded.
DtOutputPortGroupmyWeaponOutputPortGroup
 Output Port Group Name: weapon-info
Output Port Group Description:
DtIntegerOutputPortmyArtPartTypePort
 Output Port Name: art-part-type
Output Port Description: Type of the articulated part.
- Protected Attributes inherited from DtActuatorComponent
DtSimRadiomyRadio
 Actuators 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.

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
typedef std::vector< DtFilename > SearchPaths
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- Protected Types inherited from DtSimComponent
typedef std::map< DtString,
DtInputPort * > 
DtInputPortMap
typedef std::map< DtString,
DtOutputPort * > 
DtOutputPortMap
typedef std::map< DtString,
DtInputPortGroup * > 
DtInputPortGroupMap
typedef std::map< DtString,
DtOutputPortGroup * > 
DtOutputPortGroupMap
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

DtIndirectFireActuator is an actuator that provides a simple model of a cannon.

End User Description: It can be given ammo to load, and the command to fire. It creates a fire interaction and creates a detonation interaction, which it schedules to be sent.

The accuracy of indirect fire is measured by a set of probably error distances. Fifty percent of all rounds will fall within this range (25% over, 25% under, 25% left, 25% right). All rounds will fall within four times the probably error distance.

Uses Descriptor Type: DtIndirectFireActuatorDescriptor

Constructor & Destructor Documentation

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

destructor

DtIndirectFireActuator::DtIndirectFireActuator ( )
protected

default constructor; not implemented

DtIndirectFireActuator::DtIndirectFireActuator ( const DtIndirectFireActuator orig)
protected

copy constructor; not implemented

Member Function Documentation

virtual void DtIndirectFireActuator::preFirstTickInit ( )
virtual

Override to call initPendingDetonations() in the first tick, to schedule any outstanding detonations saved in our process state.

Reimplemented from DtSimComponent.

virtual void DtIndirectFireActuator::initPendingDetonations ( )
virtual

Called in the first tick.

Creates and schedules any pending detonations from detonation descriptor data in the process state repository. For those detonations whose target does not exist yet (e.g. target may be remote and not discovered yet), registers the objectAddedCb to provide an opportunity to create and schedule those pending detonations at a later time.

virtual const char* DtIndirectFireActuator::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
DtIndirectFireActuatorType

Reimplemented from DtWeaponActuator.

virtual DtFireInteraction* DtIndirectFireActuator::createFireInteraction ( )
virtual

Overrides the DtWeaponActuator to create a DtFireInteraction based on the values from the input ports.

The myMuzzleSpeed member variable is calculated as the square root of the product of the maximum range times DtGRAVITY_CONSTANT. The myCurrentRange member variable is calculated as the distance from the weapon to the target in meters. A new event Id is obtained from the exercise connection and assigned to the myCurrentEventId member variable.

Reimplemented from DtWeaponActuator.

virtual DtDetonationInteraction* DtIndirectFireActuator::createDetonationInteraction ( DtTime detTime)
virtual

Instantiates a DtDetonationInteraction and fills out its values based on the values from the input ports.

It will modify the given DtReal parameter to contain the amount of time in seconds before the detonation should be sent out. The delay is calculated as range / (muzzle speed * launch angle). Calls addDispersion() to introduce random error into the location of the detonation. If the fuze type is not DtFuzeContact, addDispersion() will be called with height dispersion enabled.

virtual void DtIndirectFireActuator::scheduleDetonation ( DtDetonationInteraction detInter,
DtTime  detTime 
)
virtual

Creates a DtDetonationTimerData object from detInter which is put into a DtTimer which generates a one-time callback to detonationCallback after detTime seconds.

virtual void DtIndirectFireActuator::fireTheWeapon ( )
virtual

DtWeaponActuator::fireTheWeapon is overridden to schedule a detonation interaction in addition to creating a fire interaction like the base class does.

Reimplemented from DtWeaponActuator.

virtual DtVrfObject* DtIndirectFireActuator::createMissileObject ( )
virtual

Creates a new vrf object for the artillery shell using the type and offset parameters specified in the descriptor.

Returns a pointer to the newly created object.

virtual double DtIndirectFireActuator::calculateAngleOfFire ( double  distanceToTarget,
DtVector localFirerPosition,
double  HeightDifference,
double  launchSpeed 
)
virtual

Calculate the angle of fire in order to hit a target that's a certain distance and possibly higher or lower than the launching unit.

virtual void DtIndirectFireActuator::addDispersion ( DtVector detLocation,
bool  addHeightDispersion 
)
virtual

Adjusts detLocation based on the range and displacement error probabilities in myIndirectFireActuatorDescriptor.

If addHeightDispersion is true, then it will also adjust the height of the detonation based on the burst height probability.

static void DtIndirectFireActuator::detonationCallback ( DtTimer timer)
static

Extracts and sends the DtDetonationInteraction stored in the DtTimer.

static DtSimComponent* DtIndirectFireActuator::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 DtWeaponActuator.

virtual DtDetonationInteraction* DtIndirectFireActuator::createDetonationInteraction ( const DtDetonationDescriptor desc,
DtTime detTime 
)
virtual

Creates a new DtDetonationInteraction, given a DtDetonationDescriptor.

Fills out new new interaction with data from the descriptor and returns the detonation time (time in seconds relative to current sim time). The resulting DtDetonationInteraction and DtTime can be directly passed into scheduleDetonation.

virtual DtDetonationDescriptor* DtIndirectFireActuator::createDetonationDescriptor ( DtDetonationInteraction detInter,
DtTime  simTime 
)
virtual

Creates and fills out a new DtDetonationDescriptor, given a DtDetonationInteraction and a time (simulation time to fire, in seconds).

static void DtIndirectFireActuator::objectAddedCb ( DtVrfObject vrfObject,
void *  usr 
)
static
virtual void DtIndirectFireActuator::processObjectAdded ( DtVrfObject vrfObject)
virtual

Checks pending detonation list (in the process state repository) for target with same name as new object.

If one exists, sets the target global id in the pending object item (a DtDetonationDescriptor), and then schedules the detonation, given the data in the descriptor.

virtual bool DtIndirectFireActuator::createPorts ( )
protectedvirtual

Creates the input ports and adds them to the component.

Reimplemented from DtWeaponActuator.

virtual bool DtIndirectFireActuator::createPSR ( )
protectedvirtual

Creates #myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

Reimplemented from DtWeaponActuator.

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

assignment operator; not implemented

Member Data Documentation

DtVectorInputPort* DtIndirectFireActuator::myTargetPointPort
protected

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


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

DtAnalogInputPort* DtIndirectFireActuator::myMaxRangePort
protected

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


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

DtBooleanInputPort* DtIndirectFireActuator::myAlignedDirectlyPort
protected

Input Port Name: aligned-directly-port
Input Port Description: Whether this gun can align directly with the target if it is close in
Input Port Range:
Input Port Default Value:
Input Group Parent:

DtReal DtIndirectFireActuator::myMuzzleSpeed
protected
DtList DtIndirectFireActuator::myTimerList
protected
DtIndirectFireActuatorDescriptor* DtIndirectFireActuator::myIndirectFireActuatorDescriptor
protected
DtVrfIndirectFirePSR* DtIndirectFireActuator::myIndirectFireProcessState
protected

We've overrode createPSR() to create derived kind of DtVrfWeaponPSR.

This member variable provided for convenient point to derived type.


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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)