DtAggregateIndirectFireControllerDescriptor Class Reference

DtAggregateIndirectFireControllerDescriptor is a DtComponentDescriptor that has additional information needed for providing parameters to an AggregateIndirectFire controller.

Inheritance diagram for DtAggregateIndirectFireControllerDescriptor:

Public Member Functions
	DtAggregateIndirectFireControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtAggregateIndirectFireControllerDescriptor (const DtAggregateIndirectFireControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtAggregateIndirectFireControllerDescriptor &	operator= (const DtAggregateIndirectFireControllerDescriptor &orig)
virtual	~DtAggregateIndirectFireControllerDescriptor () override
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	weaponName () const
virtual void	setWeaponName (const DtString &)
virtual double	range () const
virtual void	setRange (double)
virtual double	radius () const
virtual void	setRadius (double)
virtual double	maxSheafRadius () const
virtual void	setMaxSheafRadius (double)
virtual double	hitFactor () const
virtual void	setHitFactor (double)
virtual int	strengthPerAttack () const
virtual void	setStrengthPerAttack (int)
virtual double	secondsPerAttack () const
virtual void	setSecondsPerAttack (double)
virtual int	ammunitionPerAttack () const
virtual void	setAmmunitionPerAttack (int)
virtual DtString	damageType () const
virtual void	setDamageType (const DtString &)
virtual std::set< DtString >	availablePostures () const
virtual void	setAvailablePostures (const std::set< DtString > &)
virtual DtString	availablePosturesString () const
virtual void	setAvailablePosturesString (const DtString &)
virtual DtString	guidanceSystem () const
virtual void	setGuidanceSystem (const DtString &)
Public Member Functions inherited from DtScriptEnableControllerDescriptor
	DtScriptEnableControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtScriptEnableControllerDescriptor (const DtScriptEnableControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtScriptEnableControllerDescriptor &	operator= (const DtScriptEnableControllerDescriptor &orig)
virtual	~DtScriptEnableControllerDescriptor () override
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor () override
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual bool	init ()
virtual const DtString &	stateAndParameterDataPrefix () const
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	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () 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	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () 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 ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
virtual const DtRwProperties &	internalStateData () const
virtual DtRwProperties &	internalStateData ()
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) const
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	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 DtScriptEnableControllerDescriptor
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
	DtAggregateIndirectFireControllerDescriptor ()
Protected Member Functions inherited from DtScriptEnableControllerDescriptor
	DtScriptEnableControllerDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
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.
DtRwString	myWeaponName
DtRwReal	myRange
DtRwReal	myRadius
DtRwReal	myMaxSheafRadius
DtRwReal	myHitFactor
DtRwInt	myStrengthPerAttack
DtRwReal	mySecondsPerAttack
DtRwInt	myAmmunitionPerAttack
DtRwString	myDamageType
DtRwString	myAvailablePostures
DtRwString	myGuidanceSystem
std::set< DtString >	myAvailablePosturesSet
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwProperties	myInternalStateData
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 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

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

constructor

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

copy constructor

virtual DtAggregateIndirectFireControllerDescriptor::~DtAggregateIndirectFireControllerDescriptor ( )

overridevirtual

destructor

DtAggregateIndirectFireControllerDescriptor::DtAggregateIndirectFireControllerDescriptor ( )

protected

default constructor

Member Function Documentation

DtAggregateIndirectFireControllerDescriptor& DtAggregateIndirectFireControllerDescriptor::operator=

(

const DtAggregateIndirectFireControllerDescriptor &

orig

)

assignment

virtual DtString DtAggregateIndirectFireControllerDescriptor::type ( ) const

overridevirtual

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.

Reimplemented from DtScriptEnableControllerDescriptor.

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

overridevirtual

Reimplemented from DtScriptEnableControllerDescriptor.

virtual DtString DtAggregateIndirectFireControllerDescriptor::weaponName ( ) const

virtual

Accessor/mutator for myWeaponName.

virtual void DtAggregateIndirectFireControllerDescriptor::setWeaponName ( const DtString &  )

virtual

Accessor/mutator for myWeaponName.

virtual double DtAggregateIndirectFireControllerDescriptor::range ( ) const

virtual

Accessor/mutator for myRange.

virtual void DtAggregateIndirectFireControllerDescriptor::setRange ( double  )

virtual

Accessor/mutator for myRange.

virtual double DtAggregateIndirectFireControllerDescriptor::radius ( ) const

virtual

Accessor/mutator for myRadius.

virtual void DtAggregateIndirectFireControllerDescriptor::setRadius ( double  )

virtual

Accessor/mutator for myRadius.

virtual double DtAggregateIndirectFireControllerDescriptor::maxSheafRadius ( ) const

virtual

Accessor/mutator for myMaxSheafRadius.

virtual void DtAggregateIndirectFireControllerDescriptor::setMaxSheafRadius ( double  )

virtual

Accessor/mutator for myMaxSheafRadius.

virtual double DtAggregateIndirectFireControllerDescriptor::hitFactor ( ) const

virtual

Accessor/mutator for myHitFactor.

virtual void DtAggregateIndirectFireControllerDescriptor::setHitFactor ( double  )

virtual

Accessor/mutator for myHitFactor.

virtual int DtAggregateIndirectFireControllerDescriptor::strengthPerAttack ( ) const

virtual

Accessor/mutator for myStrengthPerAttack.

virtual void DtAggregateIndirectFireControllerDescriptor::setStrengthPerAttack ( int  )

virtual

Accessor/mutator for myStrengthPerAttack.

virtual double DtAggregateIndirectFireControllerDescriptor::secondsPerAttack ( ) const

virtual

Accessor/mutator for mySecondsPerAttack.

virtual void DtAggregateIndirectFireControllerDescriptor::setSecondsPerAttack ( double  )

virtual

Accessor/mutator for mySecondsPerAttack.

virtual int DtAggregateIndirectFireControllerDescriptor::ammunitionPerAttack ( ) const

virtual

Accessor/mutator for myAmmunitionPerAttack.

virtual void DtAggregateIndirectFireControllerDescriptor::setAmmunitionPerAttack ( int  )

virtual

Accessor/mutator for myAmmunitionPerAttack.

virtual DtString DtAggregateIndirectFireControllerDescriptor::damageType ( ) const

virtual

Accessor/mutator for myDamageType.

virtual void DtAggregateIndirectFireControllerDescriptor::setDamageType ( const DtString &  )

virtual

Accessor/mutator for myDamageType.

virtual std::set<DtString> DtAggregateIndirectFireControllerDescriptor::availablePostures ( ) const

virtual

Accessor/mutator for myAvailablePosturesSet.

virtual void DtAggregateIndirectFireControllerDescriptor::setAvailablePostures ( const std::set< DtString > &  )

virtual

Accessor/mutator for myAvailablePosturesSet.

virtual DtString DtAggregateIndirectFireControllerDescriptor::availablePosturesString ( ) const

virtual

Accessor/mutator for myAvailablePostures.

virtual void DtAggregateIndirectFireControllerDescriptor::setAvailablePosturesString ( const DtString &  )

virtual

Accessor/mutator for myAvailablePostures.

virtual DtString DtAggregateIndirectFireControllerDescriptor::guidanceSystem ( ) const

virtual

Accessor/mutator for myGuidanceSystem.

virtual void DtAggregateIndirectFireControllerDescriptor::setGuidanceSystem ( const DtString &  )

virtual

Accessor/mutator for myGuidanceSystem.

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

DtRwString DtAggregateIndirectFireControllerDescriptor::myWeaponName

protected

Parameter Name: weapon-name
Parameter Description: The name of the weapon. Parameter Default Value: "Indirect Fire"
.

DtRwReal DtAggregateIndirectFireControllerDescriptor::myRange

protected

Parameter Name: range
Parameter Description: The range (in meters) this weapon can fire. Parameter Default Value: 5000
.

DtRwReal DtAggregateIndirectFireControllerDescriptor::myRadius

protected

Parameter Name: radius
Parameter Description: The radius (in meters) of the blast caused by the shell. Parameter Default Value: 0
.

DtRwReal DtAggregateIndirectFireControllerDescriptor::myMaxSheafRadius

protected

Parameter Name: max-sheaf-radius
Parameter Description: The maximum radius (in meters) of the pattern of bursts created by firing bombs-per-attack rounds with this weapon. Aggregate units with multiple copies of this weapon will have a max sheaf size that is the sum of the individual max sheaf sizes.
Parameter Default Value: 0
.

DtRwReal DtAggregateIndirectFireControllerDescriptor::myHitFactor

protected

Parameter Name: hit-factor
Parameter Description: The effectiveness of the guidance capabilities of this weapon's munitions. Parameter Default Value: -1 (no hit factor)
.

DtRwInt DtAggregateIndirectFireControllerDescriptor::myStrengthPerAttack

protected

Parameter Name: strength-per-attack
Parameter Description: The amount of damage this weapon can deal per attack. Parameter Default Value: 100
.

DtRwReal DtAggregateIndirectFireControllerDescriptor::mySecondsPerAttack

protected

Parameter Name: seconds-per-attack
Parameter Description: The duration of a single attack in seconds. Parameter Default Value: 10
.

DtRwInt DtAggregateIndirectFireControllerDescriptor::myAmmunitionPerAttack

protected

Parameter Name: ammunition-per-attack
Parameter Description: The number of rounds of ammunition used in a single attack. Parameter Default Value: 10
.

DtRwString DtAggregateIndirectFireControllerDescriptor::myDamageType

protected

Parameter Name: damage-category
Parameter Description: The type of damage the weapon deals. Parameter Default Value: "High-Explosive"
.

DtRwString DtAggregateIndirectFireControllerDescriptor::myAvailablePostures

protected

Parameter Name: available-postures
Parameter Description: The list of postures in which this task is available. Parameter Default Value: "High-Explosive"
.

DtRwString DtAggregateIndirectFireControllerDescriptor::myGuidanceSystem

protected

Parameter Name: guidance-system
Parameter Description: The type of guidance system used by this munition. Parameter Default Value: "" (i.e. none)
.

std::set<DtString> DtAggregateIndirectFireControllerDescriptor::myAvailablePosturesSet

mutableprotected

The set is updated when myAvailablePostures is first accessed.

---

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

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