DtIndirectFireActuatorDescriptor Class Reference

DtIndirectFireActuatorDescriptor; descriptor for the DtIndirectFireActuator component.

DtIndirectFireActuatorDescriptor is a DtComponentDescriptor that has additional information needed for providing parameters to any weapon model - muzzle offset and muzzle velocity.

Inheritance diagram for DtIndirectFireActuatorDescriptor:

Public Member Functions
	DtIndirectFireActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtIndirectFireActuatorDescriptor (const DtIndirectFireActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtIndirectFireActuatorDescriptor &	operator= (const DtIndirectFireActuatorDescriptor &orig)
virtual	~DtIndirectFireActuatorDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual void	setUseErrorVariesByRange (bool varyError)
virtual bool	useErrorVariesByRange () const
virtual void	setErrorCoefficients (const DtVector &coeffs)
virtual const DtVector &	errorCoefficients () const
virtual void	setProbableErrorInRange (DtReal probableErrorInRange)
virtual DtReal	probableErrorInRange () const
virtual void	setProbableErrorInDisplacement (DtReal probableErrorInDisplacement)
virtual DtReal	probableErrorInDisplacement () const
virtual void	setProbableErrorInBurstHeight (DtReal probableErrorInBurstHeight)
virtual DtReal	probableErrorInBurstHeight () const
virtual double	maxSkillLevelEffect () const
virtual void	setMaxSkillLevelEffect (const double teffect)
virtual void	setSimulateMunition (bool simulateMunition)
virtual bool	simulateMunition () const
virtual bool	sendFireInteraction () const
virtual void	setSendFireInteraction (bool send)
Public Member Functions inherited from DtWeaponActuatorDescriptor
	DtWeaponActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtWeaponActuatorDescriptor (const DtWeaponActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtWeaponActuatorDescriptor &	operator= (const DtWeaponActuatorDescriptor &orig)
virtual	~DtWeaponActuatorDescriptor ()
virtual int	roundsPerMagazine () const
virtual void	setRoundsPerMagazine (const int rounds)
virtual DtReal	projectileStartSpeed () const
virtual void	setProjectileStartSpeed (DtReal startSpeed)
virtual const DtVector &	muzzleOffset () const
virtual void	setMuzzleOffset (const DtVector &muzzleOffset)
virtual bool	isMuzzleOffsetSpecified () const
Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
virtual	~DtActuatorComponentDescriptor ()
virtual void	postGetSelf ()
virtual void	setDefaultArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
virtual const DtSimArtPartDescriptorList &	defaultArtPartDescriptorList () const
virtual DtSimArtPartDescriptorList &	defaultArtPartDescriptorList ()
virtual void	setArtPartTypes (const ArtPartTypeSet &partTypes)
virtual const ArtPartTypeSet &	artPartTypes () const
virtual DtArtPartType	firstArtPartType () const
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
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)
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)
virtual bool	tickPeriodUsesRealTime () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
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)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
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	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 DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtWeaponActuatorDescriptor
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtActuatorComponentDescriptor
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
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
	DtIndirectFireActuatorDescriptor ()
Protected Member Functions inherited from DtWeaponActuatorDescriptor
	DtWeaponActuatorDescriptor ()
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myProbableErrorInRange
DtRwReal	myProbableErrorInDisplacement
DtRwReal	myProbableErrorInBurstHeight
DtRwBoolean	mySimulateMunition
DtRwBoolean	mySendFireInteraction
DtRwBoolean	myUseErrorVariesByRange
DtRwVector	myErrorCoefficients
DtRwReal	myMaxSkillLevelEffect
Protected Attributes inherited from DtWeaponActuatorDescriptor
DtRwReal	myProjectileStartSpeed
DtRwOffsetVector	myMuzzleOffset
DtRwInt	myRoundsPerMagazine
Protected Attributes inherited from DtActuatorComponentDescriptor
ArtPartTypeSet	myArtPartTypes
DtSimArtPartDescriptorList	myDefaultArtPartDescriptorList
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myTickPeriodUsesRealTime
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
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

Additional Inherited Members
Public Types inherited from DtActuatorComponentDescriptor
typedef std::set< DtArtPartType >	ArtPartTypeSet
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
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

