Public Member Functions |
| | DtWarheadDetonationActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| | (const DtString&,DtVrfObject*,DtSimManager*,
|
| virtual | ~DtWarheadDetonationActuator () |
| | destructor
|
| virtual bool | init () |
| | Overridden to cache a pointer to the entity's radio in this class.
|
| virtual bool | registerRadioMessageCallbacks () |
| | Registers for DtSetWarheadInfo messages.
|
| virtual bool | createPSR () |
| | Creates myProcessState data member, and adds it to our process state repository manager.
|
| virtual void | setComponentDescriptor (DtComponentDescriptor *componentDescriptor) |
| | Overridden to get the DtWarheadDetonationActuatorDescriptor.
|
| virtual const char * | type () const |
| | Returns a string identifies the class type of component.
|
| virtual void | tick () |
| | Checks for any collisions, and creates detonation if they are detected.
|
| virtual void | processWarheadInfoCallback (DtSimMessage *msg) |
| | Processes an incoming SetWarheadInfo message by setting the fuze, warhead, attacker ID, and event ID.
|
| virtual | ~DtActuatorComponent () |
| | destructor
|
| virtual DtSimRadio * | radio () |
| virtual bool | tickWhileDestroyed () const |
| | By default, all actuators tick when the entity is destroyed.
|
| | 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 bool | postAddComponentsInit () |
| | Called after all components have been created, initialized and added to the component manager.
|
| virtual void | registerAttributeFunctions () |
| | Called to register functions that provide system attribute values.
|
| virtual void | preFirstTickInit () |
| | This function can be overridden to initialize a component before it is ticked for the first time.
|
| virtual void | postTick () |
| | This function is called immediately after tick() is called.
|
| virtual void | timedTick () |
| | This version of tick checks to see if the time to tick has arrived.
|
| virtual void | setMinTickPeriod (double minTickPeriod) |
| | specifies a minimum tick period (which can also be thought of as
|
| virtual double | minTickPeriod () const |
| | access the minimum tick period
|
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| | set the variance in the minimum tick time
|
| virtual double | minTickPeriodVariance () const |
| | access the variance in the minimum tick period
|
| virtual void | setNextTickTime (double nextTickTime) |
| | The next tick time is normally calculated internally.
|
| virtual double | nextTickTime () const |
| | access the next tick time
|
| virtual double | calculateNextTickTime () const |
| | The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
|
| virtual double | calculateFirstTickTime () const |
| | Returns the first time value that the component should tick at.
|
| virtual void | setEntity (DtVrfObject *entity) |
| | The entity's state repository is the place that actuator components make updates and other components look to see our current state.
|
| virtual DtSimComponent * | nextComponent () |
| | List management functions.
|
| virtual DtSimComponent * | prevComponent () |
| virtual void | setListItem (DtListItem *item) |
| | Used by DtComponentList.
|
| virtual DtListItem * | listItem () |
| virtual void | putData (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 DtInputPort * | lookupInputPort (const DtString &portName) |
| | Returns a pointer to the input port registered on this component with the specified name.
|
| virtual DtList | inputPortList () const |
| | Returns the list of DtInputPorts registered on this component.
|
| virtual void | addOutputPort (DtOutputPort *port) |
| | Adds this output port to the components output port list so that other components can look it up and attach to it.
|
| virtual void | removeOutputPort (DtOutputPort *port) |
| virtual DtOutputPort * | lookupOutputPort (const DtString &portName) |
| | Returns a pointer to the output port registered on this component with the specified name.
|
| virtual DtList | outputPortList () const |
| | Returns the list of DtOutputPorts registered on this component.
|
| virtual void | addInputPortGroup (DtInputPortGroup *group) |
| | Adds this input port to the components input port list so that other components can look it up and attach to it.
|
| virtual void | removeInputPortGroup (DtInputPortGroup *group) |
| virtual DtInputPortGroup * | lookupInputPortGroup (const DtString &groupName) |
| | Returns a pointer the input port group registered on this component with the specified name.
|
| virtual DtList | inputPortGroupList () const |
| | Returns the list of DtInputPortGroups registered on this component.
|
| virtual void | addOutputPortGroup (DtOutputPortGroup *group) |
| | Adds this output port group to the components output port group list so that other components can look it up and attach to it.
|
| virtual void | removeOutputPortGroup (DtOutputPortGroup *group) |
| virtual DtOutputPortGroup * | lookupOutputPortGroup (const DtString &groupName) |
| | Returns a pointer the output port group registered on this component with the specified name.
|
| virtual DtList | outputPortGroupList () const |
| | Returns the list of DtOutputPortGroups registered on this component.
|
| virtual int | priority () const |
| | Return the current connection priority for this component.
|
| virtual void | setPriority (int priority) |
| | Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
|
| double | dT () const |
| | This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
|
| virtual void | setDT (double deltaT) |
| | Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
|
virtual const
DtComponentDescriptor * | componentDescriptor () const |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| virtual DtString | componentFullName () const |
| virtual DtPhysicalWorld * | physicalWorld () |
| | Gets the physical world that this component's entity exists in.
|
| virtual const DtPhysicalWorld * | physicalWorld () const |
| virtual DtAttachedTerrain * | terrainAttachedTo () |
| | Gets the terrain that this component's entity is attached to, if any.
|
| virtual const DtAttachedTerrain * | terrainAttachedTo () const |
| virtual DtVrfObject * | entity () |
| | Gets the entity.
|
| virtual const DtVrfObject * | entity () const |
| virtual DtSimManager * | simManager () |
| | Gets the sim manager.
|
| virtual const DtSimManager * | simManager () const |
| virtual const Coordinate_System * | coordinateSystem () const |
| | Gets the coordinate system, as it should always exist if the physical world is in a valid state!
|
| virtual Coordinate_System * | coordinateSystem () |
virtual
DtVrfObjectStateRepository * | localStateRepository () |
| | Gets the local state repository.
|
virtual const
DtVrfObjectStateRepository * | localStateRepository () const |
| virtual DtTaskVisualizationMap & | taskVisualizations () |
| | Returns the list of task visualizations for this component.
|
| virtual bool | taskVisualizationsActive () const |
| | Returns true if task visualizations are currently active for this component.
|
| virtual bool | taskVisualizationsEnabled () const |
| | Returns true if task visualizations are enabled for this component.
|
| virtual void | enable () |
| | Is this component enabled or not.
|
| virtual void | disable () |
| 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 |
| | DtReaderWriter () |
| | default constructor
|
| | DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) |
| | real constructor Setting the readonly flag prevents object from writing itself to the stream.
|
| | DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) |
| | DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) |
| | pseudo-copy constructor
|
| | DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) |
| | DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) |
| | copy constructor
|
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| | assignment operator
|
| bool | operator== (const DtReaderWriter &) const |
| | Equivalence operator.
|
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| | destructor
|
| virtual void | putSelf (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 aliasContainer & | aliases () 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 original state Default is no-op.
|
| virtual int | alignment () const |
| | For those items that are sent over the network via HLA, this will give the network alignment.
|
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| | Sets the myVariableIsBound flag to false.
|
| virtual void | setName (const DtString &) |
| | Set the name of the object.
|
| virtual const char * | readerWriterType () const |
| | Used to supply a string type that this reader writer type is.
|
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| | Routine to return a human readable form of the reader/writer variable.
|
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| | Runs a variable binding pass on this reader writer and any of its children.
|
virtual std::list
< DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| | Returns true if this variable has a child p in it's chain.
|
| virtual bool | hasVariableReference () const |
| | Returns true if this item or any item in the registry (recursive) is a variable reference.
|
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| | Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
|
| virtual void | recordUpdateTime () const |
| | Can be implemented in subclasses to stamp the time when updated.
|
| virtual bool | wasUpdatedSince (DtTime t) const |
| | Can be implemented in subclasses to return true if an update occurred after the specified time.
|
| virtual bool | changedSinceLastChecked () |
| | Returns true if this objects value has changed since the last time this function was called.
|
| virtual bool | peekChangedSinceLastChecked () const |
| | Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
|
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| | The specified flags are used for optional values.
|
| virtual bool | valueSpecified () const |
| 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) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| | The default value to use if the reader/writer object is a variable and that variable is not specified.
|
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| | Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
|
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| | Give the stream, if the stream contains a default value then set it here.
|
| const DtReaderWriterRegistry & | registry () const |
| | Collection of child DtReaderWriter nodes owned by this object.
|
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual bool | toXml (const DtFilename &) const |
| | Writes contents of xml result to the given filename.
|
| virtual bool | fromXml (const DtString &) |
| | Restores object from given xml string. Returns true if valid.
|
| virtual bool | fromXmlFile (const DtFilename &) |
| | Restores 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.
|
Protected Member Functions |
| virtual bool | createPorts () |
| | Called by init to create the input ports.
|
| virtual bool | checkAlive () |
| | Returns true if the warhead is armed and capable of detonating.
|
| virtual bool | checkTrigger () |
| virtual bool | checkArmed () |
| virtual bool | checkProximityDetonate () |
| | If there is currently a proximity target and distance set in the PSR, this function checks to see if the current position is within the proximity detonate distance of the target.
|
| virtual bool | checkTargetMiss () |
| | Checks if the missile has flown passed the target, missing it.
|
| virtual void | checkMissileDetonation () |
| | Impacting missiles are treated differently given their kinematic characteristics.
|
| virtual DtVrfObject * | detectCollision (double &distToImpactSqrd, DtVector &detonLocationOut) |
| | Looks for possible entities for impact, and calls checkEntityForCollision when it finds a candidate.
|
| virtual bool | preventCollisionsWithMatchingTypes () |
| | In order to prevent munitions such as missiles and torpedoes from colliding with one another as they are spawned from their launchers, detectCollision calls this function to determine if matching entity types should be checked for collisions.
|
| virtual bool | checkEntityForCollision (DtVrfObject *collidee, const DtVector &missilePath, const DtVector &missileBoxCenter, DtVector &detonLocationOut, double &distToImpactSqrd) |
| | Checks to see if we've impacted with an entity.
|
| virtual bool | checkForGroundImpact (double &distToImpactSqrd, DtVector &impactPoint, DtDetonationResult &result) |
| | All parameters are "out" params.
|
| virtual void | sendDetonation (DtVrfObject *impactedEntity, const DtVector &detonLocation) |
| | Creates, fills out, and sends a DtDetonation interaction as a result of an entity collision.
|
| virtual void | sendDetonation (DtDetonationResult result, const DtVector &collisionPt) |
| | Creates, fills out, and sends a DtDetonation interaction for terrain impacts using the given DtDetonationResult.
|
| virtual void | destroyAndRemoveEntity () |
| | Called after it detonates.
|
| | DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| | (const DtString& name,
|
| virtual void | setRadio (DtSimRadio *radio) |
| | DtActuatorComponent () |
| | Default constructor; should not be called.
|
| virtual double | computeCurrentTime () |
| | Compute current time and myDT.
|
| bool | testInvariant () const |
| virtual bool | createPortGroups () |
| | Called by init.
|
| DtVrfProcessStateRepository * | createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true) |
| | Creates a PSR for this component and registers it with the PSR manager.
|
| virtual void | updateTaskVisualizations () |
| | Called to update task visualizations after every tick.
|
| virtual void | destroyTaskVisualizations () |
| | Destroys all task visualizations for this component.
|
| virtual void | destroyTaskVisualization (const DtString &name) |
| | Destroys an existing task visualization.
|
| virtual DtPointTaskVisualizationPtr | pointTaskVisualization (const DtString &name) |
| | Finds an existing or creates a new point task visualization with the given name.
|
| virtual DtLineTaskVisualizationPtr | lineTaskVisualization (const DtString &name) |
| | Finds an existing or creates a new line task visualization with the given name.
|
| virtual DtAreaTaskVisualizationPtr | areaTaskVisualization (const DtString &name) |
| | Finds an existing or creates a new area task visualization with the given name.
|
| virtual DtTextTaskVisualizationPtr | textTaskVisualization (const DtString &name) |
| | Finds an existing or creates a new text task visualization with the given name.
|
| double | calculateNextTaskVisTickTime () const |
| | Determines the next time the task visualizations should be ticked.
|
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| | Copies values from the specified DtReaderWriter.
|
| | DtObjectDebugger () |
| | DtObjectDebugger (const DtObjectDebugger &) |
| | ~DtObjectDebugger () |
| | DtObjectDebugger () |
| | DtObjectDebugger (const DtObjectDebugger &) |
| | ~DtObjectDebugger () |
DtWarheadDetonationActuator is an actuator that simulates the detonation for any type of warhead that may detonate upon impact with another entity, the ground, or the water.
End User Description: It monitors for collisions between the entity on which it is mounted and any of the applicable surfaces (ground, water, other entities). When a collision is detected, it will create a detonation. This actuator can be associated with any vrfObject that can detonate. For example, this actuator is used for representing IED–improvised explosive devices.
Parameters can be supplied to the warhead through the setWarheadInfo set data request, including Attacker ID, Event ID, Warhead and Fuze type. If an attacker ID is specified, collisions with the attacker entity will not be reported as entity collision.
Warhead will check for a firepower kill of its parent entity when it collides with something. If it has been firePowerKilled, no detonation is created.
Uses Descriptor Type: DtWarheadDetonationActuatorDescriptor