DtBallisticGunDescriptor Class Reference

DtBallisticGunDescriptor; a descriptor for the DtBallisticGun component. More...

Inheritance diagram for DtBallisticGunDescriptor:

Public Member Functions
	DtBallisticGunDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtBallisticGunDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBallisticGunDescriptor (const DtBallisticGunDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtBallisticGunDescriptor &	operator= (const DtBallisticGunDescriptor &orig)
	assignment
virtual	~DtBallisticGunDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Determines whether or not to save the hit table or hit file out.
virtual DtReal	muzzleSpeed () const
	Accessor/mutator for myMuzzleSpeed.
virtual void	setMuzzleSpeed (DtReal muzzleSpeed)
virtual int	roundsPerMagazine () const
	Accessor/mutator for myRoundsPerMagazine.
virtual void	setRoundsPerMagazine (int roundsPerMagazine)
virtual int	roundsPerMinute () const
	Accessor/mutator for myRoundsPerMinute.
virtual void	setRoundsPerMinute (const int roundsPerMinute)
virtual DtReal	extraTimeBetweenBursts () const
	Accessor/mutator for myExtraTimeBetweenBursts.
virtual void	setExtraTimeBetweenBursts (const DtReal extraTimeBetweenBursts)
virtual bool	startWithTracers () const
	Accessor/mutator for myStartWithTracers.
virtual void	setStartWithTracers (const bool)
virtual const DtString &	rangeName () const
	Accessor/mutator for myRangeName.
virtual void	setRangeName (const DtString &rangeName)
virtual DtReal	elevationRate () const
	Accessor/mutator for myElevationRate.
virtual void	setElevationRate (DtReal pElevationRate)
virtual DtReal	maxElevationRange () const
	Accessor/mutator for myMaxElevationRange.
virtual void	setMaxElevationRange (DtReal pElevationRange)
virtual DtReal	minElevationRange () const
	Accessor/mutator for myMinElevationRange.
virtual void	setMinElevationRange (DtReal pElevationRange)
virtual DtReal	neutralElevation () const
	Accessor/mutator for myNeutralElevation.
virtual void	setNeutralElevation (DtReal elevation)
virtual const DtVector &	muzzleOffset () const
	Accessor/mutator for myMuzzleOffset.
virtual void	setMuzzleOffset (const DtVector &muzzleOffset)
virtual bool	velocityCheck () const
	Accessor/mutator for myVelocityCheck.
virtual void	setVelocityCheck (bool check)
virtual const DtString &	hitProbabilityFilename ()
	Accessor/mutator for myHitProbabilityFile.
virtual void	setHitProbabilityFilename (const DtString &filename)
virtual const DtRangeProbabilityTable &	hitProbabilityTable () const
	Accessor/mutator for myHitProbabilityTable.
virtual void	setHitProbabilityTable (const DtRangeProbabilityTable &table)
virtual bool	detonateOnMiss () const
	Accessor/mutator for myDetonateOnMiss.
virtual void	setDetonateOnMiss (bool detonateOnMiss)
virtual int	roundsPerDetonation () const
	Accessor/mutator for myRoundsPerDetonation.
virtual void	setRoundsPerDetonation (const int rpd)
virtual double	burstCep () const
	Accessor/mutator for myBurstCep.
virtual void	setBurstCep (const double radius)
Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
	assignment
virtual	~DtActuatorComponentDescriptor ()
	destructor
virtual void	setArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
	Accessor/mutator for myArtPartDescriptorList.
virtual const DtSimArtPartDescriptorList &	artPartDescriptorList () const
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type.
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 actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object.
virtual bool	createOnRemoteObject () 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 (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	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 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 DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
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.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtBallisticGunDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myElevationRate
	Parameter Name: max-elevation-rate Parameter Description: The elevation rate for the gun.
DtRwReal	myMaxElevationRange
	Parameter Name: max-elevation-range Parameter Description: The maximum elevation angle for the gun.
DtRwReal	myMinElevationRange
	Parameter Name: min-elevation-range Parameter Description: The minimum elevation angle for the gun.
DtRwReal	myNeutralElevation
	Parameter Name: neutral-elevation Parameter Description: The elevation that the gun starts at, and returns to when there are no targets.
DtRwReal	myMuzzleSpeed
	Parameter Name: muzzle-speed Parameter Description: This is used to find the muzzle velocity vector for the fire pdu and determine flyout time.
DtRwInt	myRoundsPerMagazine
	Parameter Name: rounds-per-magazine Parameter Description: This parameter allows modeling magazines that permit multiple shots/bursts before becoming unloaded.
DtRwInt	myRoundsPerMinute
	Parameter Name: rounds-per-minute Parameter Description: This parameter determines the gun cyclic rate when firing a burst.
DtRwReal	myExtraTimeBetweenBursts
	Parameter Name: extra-time-between-bursts Parameter Description: This parameter defines the extra time required between bursts before the gun is ready to fire again.
DtRwBoolean	myStartWithTracers
	Parameter Name: start-with-tracers Parameter Description: This parameter determines whether the gun will use tracers when the gun is first created.
DtRwOffsetVector	myMuzzleOffset
	Parameter Name: muzzle-offset Parameter Description: This vector is an offset used to set the position of a fire PDU/interaction when the gun is fired.
DtRwBoolean	myVelocityCheck
	Parameter Name: velocity-affects-hit-chance Parameter Description: This parameter determines whether or not the relative velocity between the shooter and the target will affect the chance of hitting the target.
DtReaderWriterFile	myHitProbabilityFile
	Parameter Name: hit-probability-file Parameter Description: The file name of the hit probability table used to determine if a target was hit.
DtRangeProbabilityTable	myHitProbabilityTable
	Parameter Name: hit-probability-table Parameter Description: Table containing entries for probability of a hit versus target entity type and range.
DtRwString	myRangeName
	Name given to any range item associated with this descriptor.
DtRwBoolean	myDetonateOnMiss
	Parameter Name: detonate-on-miss Parameter Description: This parameter determines whether or not a detonation interaction should be created when a shot misses.
DtRwInt	myRoundsPerDetonation
	Parameter Name: rounds-per-detonation Parameter Description: This parameter determines how many rounds can be in one detonation interaction/PDU.
DtRwReal	myBurstCep
	Parameter Name: burst-cep Parameter Description: This parameter (CEP) defines the radius of the circle at a range of 1 meter that will contain 50% of the rounds of the burst.
Protected Attributes inherited from DtActuatorComponentDescriptor
DtSimArtPartDescriptorList	myArtPartDescriptorList
	Parameter Name: art-part-list Parameter Description: List of articulated parts associated with this actuator.
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component.
DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not.
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations.
DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled.
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local.
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.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

DtBallisticGunDescriptor; a descriptor for the DtBallisticGun component.

A DtComponentDescriptor that has additional information needed for providing parameters to the ballistic gun model – hit probabilities, muzzle offset, and muzzle velocity.

The muzzleSpeed() and setMuzzleSpeed() member functions are used for the muzzle velocity specified in VR-Link fire interactions.

Constructor & Destructor Documentation

DtBallisticGunDescriptor::DtBallisticGunDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtBallisticGunDescriptor::DtBallisticGunDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtBallisticGunDescriptor::DtBallisticGunDescriptor	(	const DtBallisticGunDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtBallisticGunDescriptor::~DtBallisticGunDescriptor ( )

virtual

destructor

DtBallisticGunDescriptor::DtBallisticGunDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtBallisticGunDescriptor& DtBallisticGunDescriptor::operator=

(

const DtBallisticGunDescriptor &

orig

)

assignment

virtual DtString DtBallisticGunDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns

DtBallisticGunDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtHumanGunActuatorDescriptor.

virtual DtComponentDescriptor* DtBallisticGunDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = NULL ) const

virtual

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtHumanGunActuatorDescriptor.

virtual DtReal DtBallisticGunDescriptor::muzzleSpeed ( ) const

virtual

Accessor/mutator for myMuzzleSpeed.

virtual void DtBallisticGunDescriptor::setMuzzleSpeed ( DtReal  muzzleSpeed )

virtual

virtual int DtBallisticGunDescriptor::roundsPerMagazine ( ) const

virtual

Accessor/mutator for myRoundsPerMagazine.

virtual void DtBallisticGunDescriptor::setRoundsPerMagazine ( int  roundsPerMagazine )

virtual

virtual int DtBallisticGunDescriptor::roundsPerMinute ( ) const

virtual

Accessor/mutator for myRoundsPerMinute.

virtual void DtBallisticGunDescriptor::setRoundsPerMinute ( const int  roundsPerMinute )

virtual

virtual DtReal DtBallisticGunDescriptor::extraTimeBetweenBursts ( ) const

virtual

Accessor/mutator for myExtraTimeBetweenBursts.

virtual void DtBallisticGunDescriptor::setExtraTimeBetweenBursts ( const DtReal  extraTimeBetweenBursts )

virtual

virtual bool DtBallisticGunDescriptor::startWithTracers ( ) const

virtual

Accessor/mutator for myStartWithTracers.

virtual void DtBallisticGunDescriptor::setStartWithTracers ( const bool  )

virtual

virtual const DtString& DtBallisticGunDescriptor::rangeName ( ) const

virtual

Accessor/mutator for myRangeName.

virtual void DtBallisticGunDescriptor::setRangeName ( const DtString &  rangeName )

virtual

virtual DtReal DtBallisticGunDescriptor::elevationRate ( ) const

virtual

Accessor/mutator for myElevationRate.

virtual void DtBallisticGunDescriptor::setElevationRate ( DtReal  pElevationRate )

virtual

virtual DtReal DtBallisticGunDescriptor::maxElevationRange ( ) const

virtual

Accessor/mutator for myMaxElevationRange.

virtual void DtBallisticGunDescriptor::setMaxElevationRange ( DtReal  pElevationRange )

virtual

virtual DtReal DtBallisticGunDescriptor::minElevationRange ( ) const

virtual

Accessor/mutator for myMinElevationRange.

virtual void DtBallisticGunDescriptor::setMinElevationRange ( DtReal  pElevationRange )

virtual

virtual DtReal DtBallisticGunDescriptor::neutralElevation ( ) const

virtual

Accessor/mutator for myNeutralElevation.

virtual void DtBallisticGunDescriptor::setNeutralElevation ( DtReal  elevation )

virtual

virtual const DtVector& DtBallisticGunDescriptor::muzzleOffset ( ) const

virtual

Accessor/mutator for myMuzzleOffset.

virtual void DtBallisticGunDescriptor::setMuzzleOffset ( const DtVector &  muzzleOffset )

virtual

virtual bool DtBallisticGunDescriptor::velocityCheck ( ) const

virtual

Accessor/mutator for myVelocityCheck.

virtual void DtBallisticGunDescriptor::setVelocityCheck ( bool  check )

virtual

virtual const DtString& DtBallisticGunDescriptor::hitProbabilityFilename ( )

virtual

Accessor/mutator for myHitProbabilityFile.

virtual void DtBallisticGunDescriptor::setHitProbabilityFilename ( const DtString &  filename )

virtual

virtual const DtRangeProbabilityTable& DtBallisticGunDescriptor::hitProbabilityTable ( ) const

virtual

Accessor/mutator for myHitProbabilityTable.

virtual void DtBallisticGunDescriptor::setHitProbabilityTable ( const DtRangeProbabilityTable &  table )

virtual

virtual bool DtBallisticGunDescriptor::detonateOnMiss ( ) const

virtual

Accessor/mutator for myDetonateOnMiss.

virtual void DtBallisticGunDescriptor::setDetonateOnMiss ( bool  detonateOnMiss )

virtual

virtual int DtBallisticGunDescriptor::roundsPerDetonation ( ) const

virtual

Accessor/mutator for myRoundsPerDetonation.

virtual void DtBallisticGunDescriptor::setRoundsPerDetonation ( const int  rpd )

virtual

virtual double DtBallisticGunDescriptor::burstCep ( ) const

virtual

Accessor/mutator for myBurstCep.

The radius of a circle within which 50% of the rounds of a burst will pass, at 1m range.

virtual void DtBallisticGunDescriptor::setBurstCep ( const double  radius )

virtual

static DtComponentDescriptor* DtBallisticGunDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtActuatorComponentDescriptor.

Reimplemented in DtHumanGunActuatorDescriptor.

virtual void DtBallisticGunDescriptor::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Determines whether or not to save the hit table or hit file out.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwReal DtBallisticGunDescriptor::myElevationRate

protected

Parameter Name: max-elevation-rate
Parameter Description: The elevation rate for the gun.

Parameter Default Value: 0.0
Parameter Units: radians/second

DtRwReal DtBallisticGunDescriptor::myMaxElevationRange

protected

Parameter Name: max-elevation-range
Parameter Description: The maximum elevation angle for the gun.

Assumed to be between 0.0 and +pi/2.
Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtBallisticGunDescriptor::myMinElevationRange

protected

Parameter Name: min-elevation-range
Parameter Description: The minimum elevation angle for the gun.

Assumed to be between 0.0 and -pi/2.
Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtBallisticGunDescriptor::myNeutralElevation

protected

Parameter Name: neutral-elevation
Parameter Description: The elevation that the gun starts at, and returns to when there are no targets.

Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtBallisticGunDescriptor::myMuzzleSpeed

protected

Parameter Name: muzzle-speed
Parameter Description: This is used to find the muzzle velocity vector for the fire pdu and determine flyout time.

In body coordinates of the gun (may be an articulated part, or the entity itself).
Parameter Default Value: 0.0
Parameter Units: meters/second

DtRwInt DtBallisticGunDescriptor::myRoundsPerMagazine

protected

Parameter Name: rounds-per-magazine
Parameter Description: This parameter allows modeling magazines that permit multiple shots/bursts before becoming unloaded.

The gun system only pays the reloading time cost when the magazine is empty.
Parameter default value: 1
Parameter unit: Rounds per magazine

DtRwInt DtBallisticGunDescriptor::myRoundsPerMinute

protected

Parameter Name: rounds-per-minute
Parameter Description: This parameter determines the gun cyclic rate when firing a burst.

It is used to determine the length (time) of a burst.
Parameter default value: 500
Parameter unit: Rounds per minute.

DtRwReal DtBallisticGunDescriptor::myExtraTimeBetweenBursts

protected

Parameter Name: extra-time-between-bursts
Parameter Description: This parameter defines the extra time required between bursts before the gun is ready to fire again.

This can be used, for example, to define a cooling off period to prevent the gun from overheating. Most semi-auto and single-shot weapons should leave this 0.
Parameter default value: 0
Parameter unit: seconds

DtRwBoolean DtBallisticGunDescriptor::myStartWithTracers

protected

Parameter Name: start-with-tracers
Parameter Description: This parameter determines whether the gun will use tracers when the gun is first created.

That is, when a munition is selected in the ammunition selection table, the tracer-type, if specified in that table, will be entered in the fire and detonation interactions instead of the munition-type. After the gun is created, the use of tracers can be turned on and off with the set-tracer-use command.
Parameter Default Value: false
Parameter Unit:

DtRwOffsetVector DtBallisticGunDescriptor::myMuzzleOffset

protected

Parameter Name: muzzle-offset
Parameter Description: This vector is an offset used to set the position of a fire PDU/interaction when the gun is fired.

If an articulated part has been specified to represent the gun, then this offset is in the body coordinate system of the gun articulated part. If no articulated part is specified to represent the gun, then this offset is in the body coordinate system of the entity. In a body coordinate system, the axes are specified as follows:

• x-axis points out of the 'front' of the object
  
• y-axis points out of the 'side' of the object
  
• z-axis points out of the 'bottom' of the object Parameter Default Value: 0.0
  Parameter Units: meters

DtRwBoolean DtBallisticGunDescriptor::myVelocityCheck

protected

Parameter Name: velocity-affects-hit-chance
Parameter Description: This parameter determines whether or not the relative velocity between the shooter and the target will affect the chance of hitting the target.

Parameter Default Value: false

DtReaderWriterFile DtBallisticGunDescriptor::myHitProbabilityFile

protected

Parameter Name: hit-probability-file
Parameter Description: The file name of the hit probability table used to determine if a target was hit.

Parameter Default Value: ""

DtRangeProbabilityTable DtBallisticGunDescriptor::myHitProbabilityTable

protected

Parameter Name: hit-probability-table
Parameter Description: Table containing entries for probability of a hit versus target entity type and range.

Parameter Default Value:

DtRwString DtBallisticGunDescriptor::myRangeName

protected

Name given to any range item associated with this descriptor.

Parameter Default Value:

DtRwBoolean DtBallisticGunDescriptor::myDetonateOnMiss

protected

Parameter Name: detonate-on-miss
Parameter Description: This parameter determines whether or not a detonation interaction should be created when a shot misses.

Parameter Default Value: true

DtRwInt DtBallisticGunDescriptor::myRoundsPerDetonation

protected

Parameter Name: rounds-per-detonation
Parameter Description: This parameter determines how many rounds can be in one detonation interaction/PDU.

If the burst size is greater than this, then more than one detonation is created.
Parameter Default Value: 100

DtRwReal DtBallisticGunDescriptor::myBurstCep

protected

Parameter Name: burst-cep
Parameter Description: This parameter (CEP) defines the radius of the circle at a range of 1 meter that will contain 50% of the rounds of the burst.

Burst detonations beyond the first detonation will be randomly placed according to this error parameter.
Parameter Default Value: 0.01

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/ballisticGunDescriptor.h