DtIndividualLifeFormDamageAdjudicationActuator; simple model of damage for lifeforms. More...

Inheritance diagram for DtIndividualLifeFormDamageAdjudicationActuator:

Public Member Functions
	DtIndividualLifeFormDamageAdjudicationActuator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,
virtual	~DtIndividualLifeFormDamageAdjudicationActuator ()
	destructor
virtual bool	init ()
	to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	Determines the destroyed status of the entity.
Public Member Functions inherited from DtDamageAdjudicationActuator
	DtDamageAdjudicationActuator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,
virtual	~DtDamageAdjudicationActuator ()
	destructor Unregisters with the detonation manager.
virtual bool	adjudicateDirectDamage (const DtDetonationContext &detonationContext)
	When a detonation context is received, from the detonation manager, it is processed in order to determine the appropriate damage to the entity.
virtual bool	adjudicateCollateralDamage (const DtDetonationContext &detonationContext)
	Determines collateral damage from an impact near the entity.
Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent ()
	destructor
virtual DtSimBaseRadio *	radio ()
virtual bool	tickWhileDestroyed () const
	By default, all actuators tick when the entity is destroyed.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
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.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
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.
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.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
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.
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.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
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.
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.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
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.
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.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
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.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
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.
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.
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,
Static Public Member Functions inherited from DtDamageAdjudicationActuator
static bool	processDirectDetonationCallback (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.
static bool	processCollateralDetonationCallback (const DtDetonationContext &detonationContext, void *usr)
	The detonation manager uses this function to notify the actuator of when it needs to process an ground detonation to determine any collateral damage for the entity.
static void	setDestroyedCallback (DtSimMessage msg, void usrData)
	Calls setDestroyed()
static void	setRestoredCallback (DtSimMessage msg, void usrData)
	Calls setRestored()

Protected Member Functions
virtual void	setDestroyed ()
	Overrides the parent classes version of this because the parent class version calls the local state rep's setDestroyed function, which in turn sets smoking, etc to states inappropriate for this class.
Protected Member Functions inherited from DtDamageAdjudicationActuator
virtual void	getDirectFireSurfaceAndAngleOfIncidence (DtDetonationContext &detonationContext)
	Determines the fire surface and the angle of incidence of the detonation from a direct fire weapon and puts them in the specified detonation context.
virtual void	getIndirectFireSurfaceAndAngleOfIncidence (DtDetonationContext &detonationContext)
	Determines the fire surface and the angle of incidence of the detonation and puts them in the specified detonation context.
virtual DtSymbolString	getSurface (DtBoundingVolumeFace impactSurface)
virtual bool	getRangeEntry (const DtDetonationContext &detonationContext, DtPrbRangeTableEntry &rangeEntry, bool isDirectDamage=true) const
	Gets the range entry from the damage component descriptor's kill probabilities.
virtual bool	isCatastrophicallyKilled (DtPrbRangeTableEntry &rangeEntry, DtSymbolString catastrophicKillString) const
	Gets the probability of being catastrophically killed by the detonation from the specified range entry.
virtual bool	isFirepowerKilled (DtPrbRangeTableEntry &rangeEntry, DtSymbolString firepowerKillString) const
	Gets the probability of being firepower killed by the detonation from the specified range entry.
virtual bool	isMobilityKilled (DtPrbRangeTableEntry &rangeEntry, DtSymbolString mobilityKillString) const
	Gets the probability of being mobility killed by the detonation from the specified range entry.
virtual DtSymbolString	catastrophicKillString () const
virtual DtSymbolString	mobilityKillString () const
virtual DtSymbolString	firepowerKillString () const
virtual void	determineDestroyedStatus ()
	This function determines if anything we are attached to are occupying was destroyed (last tick).
virtual void	setRestored ()
	Re-registers the entity to receive detonations since it is now restored.
virtual bool	registerForDetonations ()
	Registers the entity to receive notification of appropriate detonations and notes that the callbacks have been registered.
virtual bool	unregisterForDetonations ()
	Unregisters the entity to receive notification of appropriate detonations, and notes that the callbacks have been unregistered.
virtual void	setMobilityKilled ()
	Calls setMobilityKilled on the myLocalStateRepository.
virtual void	setFirepowerKilled ()
	Calls setFirepowerKilled on the myLocalStateRepository.
virtual void	setRadio (DtSimBaseRadio *radio)
	Overrides this so it can register its interest the set destroyed message.
virtual bool	isRegisteredForDetonations () const
	Keep track of whether or not we're registered for detonations direct or collateral.
virtual void	setIsRegisteredForDetonations (bool yesOrNo)
	Keep track of whether or not we're registered for detonations direct or collateral.
Protected Member Functions inherited from DtActuatorComponent
	DtActuatorComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString& name,
	DtActuatorComponent (const DtActuatorComponent &orig)
	copy constructor
const DtActuatorComponent &	operator= (const DtActuatorComponent &orig)
	assignment operator
	DtActuatorComponent ()
	Default constructor; should not be called.
Protected Member Functions inherited from DtSimComponent
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.

Private Member Functions
	DtIndividualLifeFormDamageAdjudicationActuator ()
	Default constructor; should not be called.
	DtIndividualLifeFormDamageAdjudicationActuator (const DtIndividualLifeFormDamageAdjudicationActuator &orig)
	copy constructor - not implemented
const DtIndividualLifeFormDamageAdjudicationActuator &	operator= (const DtIndividualLifeFormDamageAdjudicationActuator &orig)
	assignment operator not implemented

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
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
Protected Attributes inherited from DtDamageAdjudicationActuator
DtDamageAdjudicationComponentDescriptor *	myDamageComponentDescriptor
DtTime	myStopSmokingTime
DtTime	myStopFlamingTime
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtIndividualLifeFormDamageAdjudicationActuator; simple model of damage for lifeforms.

DtIndividualLifeFormDamageAdjudicationActuator is a simple damage model for a life form.

Uses Descriptor Type: DtDamageAdjudicationComponentDescriptor

Constructor & Destructor Documentation

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

(const DtString&,DtVrfObject*,DtSimManager*,

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

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtIndividualLifeFormDamageAdjudicationActuator::~DtIndividualLifeFormDamageAdjudicationActuator ( )

virtual

destructor

DtIndividualLifeFormDamageAdjudicationActuator::DtIndividualLifeFormDamageAdjudicationActuator ( )

private

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtIndividualLifeFormDamageAdjudicationActuator::DtIndividualLifeFormDamageAdjudicationActuator ( const DtIndividualLifeFormDamageAdjudicationActuator & orig )

private

copy constructor - not implemented

Member Function Documentation

virtual bool DtIndividualLifeFormDamageAdjudicationActuator::init ( )

virtual

to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports.

Reimplemented from DtDamageAdjudicationActuator.

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

Returns: DtIndividualLifeFormDamageAdjudicationActuatorType

Reimplemented from DtDamageAdjudicationActuator.

virtual void DtIndividualLifeFormDamageAdjudicationActuator::tick ( )

virtual

Determines the destroyed status of the entity.

Also, if the entity is destroyed, it ensures that it unregisters for detonation notifications if it hasn't already done so.

Note: Determining destroyed status updates the status if appropriate.; Unlike the parent classes function, this does not set smoke or flame time as they are not appropriate for this class.

See Also: determineDestroyedStatus; unregisterForDetonations

Reimplemented from DtDamageAdjudicationActuator.

static DtSimComponent* DtIndividualLifeFormDamageAdjudicationActuator::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

(const DtString&,DtVrfObject*,DtSimManager*,

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

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns: New instance of this class.

Reimplemented from DtDamageAdjudicationActuator.

virtual void DtIndividualLifeFormDamageAdjudicationActuator::setDestroyed ( )

protectedvirtual

Overrides the parent classes version of this because the parent class version calls the local state rep's setDestroyed function, which in turn sets smoking, etc to states inappropriate for this class.

This version directly sets the damage state in the local state rep to be destroyed. It also unregisters for detonations.

Reimplemented from DtDamageAdjudicationActuator.

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

private

assignment operator not implemented

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

include/vrfmodel/indLifeFormDmgAdjudicationActuator.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation