DtBallisticGun Class Reference

DtBallisticGun provides a simple model of a ballistic gun.

End User Description: The ballistic gun actuator uses the ammunition data and trigger values it receives. When the trigger port has the value of true, it creates a fire interaction using the ammunition indicated and the current state of the entity at the entity’s current target. It also checks the hit probability table to decide if this should be a hit. It creates the proper detonation interaction for the determined result and schedules the interaction to be sent at the appropriate time.

Uses Descriptor Type: DtBallisticGunDescriptor

Inheritance diagram for DtBallisticGun:

Public Member Functions
	DtBallisticGun (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtBallisticGun ()
virtual bool	init ()
virtual void	initPendingDetonations ()
virtual const char *	type () const
virtual void	preFirstTickInit ()
virtual void	tick ()
virtual void	fire (int roundsToFire, bool computePHit)
virtual bool	checkHitProbability (const DtEntityType &type, DtReal range, int burstSize=1)
virtual double	hitProbabilityModifier (const DtEntityType &type, DtReal range, int burstSize=1)
virtual double	targetMotionHitModifier (const DtEntityType &type, DtReal range)
virtual double	selfMotionHitModifier (const DtEntityType &type, DtReal range)
virtual double	skillLevelModifier (const double range)
virtual double	lifeformPostureModifier ()
virtual double	burstSizeModifier (int burstSize)
virtual makVrfEvents::DtFireEvent *	createFireInteraction (const int rounds)
virtual makVrfEvents::DtDetonationEvent *	createDetonationInteraction (int burstSize, DtTime &detTime, bool &isHit, bool assureMiss=false)
virtual void	getMissLocation (DtVector gunPosition, const DtSimObject *intendedTarget, double muzzleSpeed, DtVector &missLocation, DtVector &velocityVector, DtDetonationResult &detonationResult, DtSimObjectReference *target)
virtual void	scheduleDetonation (makVrfEvents::DtDetonationEvent *detInter, DtTime detTime)
virtual DtString	probabilityString () const
virtual DtVector	calculateMuzzlePosition () const
virtual DtVector	calculateGunOffset () const
virtual makVrfEvents::DtDetonationEvent *	createDetonationInteraction (const DtDetonationDescriptor &desc, DtTime &detTime)
virtual DtDetonationDescriptor *	createDetonationDescriptor (makVrfEvents::DtDetonationEvent *detInter, DtTime simTime)
virtual double	maxGunRange () const
virtual DtReaderWriter *	getMuzzlePositionAttribute ()
Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent ()
virtual DtSimRadio *	radio ()
virtual bool	tickWhileDestroyed () const
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual bool	postAddComponentsInit ()
virtual void	registerAttributeFunctions ()
virtual void	postTick ()
virtual void	timedTick ()
virtual void	setMinTickPeriod (double minTickPeriod)
virtual double	minTickPeriod () const
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
virtual double	minTickPeriodVariance () const
virtual void	setNextTickTime (double nextTickTime)
virtual double	nextTickTime () const
virtual double	calculateNextTickTime () const
virtual double	calculateFirstTickTime () const
virtual void	setEntity (DtLocalObject *entity)
virtual DtSimComponent *	nextComponent ()
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	addInputPort (DtInputPort *port)
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
virtual DtList	inputPortList () const
virtual void	addOutputPort (DtOutputPort *port)
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
virtual DtList	outputPortList () const
virtual void	addInputPortGroup (DtInputPortGroup *group)
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
virtual DtList	inputPortGroupList () const
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
virtual DtList	outputPortGroupList () const
virtual int	priority () const
virtual void	setPriority (int priority)
double	dT () const
virtual void	setDT (double deltaT)
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
const DtAttachedTerrain *	terrainAttachedTo () const
DtLocalObject *	entity ()
const DtLocalObject *	entity () const
DtSimulationServices *	simulationServices ()
const DtSimulationServices *	simulationServices () const
const Coordinate_System *	coordinateSystem () const
virtual bool	taskVisualizationsActive () const
virtual bool	taskVisualizationsEnabled () const
virtual void	onRestore ()
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
virtual void	enable ()
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 int	notifyLevel () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
VRF4API_METHOD const DtSimulationServices *	simManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static void	detonationCallback (DtTimer *timer)
static DtReaderWriter *	getMuzzlePositionAttribute (void *ctrlr)
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual bool	createPortGroups ()
virtual bool	createPorts ()
virtual bool	createPSR ()
virtual void	processSimObjectAdded (DtSimObjectReference vrfObject)
virtual void	addRangeItems ()
virtual bool	aimGun ()
virtual DtEntityType	munitionType (DtSimMunition &munitionEntry)
	DtBallisticGun ()
	DtBallisticGun (const DtBallisticGun &orig)
const DtBallisticGun &	operator= (const DtBallisticGun &orig)
Protected Member Functions inherited from DtActuatorComponent
	DtActuatorComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual void	setRadio (DtSimRadio *radio)
	DtActuatorComponent ()
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
bool	testInvariant () const
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
virtual void	updateTaskVisualizations ()
virtual void	destroyTaskVisualizations ()
virtual void	destroyTaskVisualization (const DtString &name)
virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
double	calculateNextTaskVisTickTime () const
DtVrfObjectStateRepository *	localStateRepository ()
const DtVrfObjectStateRepository *	localStateRepository () const
void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	invokeSimObjectPredicateCallbacks ()
virtual void	clearPredicateCallbacks ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtBallisticGunDescriptor *	myBalGunDescriptor
DtReal	myMaxGunRange
DtReal	myMuzzleSpeed
DtVector	myMuzzleOffset
DtSimObjectReference	myCurrentTarget
DtReal	myCurrentRange
DtList	myTimerList
DtArtPartType	myGunArtPart
DtString	myCurrentEventId
DtVrfBalGunPSR *	myProcessState
boost::signals2::scoped_connection	mySimObjectAddedConnection
DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade
DtMovementSimObjectFacade	myCurrentTargetSimObjectFacade
Ports and Port Groups
DtInputPortGroup *	myBalGunControlPortGroup
DtBooleanInputPort *	myTriggerPort
DtIntegerInputPort *	myQuantityInputPort
DtBooleanInputPort *	myLoadedPort
DtIntegerInputPort *	myLosPort
DtAnalogInputPort *	myAimElevationInputPort
Protected Attributes inherited from DtActuatorComponent
DtSimRadio *	myRadio
Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity
DtComponentSystem *	mySystem
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
bool	myTickEveryFrame
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager	myPredicateCallbackManager
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
bool	myInvalid
bool	myChangedFlag
virtual void	processSetTracerUse (DtSimMessage *msg)
static void	setTracerUseCallback (DtSimMessage *msg, void *component)

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
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtBallisticGun::DtBallisticGun	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Parameters

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

virtual DtBallisticGun::~DtBallisticGun ( )

virtual

destructor

DtBallisticGun::DtBallisticGun ( )

protected

default constructor; not implemented

DtBallisticGun::DtBallisticGun ( const DtBallisticGun &  orig )

protected

copy constructor; not implemented

Member Function Documentation

virtual bool DtBallisticGun::init ( )

virtual

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

Reimplemented from DtActuatorComponent.

virtual void DtBallisticGun::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* DtBallisticGun::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

DtBallisticGunActuatorType

Implements DtSimComponent.

Reimplemented in DtBallisticGunJoy, and DtHumanGunActuator.

virtual void DtBallisticGun::preFirstTickInit ( )

virtual

Calls initPendingDetonations.

Reimplemented from DtSimComponent.

virtual void DtBallisticGun::tick ( )

virtual

Update the gun elevation. If elevation is correct and the trigger port says fire, then fire. Also, if there are remaining fire interactions to generate in a burst, generate the next one.

Reimplemented from DtSimComponent.

Reimplemented in DtBallisticGunJoy, and DtHumanGunActuator.

virtual void DtBallisticGun::fire ( int  roundsToFire, bool  computePHit  )

virtual

Create the fire interaction for the fire event and schedule a detonation. roundsToFire is the number of rounds in this fire interaction– long bursts may use multiple interactions. If computePHit is false, then the normal P(Hit) computation will be skipped; this is appropriate for fire/detonate events after the first one in a burst, which are all assumed to miss.

virtual bool DtBallisticGun::checkHitProbability ( const DtEntityType &  type, DtReal  range, int  burstSize = 1  )

virtual

Returns true if we hit the target, false otherwise. Looks up a DtPrbValueList based on entity type and range passed as arguments in the Hit Probability Table specified by the component descriptor describing this component. It uses the probability in the DtPrbValueList indexed by the string returned by the probabilityString() function. This probability is then multiplied by the value from hitProbabilityModifier(). It then generates a random number between 0.0 and 1.0 using DtFRand(). If the value generated is less than or equal to the hit probability, true is returned. If the value generated is greater than the hit probability, false is returned.

virtual double DtBallisticGun::hitProbabilityModifier ( const DtEntityType &  type, DtReal  range, int  burstSize = 1  )

virtual

Computes and returns a hit probability modifier based on motion and other effects.

virtual double DtBallisticGun::targetMotionHitModifier ( const DtEntityType &  type, DtReal  range  )

virtual

Computes and returns a modifier (0-1) to account for target motion. Target motion perpendicular to the line of fire is computed and compared to 1.5mps; the modifier is 0.5 at 1.5mps.

virtual double DtBallisticGun::selfMotionHitModifier ( const DtEntityType &  type, DtReal  range  )

virtual

Computes and returns a modifier (0-1) to account for self motion. Self speed is compared to 1.0 mps; the modifier is 0.5 at 1.0 mps.

virtual double DtBallisticGun::skillLevelModifier ( const double  range )

virtual

Calculates a modifier on the probability of hit based on range and the training level of the entity.

virtual double DtBallisticGun::lifeformPostureModifier ( )

virtual

Calculates a modifier to hit probability based on entity (lifeform) posture. Prone = 0.25, kneeling = 0.6, crouched = 0.9. Note – uses myCurrentTarget to get target state.

virtual double DtBallisticGun::burstSizeModifier ( int  burstSize )

virtual

Calculates a modifier to hit probability based on burst size. Currently, modifier = log10(burstSize) + 1. This value > 1 for burstSize > 1, but see comment in hitProbabilityModifier above.

virtual makVrfEvents::DtFireEvent* DtBallisticGun::createFireInteraction ( const int  rounds )

virtual

Allocates a makVrfEvents::DtFireEvent and then uses the munition information specified on the munition and fuze ports, as well as the current target reported by the entity, to fill in the necessary fields. It also calculates a muzzle velocity vector to store in the interaction, using myMuzzleSpeed and a unit vector pointing from the firing entity to the target. The range to the target is stored in the member variable myCurrentRange for use by createDetonationInteraction().

virtual makVrfEvents::DtDetonationEvent* DtBallisticGun::createDetonationInteraction ( int  burstSize, DtTime &  detTime, bool &  isHit, bool  assureMiss = false  )

virtual

Allocates a makVrfEvents::DtDetonationEvent. It calls checkHitProbability() to determine if the detonation will be a hit or a miss. If it is a hit, the interaction’s result field is set to DtDetResEntityImpact. An (approximate) impact point on the target entity is determined by shooting a ray from the center of the shooting entity to the center of the target entity. The point of intersection between this ray and the target entity's bounding volume is then determined, and this is used as the detonation location. A round velocity vector is also calculated by using myMuzzleSpeed and a normalized version of the shooting vector. If the detonation is determined to be a miss, DtDetResGroundImpact is used for the detonation result, and a ground location is randomly selected from within a 2 ½ meter ring outside the radius of the target’s bounding volume as the detonation point. The round velocity vector is calculated by finding the unit vector from the center of the shooting entity to the impact point and scaling by myMuzzleSpeed. An approximate time to detonation is determined using the approximate distance to the target, stored by createFireInteraction() in myCurrentRange, divided by myMuzzleSpeed. This speed and the makVrfEvents::DtDetonationEvent created are returned. If assureMiss is True, the hitProbability is skipped, and a miss is guaranteed.

virtual void DtBallisticGun::getMissLocation ( DtVector  gunPosition, const DtSimObject *  intendedTarget, double  muzzleSpeed, DtVector &  missLocation, DtVector &  velocityVector, DtDetonationResult &  detonationResult, DtSimObjectReference *  target  )

virtual

Computes the location of a miss. The input position is in local coordinates, and the output vectors are also in local coordinates. The intended target is the entity the gun was aiming at, while the target is the entity that was hit instead, if any. If the miss hits an entity, the detonation result will be an entity impact, and the target will indicate what was hit. Otherwise, the target is null.

virtual void DtBallisticGun::scheduleDetonation ( makVrfEvents::DtDetonationEvent *  detInter, DtTime  detTime  )

virtual

Schedules the sending of the makVrfEvents::DtDetonationEvent passed as the first argument at a point in the future specified by the second argument, using the DtScheduler facility (which is accessed through the DtSimulationServices). A DtDetonationTimerData object is allocated, which holds a pointer to the makVrfEvents::DtDetonationEvent and a pointer to the DtSimulationServices. A DtTimer is then created that is set for the desired time and that is given the DtBallisticGun::detonationCallback() as the callback function for when the timer fires, and DtDetonationTimerData object as the user data that will be accessible to the callback. The timer is placed on the scheduler with a call to DtScheduler::addTimer(), which will assume responsibility for firing the DtTimer at the specified time. The DtTimer is also placed on a local timer list myTimerList, so that it can be deleted at a later time.

virtual DtString DtBallisticGun::probabilityString ( ) const

virtual

virtual DtVector DtBallisticGun::calculateMuzzlePosition ( ) const

virtual

Finds the correct muzzle placement for the gun.

virtual DtVector DtBallisticGun::calculateGunOffset ( ) const

virtual

virtual makVrfEvents::DtDetonationEvent* DtBallisticGun::createDetonationInteraction ( const DtDetonationDescriptor &  desc, DtTime &  detTime  )

virtual

Creates a new makVrfEvents::DtDetonationEvent, 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 makVrfEvents::DtDetonationEvent and DtTime can be directly passed into scheduleDetonation.

virtual DtDetonationDescriptor* DtBallisticGun::createDetonationDescriptor ( makVrfEvents::DtDetonationEvent *  detInter, DtTime  simTime  )

virtual

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

virtual double DtBallisticGun::maxGunRange ( ) const

virtual

Look up the maximum range of the gun from the P(Hit) table given in the descriptor.

static void DtBallisticGun::detonationCallback ( DtTimer *  timer )

static

Casts the user data portion of the DtTimer passed to it to a DtDetonationTimerData object. It then uses the pointer to the Simulation Manager provided in the DtDetonationTimerData to get a pointer to the DtExerciseConn, and sends the makVrfEvents::DtDetonationEvent which is also in the DtDetonationTimerData object via the exercise connection. The timer is removed from the scheduler, and the DtDetonationTimerData and makVrfEvents::DtDetonationEvent objects are deleted.

static void DtBallisticGun::setTracerUseCallback ( DtSimMessage *  msg, void *  component  )

static

Callback function and processing function for handling setTracerUse commands. These set a flag in the gun PSR to indicate that tracers are/are not currently being used.

virtual void DtBallisticGun::processSetTracerUse ( DtSimMessage *  msg )

virtual

Callback function and processing function for handling setTracerUse commands. These set a flag in the gun PSR to indicate that tracers are/are not currently being used.

static DtReaderWriter* DtBallisticGun::getMuzzlePositionAttribute ( void *  ctrlr )

static

virtual DtReaderWriter* DtBallisticGun::getMuzzlePositionAttribute ( )

virtual

static DtSimComponent* DtBallisticGun::creator ( const DtString &  name, DtLocalObject *  owner, DtSimulationServices *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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).

Returns

New instance of this class.

virtual bool DtBallisticGun::createPortGroups ( )

protectedvirtual

Overridden to create local port groups.

Reimplemented from DtSimComponent.

virtual bool DtBallisticGun::createPorts ( )

protectedvirtual

Overridden to create local ports.

Reimplemented from DtSimComponent.

Reimplemented in DtHumanGunActuator, and DtBallisticGunJoy.

virtual bool DtBallisticGun::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.

virtual void DtBallisticGun::processSimObjectAdded ( DtSimObjectReference  vrfObject )

protectedvirtual

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 void DtBallisticGun::addRangeItems ( )

protectedvirtual

Adds all items that have a range to the object state repository.

virtual bool DtBallisticGun::aimGun ( )

protectedvirtual

Aims the gun based on input ports. Uses the myAimElevationInputPort to determine the correct elevation. Returns true if aiming is complete.

Reimplemented in DtHumanGunActuator.

virtual DtEntityType DtBallisticGun::munitionType ( DtSimMunition &  munitionEntry )

protectedvirtual

Gets either the normal munition type or an alternate type to fill in the fire and detonation interactions. Checks the PSR to see if tracers are being fired, and if so, returns the tracer-type from simMunition. If that type isn't specified, the normal munition type is returned.

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

protected

assignment operator; not implemented

Member Data Documentation

DtBallisticGunDescriptor* DtBallisticGun::myBalGunDescriptor

protected

DtReal DtBallisticGun::myMaxGunRange

protected

This max gun range is determined by the P(hit) tables. It is computed once at init time and saved for later use in range ring registration and detonation creation.

DtReal DtBallisticGun::myMuzzleSpeed

protected

DtVector DtBallisticGun::myMuzzleOffset

protected

DtSimObjectReference DtBallisticGun::myCurrentTarget

protected

These are set by createFireInteraction and used by createDetonationInteraction.

DtReal DtBallisticGun::myCurrentRange

protected

DtList DtBallisticGun::myTimerList

protected

DtArtPartType DtBallisticGun::myGunArtPart

protected

DtString DtBallisticGun::myCurrentEventId

protected

DtVrfBalGunPSR* DtBallisticGun::myProcessState

protected

Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).

