DtIndividualLifeFormDamageAdjudicationActuator Class Reference

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

Inheritance diagram for DtIndividualLifeFormDamageAdjudicationActuator:

List of all members.

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.
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
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.
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

---

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

(

)

[protected, virtual]

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