DtSuppressionActuator Class Reference

class DtPrbValueList; More...

Inheritance diagram for DtSuppressionActuator:

Public Member Functions
	DtSuppressionActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSuppressionActuator ()
	destructor Unregisters with the detonation manager. More...
virtual bool	init ()
	Registers callbacks with the detonation manager. More...
virtual bool	createPSR ()
	Create a process state repository (DtSuppressionPSR), or a different type if it is specified in the OPD. More...
virtual bool	processDetonationInsult (const DtDetonationContext &detonationContext)
	When a detonation context is received, from the detonation manager, it is processed in order to determine the appropriate suppression to the entity. More...
virtual const char *	type () const
	Returns a string identifies the class type of component. More...
virtual void	tick ()
	Determines how the suppression effects may be wearing off. More...
Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent ()
	destructor More...
virtual DtSimRadio *	radio ()
virtual bool	tickWhileDestroyed () const
	By default, all actuators tick when the entity is destroyed. More...
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor More...
virtual void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component. More...
DtComponentSystem *	parentSystem () const
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager. More...
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values. More...
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time. More...
virtual void	postTick ()
	This function is called immediately after tick() is called. More...
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived. More...
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as More...
virtual double	minTickPeriod () const
	access the minimum tick period More...
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time More...
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period More...
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally. More...
virtual double	nextTickTime () const
	access the next tick time More...
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at. More...
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state. More...
virtual DtSimComponent *	nextComponent ()
	List management functions. More...
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList. More...
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class. More...
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored. More...
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it. More...
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name. More...
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component. More...
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it. More...
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name. More...
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component. More...
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it. More...
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name. More...
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component. More...
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it. More...
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name. More...
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component. More...
virtual int	priority () const
	Return the current connection priority for this component. More...
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value. More...
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary. More...
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component. More...
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in. More...
const DtPhysicalWorld *	physicalWorld () const
DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any. More...
const DtAttachedTerrain *	terrainAttachedTo () const
DtVrfObject *	entity ()
	Gets the entity. More...
const DtVrfObject *	entity () const
const DtVrfObject *	const_entity () const
	You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...
DtSimManager *	simManager ()
	Gets the sim manager. More...
const DtSimManager *	simManager () const
const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository. More...
const DtVrfObjectStateRepository *	localStateRepository () const
const DtVrfObjectStateRepository *	const_localStateRepository () const
	You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...
virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component. More...
virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component. More...
virtual bool	taskVisualizationsEnabled () const
	Returns true if task visualizations are enabled for this component. More...
virtual bool	isThreadSafe () const
	Returns true if this component is marked as being thread safe. More...
virtual void	addVRLinkDeferredJob (const boost::function< void()> &callback)
	Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More...
virtual void	onRestore ()
	Called whenever a component is restored. Default is no-op. More...
virtual void	enable ()
	Is this component enabled or not. More...
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 DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...
bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor More...
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...
virtual void	writeSelf (std::string &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. More...
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag. More...
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...
virtual void	setName (const DtString &)
	Set the name of the object. More...
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...
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. More...
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...
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. More...
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...
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())
	Gets data from the environment value. More...
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static bool	processDetonationCallback (const DtDetonationContext &detonationContext, void *usr)
	The detonation manager uses this function to notify the actuator of when it needs to process an entity detonation for the entity. More...
static void	setDestroyedCallback (DtSimMessage *msg, void *usrData)
	Ends the suppression fade calculations. More...
static void	setRestoredCallback (DtSimMessage *msg, void *usrData)
	Zeros suppression and clears the fading effects. More...
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponent *	MarkThreadSafe (DtSimComponent *)
	Marks an instance of a component as being thread safe. More...
static DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...
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 ()
	The type that is used when archiving to an XML stream. More...
static const DtFilename &	appPath ()
	Gets the current working directory. More...
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...
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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...
Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
virtual void	setDestroyed ()
	Unregisters for detonations. More...
virtual void	setRestored ()
	Re-registers the entity to receive detonations since it is now restored. More...
virtual bool	registerForDetonations ()
	Registers the entity to receive notification of appropriate detonations and notes that the callbacks have been registered. More...
virtual bool	unregisterForDetonations ()
	Unregisters the entity to receive notification of appropriate detonations, and notes that the callbacks have been unregistered. More...
virtual void	setRadio (DtSimRadio *radio)
	Overrides this so it can register its interest the set destroyed message. More...
virtual bool	isRegisteredForDetonations () const
	Indicates whether the component has already registered for detonation notifications. More...
virtual void	setIsRegisteredForDetonations (const bool r)
virtual double	computeRecoveryRate ()
	Compute the decay rate of the suppression value. More...
virtual double	suppressionFromInsult (const double insult)
	Compute a suppression value from an insult value. More...
virtual double	computeInsultToSuppressionFactor ()
	Compute the factor "a" (see suppressionFromInsult) that determines the mapping function from insult value to suppression value. More...
virtual double	decaySuppressionValue (const double oldValue, const double dT)
	Reduce the suppression value and return the new value. More...
virtual DtVrfMovingObjectStateRepository::suppressionLevels	updateSuppressionLevel (const double oldValue, const double newValue)
	Given the old and updated suppression values (numbers in the range [0, 1]), compute the new suppression level. More...
virtual int	suppressionValueBin (const double suppressionValue)
	Determine what discrete range the suppression value is in, for the purposes of converting a value to a discrete suppression level. More...
virtual double	detonationInsult (const double maxEffect, const double maxRange, const double range)
	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. More...
virtual double	rangeToTrajectory (const DtDetonationContext &context, const double rangeToDetonation)
	Compute the range from the munition trajectory to the entity. More...
Protected Member Functions inherited from DtActuatorComponent
	DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	DtActuatorComponent ()
	Default constructor; should not be called. More...
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT. More...
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init. More...
virtual bool	createPorts ()
	Called by init. More...
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager. More...
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick. More...
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component. More...
virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization. More...
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name. More...
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name. More...
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name. More...
virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name. More...
double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked. More...
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtSuppressionActuatorDescriptor *	mySuppressionActuatorDescriptor
bool	myIsRegisteredForDetonations
DtSuppressionActuatorPSR *	myProcessState
double	myInsultFactor
double	myRecoveryRate
Protected Attributes inherited from DtActuatorComponent
DtSimRadio *	myRadio
	Actuators can send messages. More...
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs. More...
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not. More...
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick. More...
bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...
bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...
DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component. More...
double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations. More...
DtSymbolString	myFullComponentName
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
	Container for the aliases which represent alternative names for the object. More...
bool	myInvalid
	Set to true if there is a problem reading this item. More...
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Private Member Functions
	DtSuppressionActuator ()
	Default constructor; not implemented. More...
	DtSuppressionActuator (const DtSuppressionActuator &orig)
	copy constructor; not implemented More...
DtSuppressionActuator &	operator= (const DtSuppressionActuator &orig)
	assignment operator; not implemented More...

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

Detailed Description

class DtPrbValueList;

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

Constructor & Destructor Documentation

DtSuppressionActuator::DtSuppressionActuator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject 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, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject 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 double  oldValue, const double  newValue  )

protectedvirtual

Given the old and updated suppression values (numbers in the range [0, 1]), compute the new suppression level.

This function implements hysteresis, so that after the increasing value passes a threshold and a higher suppression level is reached, that level remains in effect for a period of time while the suppression value falls to some value below that threshold.

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.vrf4-8-branch/include/vrfmodel/suppressionActuator.h