DtSuppressionActuatorDescriptor Class Reference

DtSuppressionActuatorDescriptor; descriptor for the DtDamageAdjudicationActuator component.

DtSuppressionActuatorDescriptor is used to specify the parameters for the DtSuppressionActuator.

Inheritance diagram for DtSuppressionActuatorDescriptor:

Public Member Functions
	DtSuppressionActuatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSuppressionActuatorDescriptor (const DtSuppressionActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtSuppressionActuatorDescriptor &	operator= (const DtSuppressionActuatorDescriptor &orig)
virtual	~DtSuppressionActuatorDescriptor () override
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const override
virtual bool	init () override
virtual const DtDmgMunitionTable *	damageModel () const
bool	munitionInExceptionList (const DtEntityType &munitionType)
virtual double	insultToSuppress () const
virtual void	setInsultToSuppress (const double i)
virtual double	recoveryTime () const
virtual void	setRecoveryTime (const double t)
virtual bool	hostileFireOnly () const
virtual void	setHostileFireOnly (const bool)
virtual bool	passingRoundsSuppress () const
virtual void	setPassingRoundsSuppress (const bool)
virtual double	maxDetonationRange () const
virtual void	setMaxDetonationRange (const double)
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 () override
virtual void	postGetSelf () override
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 () 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 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	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 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
	DtSuppressionActuatorDescriptor ()
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
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.
DtRwReal	myInsultToSuppress
DtRwReal	myRecoveryTime
DtRwBoolean	myHostileFireOnly
DtRwBoolean	myPassingRoundsSuppress
DtRwReal	myMaxDetonationRange
const DtDmgMunitionTable *	myDamageModel
DtRwEntityTypeList	myMunitionTypesExceptionList
Protected Attributes inherited from DtActuatorComponentDescriptor
ArtPartTypeSet	myArtPartTypes
DtSimArtPartDescriptorList	myDefaultArtPartDescriptorList
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 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

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

constructor

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

copy constructor.

virtual DtSuppressionActuatorDescriptor::~DtSuppressionActuatorDescriptor ( )

overridevirtual

destructor

DtSuppressionActuatorDescriptor::DtSuppressionActuatorDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtSuppressionActuatorDescriptor& DtSuppressionActuatorDescriptor::operator=

(

const DtSuppressionActuatorDescriptor &

orig

)

assignment.

virtual DtString DtSuppressionActuatorDescriptor::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.

Returns

DtSuppressionActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

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

overridevirtual

Reimplemented from DtActuatorComponentDescriptor.

virtual bool DtSuppressionActuatorDescriptor::init ( )

overridevirtual

Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.

Reimplemented from DtComponentDescriptor.

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

virtual double DtSuppressionActuatorDescriptor::insultToSuppress ( ) const

virtual

Accessors for insultToSuppress.

virtual void DtSuppressionActuatorDescriptor::setInsultToSuppress ( const double  i )

virtual

Accessors for insultToSuppress.

virtual double DtSuppressionActuatorDescriptor::recoveryTime ( ) const

virtual

Accessors for recoveryTime.

virtual void DtSuppressionActuatorDescriptor::setRecoveryTime ( const double  t )

virtual

Accessors for recoveryTime.

virtual bool DtSuppressionActuatorDescriptor::hostileFireOnly ( ) const

virtual

Accessors for hostileFireOnly.

virtual void DtSuppressionActuatorDescriptor::setHostileFireOnly ( const bool  )

virtual

Accessors for hostileFireOnly.

virtual bool DtSuppressionActuatorDescriptor::passingRoundsSuppress ( ) const

virtual

Accessors for passingRoundsSuppress.

virtual void DtSuppressionActuatorDescriptor::setPassingRoundsSuppress ( const bool  )

virtual

Accessors for passingRoundsSuppress.

virtual double DtSuppressionActuatorDescriptor::maxDetonationRange ( ) const

virtual

Accessors for maxDetonationRange. This is the maximum range to check for detonations when using passing rounds to calculate suppression.

virtual void DtSuppressionActuatorDescriptor::setMaxDetonationRange ( const double  )

virtual

Accessors for maxDetonationRange. This is the maximum range to check for detonations when using passing rounds to calculate suppression.

virtual const DtDmgMunitionTable* DtSuppressionActuatorDescriptor::damageModel ( ) const

virtual

Accessor for myDamageModel.

bool DtSuppressionActuatorDescriptor::munitionInExceptionList

(

const DtEntityType &

munitionType

)

Member Data Documentation

DtRwReal DtSuppressionActuatorDescriptor::myInsultToSuppress

protected

Parameter Name: suppression-insult-level
Parameter Description: The quantity of accumulated insult required to cause level 1 suppression. (The munition tables indicate an insult amount for each munition detonation.)
Parameter Default Value: 5.0
Parameter Units:

DtRwReal DtSuppressionActuatorDescriptor::myRecoveryTime

protected

Parameter Name: suppression-recovery-time
Parameter Description: The time required to recover from suppression for an entity that has received just enough insult to be suppressed.
Parameter Default Value: 5.0
Parameter Units: seconds.

DtRwBoolean DtSuppressionActuatorDescriptor::myHostileFireOnly

protected

Parameter Name: hostile-fire-only
Parameter Description: If true, then detonations only cause suppression if they are generated by an attacker with a force hostile to this entity, or have no attacker associated with them.
Parameter Default Value: true
Parameter Units:

DtRwBoolean DtSuppressionActuatorDescriptor::myPassingRoundsSuppress

protected

Parameter Name: passing-rounds-suppress
Parameter Description: If true, then rounds passing by the entity can cause suppression (even if they detonate far beyond the entity).
Parameter Default Value: true
Parameter Units:

DtRwReal DtSuppressionActuatorDescriptor::myMaxDetonationRange

protected

Parameter Name: max-detonation-distance-for-passing-rounds
Parameter Description: The maximum range of detonations to check when computing suppression from passing rounds.
Parameter Default Value: 500.0
Parameter Units: meters.

const DtDmgMunitionTable* DtSuppressionActuatorDescriptor::myDamageModel

protected

Parameter Name: damage-model
Parameter Description: Table of munitions and their insult values for suppression.
Parameter Default Value:
.

DtRwEntityTypeList DtSuppressionActuatorDescriptor::myMunitionTypesExceptionList

protected

Parameter Name: munition-types-exception-list
Parameter Description: List of munitions types that should not trigger the suppression model Parameter Default Value:
.

---

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

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