DtIndirectFireActuatorDescriptor::DtIndirectFireActuatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtIndirectFireActuatorDescriptor::DtIndirectFireActuatorDescriptor	(	const DtIndirectFireActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtIndirectFireActuatorDescriptor::~DtIndirectFireActuatorDescriptor ( )

virtual

destructor

DtIndirectFireActuatorDescriptor::DtIndirectFireActuatorDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtIndirectFireActuatorDescriptor& DtIndirectFireActuatorDescriptor::operator=

(

const DtIndirectFireActuatorDescriptor &

orig

)

assignment

virtual DtString DtIndirectFireActuatorDescriptor::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

DtIndirectFireActuatorDescriptorType

Reimplemented from DtWeaponActuatorDescriptor.

virtual DtComponentDescriptor* DtIndirectFireActuatorDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtWeaponActuatorDescriptor.

virtual void DtIndirectFireActuatorDescriptor::setUseErrorVariesByRange ( bool  varyError )

virtual

Accessor/mutator for myUseErrorVariesByRange.

virtual bool DtIndirectFireActuatorDescriptor::useErrorVariesByRange ( ) const

virtual

Accessor/mutator for myUseErrorVariesByRange.

virtual void DtIndirectFireActuatorDescriptor::setErrorCoefficients ( const DtVector &  coeffs )

virtual

Accessor/mutator for myErrorCoefficients.

virtual const DtVector& DtIndirectFireActuatorDescriptor::errorCoefficients ( ) const

virtual

Accessor/mutator for myErrorCoefficients.

virtual void DtIndirectFireActuatorDescriptor::setProbableErrorInRange ( DtReal  probableErrorInRange )

virtual

Accessor/mutator for myProbableErrorInRange.

virtual DtReal DtIndirectFireActuatorDescriptor::probableErrorInRange ( ) const

virtual

Accessor/mutator for myProbableErrorInRange.

virtual void DtIndirectFireActuatorDescriptor::setProbableErrorInDisplacement ( DtReal  probableErrorInDisplacement )

virtual

Accessor/mutator for myProbableErrorInDisplacement.

virtual DtReal DtIndirectFireActuatorDescriptor::probableErrorInDisplacement ( ) const

virtual

Accessor/mutator for myProbableErrorInDisplacement.

virtual void DtIndirectFireActuatorDescriptor::setProbableErrorInBurstHeight ( DtReal  probableErrorInBurstHeight )

virtual

Accessor/mutator for myProbableErrorInBurstHeight.

virtual DtReal DtIndirectFireActuatorDescriptor::probableErrorInBurstHeight ( ) const

virtual

Accessor/mutator for myProbableErrorInBurstHeight.

virtual double DtIndirectFireActuatorDescriptor::maxSkillLevelEffect ( ) const

virtual

Accessor/mutator for myMaxSkillLevelEffect.

virtual void DtIndirectFireActuatorDescriptor::setMaxSkillLevelEffect ( const double  teffect )

virtual

Accessor/mutator for myMaxSkillLevelEffect.

virtual void DtIndirectFireActuatorDescriptor::setSimulateMunition ( bool  simulateMunition )

virtual

Accessor/mutator for mySimulateMunition.

virtual bool DtIndirectFireActuatorDescriptor::simulateMunition ( ) const

virtual

Accessor/mutator for mySimulateMunition.

virtual bool DtIndirectFireActuatorDescriptor::sendFireInteraction ( ) const

virtual

Accessor/mutator for mySendFireInteraction.

virtual void DtIndirectFireActuatorDescriptor::setSendFireInteraction ( bool  send )

virtual

Accessor/mutator for mySendFireInteraction.

static DtComponentDescriptor* DtIndirectFireActuatorDescriptor::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.

Member Data Documentation

DtRwReal DtIndirectFireActuatorDescriptor::myProbableErrorInRange

protected

Parameter Name: probable-error-in-range
Parameter Description: The probable error in range (overshoot or undershoot). This is the range from the target point that 25% of rounds will fall short by, and 25% will be long by. From FM 6-40, chapter 3. This value * 1.35 is the pseudo-standard deviation used for determining the gaussian distribution of round dispersion in range. The maximum error is four times this value.
Parameter Default Value: 0.
Parameter Units: meters.

DtRwReal DtIndirectFireActuatorDescriptor::myProbableErrorInDisplacement

protected

Parameter Name: probable-error-in-displacement
Parameter Description: The probable error in displacement (lateral error). This is the displacement from the target point that 25% of rounds will fall to the left by, and 25% will be fall to the right by. From FM 6-40, chapter 3. This value * 1.35 is the pseudo-standard deviation used for determining the gaussian distribution of round dispersion in displacement. The maximum error is four times this value.
Parameter Default Value: 0.
Parameter Units: meters.

DtRwReal DtIndirectFireActuatorDescriptor::myProbableErrorInBurstHeight

protected

Parameter Name: probable-error-in-burst-height
Parameter Description: The probable error in burst height. This is the displacement from the target point that 25% of rounds will detonate above by, and 25% will be detonate below by (used only for proximity or timed fuzes). From FM 6-40, chapter 3. This value * 1.35 is the pseudo-standard deviation used for determining the gaussian distribution of round dispersion in height. The maximum error is four times this value. This parameter is not applicable to munitions that use a contact fuze.
Parameter Default Value: 0.
Parameter Units: meters.

DtRwBoolean DtIndirectFireActuatorDescriptor::mySimulateMunition

protected

Parameter Name: simulate-munition
Determine whether simulate the munitions as entities or simply as discrete fire & detonation interactions.
Parameter Default Value: true.

DtRwBoolean DtIndirectFireActuatorDescriptor::mySendFireInteraction

protected

Parameter Name: send-fire-interaction
In some instances the user might not want to send a fireinteraction as that be used as a way to detect fire. For example, a hand grenade being tossed wouldn't produce any muzzle flash or other way of opponent knowing it had been sent till it arrived. Parameter Default Value: true.

DtRwBoolean DtIndirectFireActuatorDescriptor::myUseErrorVariesByRange

protected

Parameter Name: use-error-varies-by-range
If set to true, the actuator will use the maximum range and maximum error to calculate a weighting factor to scale the probable error based on the range to target. Parameter Default Value: false.

DtRwVector DtIndirectFireActuatorDescriptor::myErrorCoefficients

protected

Parameter Name: error-coefficients
If the use error varies by range is set to true, these are the coefficients that will be plugged into a quadratic equations based on range to target Parameter Default Value:

DtRwReal DtIndirectFireActuatorDescriptor::myMaxSkillLevelEffect

protected

Parameter Name: max-skill-level-effect
Parameter Description: This parameter describes the maximum effect on the hit probability based on the skill level of the entity. No skill will have the maximum effect on the hit probablity
Parameter Default Value: 0.25 a 25% reduction on the hit probability.

---

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

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