DtInputPortGroup* DtBallisticGun::myBalGunControlPortGroup

protected

Input Port Group Name: gun-control
Input Port Group Description:

DtBooleanInputPort* DtBallisticGun::myTriggerPort

protected

Input Port Name: trigger
Input Port Description: Edge-triggered input which fires a round whenever a new True arrives on the port.
Input Port Range:
Input Port Default Value:
Input Group Parent: gun-control.

DtIntegerInputPort* DtBallisticGun::myQuantityInputPort

protected

Input Port Name: quantity
Input Port Description: Indicates the number of rounds to be fired with a single trigger pull. Changes the quantity field in the fire/detonate interactions/PDUs generated by this gun. If not connected, a value of 1 is used.
Input Port Range: 1+
Input Port Default Value: 1
Input Group Parent: gun-control.

DtBooleanInputPort* DtBallisticGun::myLoadedPort

protected

Input Port Name: loaded
Input Port Description: Must be True for gun to fire.
Input Port Range:
Input Port Default Value:
Input Group Parent: gun-control.

DtIntegerInputPort* DtBallisticGun::myLosPort

protected

Input Port Name: line-of-sight
Input Port Description: Indicates the result of a line of sight calculation to the current target. This gun is only capable of hitting things with a Clear line of sight. If Unknown, the gun will calculate the los. Input Port Range: 0 = Unkown, 1 = Blocked, 2 = Clear
Input Port Default Value:
Input Group Parent: gun-control.

DtAnalogInputPort* DtBallisticGun::myAimElevationInputPort

protected

Input Port Name: aim-elevation
Input Port Description: Elevation at which to aim, in radians.
Input Port Range: -pi to pi
Input Port Default Value: 0
.

boost::signals2::scoped_connection DtBallisticGun::mySimObjectAddedConnection

protected

DtPlatformLocalObjectFacade DtBallisticGun::myPlatformLocalObjectFacade

protected

Member to allow for access to platform specific data.

DtMovementSimObjectFacade DtBallisticGun::myCurrentTargetSimObjectFacade

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmodel/ballisticGun.h