DtIndirectFireActuatorDescriptor Class Reference

DtIndirectFireActuatorDescriptor; descriptor for the DtIndirectFireActuator component. More...

Inheritance diagram for DtIndirectFireActuatorDescriptor:

Public Member Functions
	DtIndirectFireActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtIndirectFireActuatorDescriptor (const DtIndirectFireActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtIndirectFireActuatorDescriptor &	operator= (const DtIndirectFireActuatorDescriptor &orig)
	assignment
virtual	~DtIndirectFireActuatorDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual void	setProbableErrorInRange (DtReal probableErrorInRange)
	Accessor/mutator for myProbableErrorInRange.
virtual DtReal	probableErrorInRange () const
	Accessor/mutator for myProbableErrorInRange.
virtual void	setProbableErrorInDisplacement (DtReal probableErrorInDisplacement)
	Accessor/mutator for myProbableErrorInDisplacement.
virtual DtReal	probableErrorInDisplacement () const
	Accessor/mutator for myProbableErrorInDisplacement.
virtual void	setProbableErrorInBurstHeight (DtReal probableErrorInBurstHeight)
	Accessor/mutator for myProbableErrorInBurstHeight.
virtual DtReal	probableErrorInBurstHeight () const
	Accessor/mutator for myProbableErrorInBurstHeight.
virtual void	setSimulateMunition (bool simulateMunition)
	Accessor/mutator for mySimulateMunition.
virtual bool	simulateMunition () const
	Accessor/mutator for mySimulateMunition.
virtual bool	highAngle () const
	Accessor/mutator for myHighAngle.
virtual void	setHighAngle (bool useAngle)
	Accessor/mutator for myHighAngle.
Public Member Functions inherited from DtWeaponActuatorDescriptor
	DtWeaponActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtWeaponActuatorDescriptor (const DtWeaponActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtWeaponActuatorDescriptor &	operator= (const DtWeaponActuatorDescriptor &orig)
	assignment
virtual	~DtWeaponActuatorDescriptor ()
	destructor
virtual DtReal	projectileStartSpeed () const
	Accessor/mutator for myProjectileStartSpeed.
virtual void	setProjectileStartSpeed (DtReal startSpeed)
	Accessor/mutator for myProjectileStartSpeed.
virtual const DtVector &	muzzleOffset () const
	Accessor/mutator for myMuzzleOffset.
virtual void	setMuzzleOffset (const DtVector &muzzleOffset)
	Accessor/mutator for myMuzzleOffset.
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
	Accessor/mutator for myArtPartDescriptorList.
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 (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, 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
	Type of DtSimComponent this descriptor is associated with.
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
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created or not.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtIndirectFireActuatorDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtWeaponActuatorDescriptor
	DtWeaponActuatorDescriptor ()
	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.
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 DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myProbableErrorInRange
	Parameter Name: probable-error-in-range Parameter Description: The probable error in range (overshoot or undershoot).
DtRwReal	myProbableErrorInDisplacement
	Parameter Name: probable-error-in-displacement Parameter Description: The probable error in displacement (lateral error).
DtRwReal	myProbableErrorInBurstHeight
	Parameter Name: probable-error-in-burst-height Parameter Description: The probable error in burst height.
DtRwBoolean	mySimulateMunition
	Parameter Name: simulate-munition Determine whether simulate the munitions as entities or simply as discrete fire & detonation interactions.
DtRwBoolean	myHighAngle
	Parameter Name: high-angle Determine whether to lob the shot at higher than 45 degrees (mortars) or lower than 45 degrees (artillery) Parameter Default Value: false.
Protected Attributes inherited from DtWeaponActuatorDescriptor
DtRwReal	myProjectileStartSpeed
	Parameter Name: projectile-start-speed Parameter Description: Used in calculating the projectile velocity vector for the fire PDU and in determining flyout time.
DtRwVector	myMuzzleOffset
	Parameter Name: muzzle-offset Parameter Description: This vector is an offset used to set the position of a fire PDU/interaction when the weapon is fired.
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
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
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 assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

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.

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::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 void DtIndirectFireActuatorDescriptor::setSimulateMunition ( bool  simulateMunition )

virtual

Accessor/mutator for mySimulateMunition.

virtual bool DtIndirectFireActuatorDescriptor::simulateMunition ( ) const

virtual

Accessor/mutator for mySimulateMunition.

virtual bool DtIndirectFireActuatorDescriptor::highAngle ( ) const

virtual

Accessor/mutator for myHighAngle.

virtual void DtIndirectFireActuatorDescriptor::setHighAngle ( bool  useAngle )

virtual

Accessor/mutator for myHighAngle.

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.

Reimplemented from DtWeaponActuatorDescriptor.

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::myHighAngle

protected

Parameter Name: high-angle
Determine whether to lob the shot at higher than 45 degrees (mortars) or lower than 45 degrees (artillery) Parameter Default Value: false.

---

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

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