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. More...

Inheritance diagram for DtWarheadDetonationActuator:

[legend]

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 DtString	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.
Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent ()
	destructor
virtual DtSimRadio *	radio ()
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 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	preprocess ()
	Perform parallel preprocessing prior to tick and similar computations.
virtual void	parallelTick ()
	called in parallel
virtual void	preFirstTickInit ()
	called from preprocess if appropriate
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual 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 void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static void	setWarheadInfoCallback (DtSimMessage msg, void usr)
	Static callback function which calls use->processWarheadInfoCallback().
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,

Protected Member Functions
virtual bool	createPorts ()
	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 void	checkMissileDetonation ()
	Impacting missiles are treated differently given their kinematic charateristics.
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.
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 DtActuatorComponent &	operator= (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, common between preprocess and timedTick.
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
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
DtBooleanInputPort *	myTriggerInputPort
	Input Port Name: trigger Input Port Description: Checks to see if the trigger was set.
DtBooleanInputPort *	myArmedInputPort
	Input Port Name: armed Input Port Description: Check to see if warhead is armed.
DtVrfObjectStateRepository *	myStateRep
Dt3dBoundingVolume *	myCollisionBV
DtVector	myLastPosition
bool	myStartPositionInited
DtWarheadDetonationActuatorPSR *	myProcessState
	Container for state data associated with this component.
DtWarheadDetonationActuatorDescriptor *	myWarheadDescriptor
DtEventId	myEventId
DtVrfObject *	myTargetObject
	This is here for performance – the real target is specified by the name in the PSR.
DtReflectedDesignator *	myLaserDesignator
	Cached pointer to the designator specified in the PSR, prevents a lookup each tick when a detonation proximity is specified.
bool	myNeedToDisplayTargetNotFoundWarning
	Flag to indicate we need to display a warning message for target not found condition.
bool	myAmMissile
	Flag to let us know this is a missile or a bomb and hence collision impacts will be treated differently from non missile warheads.
Protected Attributes inherited from DtActuatorComponent
DtSimRadio *	myRadio
	Actuators can send messages.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptor *	myComponentDescriptor
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtWarheadDetonationActuator ()
	Default constructor; should not be called.
	DtWarheadDetonationActuator (const DtWarheadDetonationActuator &orig)
	copy constructor; shallow copy - timers not copied
const DtWarheadDetonationActuator &	operator= (const DtWarheadDetonationActuator &orig)
	assignment operator; see comments on copy constructor!
virtual void	processLaserDesignatorRemoved (DtReflectedDesignator *designator)
	Process laser designation removal.
static void	laserDesignatorRemovedCallback (DtReflectedDesignator designator, void usr)
	Process laser designation removal.
virtual void	processObjectAboutToBeRemoved (DtVrfObject *object)
	Process object removal.
static void	objectAboutToBeRemovedCallback (DtVrfObject object, void usr)
	Process object removal.

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

Detailed Description

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

Constructor & Destructor Documentation

DtWarheadDetonationActuator::DtWarheadDetonationActuator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtWarheadDetonationActuator::~DtWarheadDetonationActuator ( )

virtual

destructor

DtWarheadDetonationActuator::DtWarheadDetonationActuator ( )

private

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtWarheadDetonationActuator::DtWarheadDetonationActuator ( const DtWarheadDetonationActuator & orig )

private

copy constructor; shallow copy - timers not copied

Member Function Documentation

virtual bool DtWarheadDetonationActuator::init ( )

virtual

Overridden to cache a pointer to the entity's radio in this class.

Reimplemented from DtActuatorComponent.

virtual bool DtWarheadDetonationActuator::registerRadioMessageCallbacks ( )

virtual

Registers for DtSetWarheadInfo messages.

virtual bool DtWarheadDetonationActuator::createPSR ( )

virtual

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.

virtual void DtWarheadDetonationActuator::setComponentDescriptor ( DtComponentDescriptor * componentDescriptor )

virtual

Overridden to get the DtWarheadDetonationActuatorDescriptor.

Reimplemented from DtSimComponent.

virtual DtString DtWarheadDetonationActuator::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.

Returns: DtWarheadDetonationActuatorType

Reimplemented from DtSimComponent.

virtual void DtWarheadDetonationActuator::tick ( )

virtual

Checks for any collisions, and creates detonation if they are detected.

Reimplemented from DtSimComponent.

virtual bool DtWarheadDetonationActuator::createPorts ( )

protectedvirtual

Called by init to create the input ports.

Reimplemented from DtSimComponent.

virtual bool DtWarheadDetonationActuator::checkAlive ( )

protectedvirtual

Returns true if the warhead is armed and capable of detonating.

This returns true if the firepowerKilled appearance bit is false for the parent entity.

virtual bool DtWarheadDetonationActuator::checkTrigger ( )

protectedvirtual

Returns: True if the trigger port has indicated a trigger pull.

virtual bool DtWarheadDetonationActuator::checkArmed ( )

protectedvirtual

Returns: True if the armed.

virtual bool DtWarheadDetonationActuator::checkProximityDetonate ( )

protectedvirtual

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.

If so returns true. Otherwise return false.

virtual void DtWarheadDetonationActuator::checkMissileDetonation ( )

protectedvirtual

Impacting missiles are treated differently given their kinematic charateristics.

virtual DtVrfObject* DtWarheadDetonationActuator::detectCollision	(	double &	distToImpactSqrd,
		DtVector &	detonLocationOut
	)

protectedvirtual

Looks for possible entities for impact, and calls checkEntityForCollision when it finds a candidate.

Iterates through the list of physical entities in the DtVrfObjectManager. For each test entity, it performs a rough exclusion check by computing a �miss radius� and eliminating the entity if it lies outside of a test radius equal to the �miss radius� plus the entity�s bounding volume radius. The miss radius is a distance between the missile�s position in the previous frame (myLastPosition) and its current position. If the test entity is within this test radius, it calls checkEntityForCollision() to determine if an actual collision took place. As soon as a call to checkEntityForCollision() returns true, the pointer to the entity involved in the collision is returned. If no entities meet the criteria for collision, the function returns 0.

virtual bool DtWarheadDetonationActuator::preventCollisionsWithMatchingTypes ( )

protectedvirtual

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.

This function returns true if the host entity type has its kind field set to DtMunition. This function can be overridden to change this behavior if it's not desired.

virtual bool DtWarheadDetonationActuator::checkEntityForCollision	(	DtVrfObject *	collidee,
		const DtVector &	missilePath,
		const DtVector &	missileBoxCenter,
		DtVector &	detonLocationOut,
		double &	distToImpactSqrd
	)

protectedvirtual

Checks to see if we've impacted with an entity.

Tests whether the missile intersects with the bounding volume of a target entity. A chord, defined by the position of the missile in the previous frame (myLastPosition) and the current missile position, is tested to see if it intersects with the bounding volume of the target entity. The test is made by calling Dt3dBoundingVolume::intersectsLineOfChord(), in the target entity�s bounding volume member. If intersectsLineOfChord() returns true, the distance to the impact location is returned in a function call parameter, and the checkEntityForCollision() returns true. If not, it returns false.

virtual bool DtWarheadDetonationActuator::checkForGroundImpact	(	double &	distToImpactSqrd,
		DtVector &	impactPoint,
		DtDetonationResult &	result
	)

protectedvirtual

All parameters are "out" params.

A return of true means there was an impact and the out values are all valid. Tests for the intersection of the missile with the terrain. Specifically, it checks to see if a chord formed by the position the missile in the previous frame (myLastPosition) and the current missile position, intersects with the terrain skin. It calls DtSimTerrain::groundIntersection() to make this test. If that function returns true, it computes the distance to the impact and sets the detonation result type to DtDetResGroundImpact (both items are returned in function call parameters), and returns true. If groundIntersection() returns false, it does some additional checking to see if it flew off or under the terrain database. It checks to see if the missile lies outside of a bounding box encompassing the terrain database. If so, it sets the impact point to the location of the missile, sets the detonation result type to DtDetResAirBurst, and returns true. If the missile has not intersected with the terrain skin and it has not left the database, the function returns false.

virtual void DtWarheadDetonationActuator::sendDetonation	(	DtVrfObject *	impactedEntity,
		const DtVector &	detonLocation
	)

protectedvirtual

Creates, fills out, and sends a DtDetonation interaction as a result of an entity collision.

This method also forces an update of the missile at the location of the impactedEntity. The detonation itself is created at detonLocation.

virtual void DtWarheadDetonationActuator::sendDetonation	(	DtDetonationResult	result,
		const DtVector &	collisionPt
	)

protectedvirtual

Creates, fills out, and sends a DtDetonation interaction for terrain impacts using the given DtDetonationResult.

This method also forces an update of the missile at the collisionPt.

virtual void DtWarheadDetonationActuator::destroyAndRemoveEntity ( )

protectedvirtual

Called after it detonates.

Sets the parent entity to destroyed and queues it for removal from the simulation if the remove-on-destroy parameter is set.

static void DtWarheadDetonationActuator::setWarheadInfoCallback	(	DtSimMessage *	msg,
		void *	usr
	)

static

Static callback function which calls use->processWarheadInfoCallback().

virtual void DtWarheadDetonationActuator::processWarheadInfoCallback ( DtSimMessage * msg )

virtual

Processes an incoming SetWarheadInfo message by setting the fuze, warhead, attacker ID, and event ID.

static void DtWarheadDetonationActuator::laserDesignatorRemovedCallback	(	DtReflectedDesignator *	designator,
		void *	usr
	)

static

Process laser designation removal.

virtual void DtWarheadDetonationActuator::processLaserDesignatorRemoved ( DtReflectedDesignator * designator )

virtual

Process laser designation removal.

static void DtWarheadDetonationActuator::objectAboutToBeRemovedCallback	(	DtVrfObject *	object,
		void *	usr
	)

static

Process object removal.

virtual void DtWarheadDetonationActuator::processObjectAboutToBeRemoved ( DtVrfObject * object )

virtual

Process object removal.

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

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns: New instance of this class.

const DtWarheadDetonationActuator& DtWarheadDetonationActuator::operator= ( const DtWarheadDetonationActuator & orig )

private

assignment operator; see comments on copy constructor!

Member Data Documentation

DtBooleanInputPort* DtWarheadDetonationActuator::myTriggerInputPort

protected

Input Port Name: trigger
Input Port Description: Checks to see if the trigger was set.

Input Port Range:
Input Port Default Value: false

DtBooleanInputPort* DtWarheadDetonationActuator::myArmedInputPort

protected

Input Port Name: armed
Input Port Description: Check to see if warhead is armed.

If port is not connected assume is armed.
Input Port Range:
Input Port Default Value: false

DtVrfObjectStateRepository* DtWarheadDetonationActuator::myStateRep

protected

Dt3dBoundingVolume* DtWarheadDetonationActuator::myCollisionBV

protected

DtVector DtWarheadDetonationActuator::myLastPosition

protected

bool DtWarheadDetonationActuator::myStartPositionInited

protected

DtWarheadDetonationActuatorPSR* DtWarheadDetonationActuator::myProcessState

protected

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

DtWarheadDetonationActuatorDescriptor* DtWarheadDetonationActuator::myWarheadDescriptor

protected

DtEventId DtWarheadDetonationActuator::myEventId

protected

DtVrfObject* DtWarheadDetonationActuator::myTargetObject

protected

This is here for performance – the real target is specified by the name in the PSR.

We don't want to look up that name every tick.

DtReflectedDesignator* DtWarheadDetonationActuator::myLaserDesignator

protected

Cached pointer to the designator specified in the PSR, prevents a lookup each tick when a detonation proximity is specified.

bool DtWarheadDetonationActuator::myNeedToDisplayTargetNotFoundWarning

protected

Flag to indicate we need to display a warning message for target not found condition.

Only needs to be displayed once. Displaying every time its ticked can generate a slew of warnings in the console.

bool DtWarheadDetonationActuator::myAmMissile

protected

Flag to let us know this is a missile or a bomb and hence collision impacts will be treated differently from non missile warheads.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/warheadDetonationActuator.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation