DtSuppressionActuator is responsible for setting the suppression level from appropriate detonations.

End User Description: DtSuppressionActuator provides a simple suppression model.

The suppression actuator registers callbacks with the DtDetonationManager, so that it is notified of the appropriate detonations.

Uses Descriptor Type: DtSuppressionComponentDescriptor

Inheritance diagram for DtSuppressionActuator:

[legend]

Public Member Functions
	DtSuppressionActuator (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSuppressionActuator ()

virtual bool	init ()

virtual bool	createPSR ()

virtual bool	processDetonationInsult (const DtDetonationContext &detonationContext)

virtual const char *	type () const

virtual void	tick ()

Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent ()

virtual DtSimRadio *	radio ()

virtual bool	tickWhileDestroyed () const

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent ()

virtual void	setParentSystem (DtComponentSystem *system)

DtComponentSystem *	parentSystem () const

virtual bool	postAddComponentsInit ()

virtual void	registerAttributeFunctions ()

virtual void	preFirstTickInit ()

virtual void	postTick ()

virtual void	timedTick ()

virtual void	setMinTickPeriod (double minTickPeriod)

virtual double	minTickPeriod () const

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)

virtual double	minTickPeriodVariance () const

virtual void	setNextTickTime (double nextTickTime)

virtual double	nextTickTime () const

virtual double	calculateNextTickTime () const

virtual double	calculateFirstTickTime () const

virtual void	setEntity (DtLocalObject *entity)

virtual DtSimComponent *	nextComponent ()

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)

virtual DtListItem *	listItem ()

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	addInputPort (DtInputPort *port)

virtual void	removeInputPort (DtInputPort *port)

virtual DtInputPort *	lookupInputPort (const DtString &portName)

virtual DtList	inputPortList () const

virtual void	addOutputPort (DtOutputPort *port)

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)

virtual DtList	outputPortList () const

virtual void	addInputPortGroup (DtInputPortGroup *group)

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)

virtual DtList	inputPortGroupList () const

virtual void	addOutputPortGroup (DtOutputPortGroup *group)

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)

virtual DtList	outputPortGroupList () const

virtual int	priority () const

virtual void	setPriority (int priority)

double	dT () const

virtual void	setDT (double deltaT)

virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)

virtual const DtComponentDescriptor *	componentDescriptor () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()

const DtPhysicalWorld *	physicalWorld () const

const DtAttachedTerrain *	terrainAttachedTo () const

DtLocalObject *	entity ()

const DtLocalObject *	entity () const

DtSimulationServices *	simulationServices ()

const DtSimulationServices *	simulationServices () const

const Coordinate_System *	coordinateSystem () const

virtual bool	taskVisualizationsActive () const

virtual bool	taskVisualizationsEnabled () const

virtual void	onRestore ()

makVrf::DtTaskVisualizationMap &	taskVisualizations ()

virtual void	enable ()

virtual void	disable ()

virtual bool	isEnabled ()

virtual void	setIsEnabled (bool yesNo)

virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const

virtual int	notifyLevel () const

virtual DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

VRF4API_METHOD const DtSimulationServices *	simManager () const

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	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	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 bool	processDetonationCallback (const DtDetonationContext &detonationContext, void *usr)

static void	setDestroyedCallback (DtSimMessage msg, void usrData)

static void	setRestoredCallback (DtSimMessage msg, void usrData)

static DtSimComponent *	creator (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject owner, DtSimulationServices simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)

static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)

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
virtual void	setDestroyed ()

virtual void	setRestored ()

virtual bool	registerForDetonations ()

virtual bool	unregisterForDetonations ()

virtual void	setRadio (DtSimRadio *radio)

virtual bool	isRegisteredForDetonations () const

virtual void	setIsRegisteredForDetonations (const bool r)

virtual double	computeRecoveryRate ()

virtual double	suppressionFromInsult (const double insult)

virtual double	computeInsultToSuppressionFactor ()

virtual double	decaySuppressionValue (const double oldValue, const double dT)

virtual DtVrfMovingObjectStateRepository::suppressionLevels	updateSuppressionLevel (const DtVrfMovingObjectStateRepository::suppressionLevels oldLevel, const double newValue)

virtual int	suppressionValueBin (const double suppressionValue)

virtual double	detonationInsult (const double maxEffect, const double maxRange, const double range)

virtual double	rangeToTrajectory (const DtDetonationContext &context, const double rangeToDetonation)

Protected Member Functions inherited from DtActuatorComponent
	DtActuatorComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

	DtActuatorComponent ()

Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()

bool	testInvariant () const

virtual bool	createPortGroups ()

virtual bool	createPorts ()

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)

virtual void	updateTaskVisualizations ()

virtual void	destroyTaskVisualizations ()

virtual void	destroyTaskVisualization (const DtString &name)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)

double	calculateNextTaskVisTickTime () const

DtVrfObjectStateRepository *	localStateRepository ()

const DtVrfObjectStateRepository *	localStateRepository () const

void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)

void	removeSimObjectPredicateCallback (const DtSimObject , DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void userData=0)

void	invokeSimObjectPredicateCallbacks ()

virtual void	clearPredicateCallbacks ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtSuppressionActuatorDescriptor *	mySuppressionActuatorDescriptor

bool	myIsRegisteredForDetonations

DtSuppressionActuatorPSR *	myProcessState

double	myInsultFactor

double	myRecoveryRate

Protected Attributes inherited from DtActuatorComponent
DtSimRadio *	myRadio

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myMinTickPeriod

double	myMinTickPeriodVariance

double	myNextTickTime

double	myLastTickSimTime

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

bool	myTickEveryFrame

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager	myPredicateCallbackManager

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

Private Member Functions
	DtSuppressionActuator ()

	DtSuppressionActuator (const DtSuppressionActuator &orig)

DtSuppressionActuator &	operator= (const DtSuppressionActuator &orig)

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 )()

Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap

typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap

typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap

typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	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

DtSuppressionActuator::DtSuppressionActuator	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

virtual DtSuppressionActuator::~DtSuppressionActuator ( )

virtual

destructor Unregisters with the detonation manager.

DtSuppressionActuator::DtSuppressionActuator ( )

private

Default constructor; not implemented.

DtSuppressionActuator::DtSuppressionActuator ( const DtSuppressionActuator & orig )

private

copy constructor; not implemented

Member Function Documentation

virtual bool DtSuppressionActuator::init ( )

virtual

Registers callbacks with the detonation manager. Provides the detonation manager a pointer to the component's entity, the entity's global ID, the munition type the entity can be suppressed by, and the maximum range within which this munition can cause suppression to the entity.

Relies on the destructor or the setDestroyed callback for unregistration from the detonation manager.

Reimplemented from DtActuatorComponent.

virtual bool DtSuppressionActuator::createPSR ( )

virtual

Create a process state repository (DtSuppressionPSR), or a different type if it is specified in the OPD.

static bool DtSuppressionActuator::processDetonationCallback	(	const DtDetonationContext &	detonationContext,
		void *	usr
	)

static

The detonation manager uses this function to notify the actuator of when it needs to process an entity detonation for the entity.

Parameters

detonationContext	The detonation context to process
usr	A pointer to the suppression actuator that should process the detonation context.

virtual bool DtSuppressionActuator::processDetonationInsult ( const DtDetonationContext & detonationContext )

virtual

When a detonation context is received, from the detonation manager, it is processed in order to determine the appropriate suppression to the entity. Uses the distance to the detonation with the information in the damage-model to determine insult from the detonation; if this is zero, then it computes the distance to the munition trajectory to possibly determine an insult.

Returns: A boolean indicating whether or not the component was able to properly adjudicate the suppression done to the associated entity by the detonation.

Note: If this returns false, then the detonation could not be processed for some reason.

virtual const char* DtSuppressionActuator::type ( ) const

virtual

Returns a string identifies the class type of component. Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns: DtSuppressionActuatorType

Implements DtSimComponent.

virtual void DtSuppressionActuator::tick ( )

virtual

Determines how the suppression effects may be wearing off.

Reimplemented from DtSimComponent.

static void DtSuppressionActuator::setDestroyedCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

static

Ends the suppression fade calculations.

static void DtSuppressionActuator::setRestoredCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

static

Zeros suppression and clears the fading effects.

static DtSimComponent* DtSuppressionActuator::creator	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

Returns: New instance of this class.

virtual void DtSuppressionActuator::setDestroyed ( )

protectedvirtual

Unregisters for detonations.

See Also: unregisterForDetonations.

virtual void DtSuppressionActuator::setRestored ( )

protectedvirtual

Re-registers the entity to receive detonations since it is now restored.

See Also: registerForDetonations

virtual bool DtSuppressionActuator::registerForDetonations ( )

protectedvirtual

Registers the entity to receive notification of appropriate detonations and notes that the callbacks have been registered. Registers for both direct and collateral if suppression files exist for them.

Note: Only registers if we're not registered yet.

virtual bool DtSuppressionActuator::unregisterForDetonations ( )

protectedvirtual

Unregisters the entity to receive notification of appropriate detonations, and notes that the callbacks have been unregistered.

Note: Only unregisters if we're registered

virtual void DtSuppressionActuator::setRadio ( DtSimRadio * radio )

protectedvirtual

Overrides this so it can register its interest the set destroyed message.

Reimplemented from DtActuatorComponent.

virtual bool DtSuppressionActuator::isRegisteredForDetonations ( ) const

protectedvirtual

Indicates whether the component has already registered for detonation notifications.

virtual void DtSuppressionActuator::setIsRegisteredForDetonations ( const bool r )

protectedvirtual

virtual double DtSuppressionActuator::computeRecoveryRate ( )

protectedvirtual

Compute the decay rate of the suppression value. In the default implementation, this is just the difference between the thresholds of the first two bins (see suppressionValueBin) divided by the recovery time parameter in the descriptor. The value will be negative.

virtual double DtSuppressionActuator::suppressionFromInsult ( const double insult )

protectedvirtual

Compute a suppression value from an insult value. The insult value ranges from [0, infinity], while the suppression value ranges from [0, 1]. In the default implementation, s = 1 - e^(-a i), where s is the suppression value, i is the insult value, and a is the mapping factor (a > 0).

virtual double DtSuppressionActuator::computeInsultToSuppressionFactor ( )

protectedvirtual

Compute the factor "a" (see suppressionFromInsult) that determines the mapping function from insult value to suppression value. The factor "a" is computed from the descriptor value for the insult level required to become suppressed, where the threshold of s for suppression is the third quintile, or > 0.4.

virtual double DtSuppressionActuator::decaySuppressionValue	(	const double	oldValue,
		const double	dT
	)

protectedvirtual

Reduce the suppression value and return the new value. The corresponding decayed insult value is written back to the PSR. Makes use of the tick time and the decay rate.

virtual DtVrfMovingObjectStateRepository::suppressionLevels DtSuppressionActuator::updateSuppressionLevel	(	const DtVrfMovingObjectStateRepository::suppressionLevels	oldLevel,
		const double	newValue
	)

protectedvirtual

Given the old and updated suppression values (numbers in the range [0, 1]), compute the new suppression level. This function takes an old value as well as the current (new) value as arguments so that it can implement some form of hysteresis and avoid changing the level too frequently.

virtual int DtSuppressionActuator::suppressionValueBin ( const double suppressionValue )

protectedvirtual

Determine what discrete range the suppression value is in, for the purposes of converting a value to a discrete suppression level. The input value is in the interval [0, 1]. The return value is an integer >= 0. In the default implementation, the input range is divided into quintiles, so the return value is an integer in [0, 4].

virtual double DtSuppressionActuator::detonationInsult	(	const double	maxEffect,
		const double	maxRange,
		const double	range
	)

protectedvirtual

Compute the insult level for a detonation, given the insult at 1.0m, the range at which the insult falls to 0, and the range to this detonation. In the default implementation, a linear drop off of insult with range is used.

virtual double DtSuppressionActuator::rangeToTrajectory	(	const DtDetonationContext &	context,
		const double	rangeToDetonation
	)

protectedvirtual

Compute the range from the munition trajectory to the entity. Uses the attacking entity, if known, to provide a firing origin. If this is not available, the return value will be the range to the detonation. The rangeToDetonation is passed in so that it doesn't have to be recomputed.

DtSuppressionActuator& DtSuppressionActuator::operator= ( const DtSuppressionActuator & orig )

private

assignment operator; not implemented

Member Data Documentation

DtSuppressionActuatorDescriptor* DtSuppressionActuator::mySuppressionActuatorDescriptor

protected

bool DtSuppressionActuator::myIsRegisteredForDetonations

protected

DtSuppressionActuatorPSR* DtSuppressionActuator::myProcessState

protected

double DtSuppressionActuator::myInsultFactor

protected

double DtSuppressionActuator::myRecoveryRate

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmodel/suppressionActuator.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation