DtDetonationControllerDescriptor Class Reference

DtDetonationControllerDescriptor; descriptor for the DtDetonationController component. More...

Inheritance diagram for DtDetonationControllerDescriptor:

List of all members.

Public Member Functions
	DtDetonationControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtDetonationControllerDescriptor (const DtDetonationControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtDetonationControllerDescriptor &	operator= (const DtDetonationControllerDescriptor &orig)
	assignment
virtual	~DtDetonationControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual const DtString &	detonatorFuse () const
	Accessor/mutator for #myFuseType.
virtual void	setDetonatorFuse (const DtString &fuse)
virtual DtReal	detonationProximity () const
	Accessor/mutator for myDetonationProximity.
virtual void	setDetonationProximity (DtReal proximity)
	Accessor/mutator for myDetonationProximity.
virtual DtReal	malfunctionPercentage () const
	Accessor/mutator for myMalfunctionPercentage.
virtual void	setMalfunctionPercentage (DtReal percent)
	Accessor/mutator for myMalfunctionPercentage.
virtual bool	amArmed () const
	Accessor/mutator for myAmArmed.
virtual void	setAmArmed (bool armed)
	Accessor/mutator for myAmArmed.
virtual const DtRwObjectTypeList &	objTypesToDetect () const
	Accessor/mutator for #myObjTypesToSpotRep.
virtual void	setObjTypesToDetect (const DtRwObjectTypeList &list)
	Accessor/mutator for #myObjTypesToSpotRep.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtDetonationControllerDescriptor ()
	default constructor
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myFuseTypeString
	Parameter Name: fuse-type Parameter Description: Name of type of fuse to be used for detonation--proximity, timed... Parameter Default Value: .
DtRwReal	myDetonationProximity
	Parameter Name: detonation-proximity-distance Parameter Description: If using a proximity fuse, this specifies the distance in meters to the target within which the proximity fuse will be triggered and a detonation will occur.
DtRwReal	myMalfunctionPercentage
	Parameter Name: malfunction-percentage Parameter Description: This is the percent chance this detonator will fail.
DtRwBoolean	myAmArmed
	Parameter Name: armed Parameter Description: Defines whether this detonator is armed at creation of the entity.
DtRwObjectTypeList	myObjTypesToDetect
	Parameter Name: "object-types-to-detect" Parameter Description: List of object types this controller would like the sensor to detect.

---

Detailed Description

DtDetonationControllerDescriptor; descriptor for the DtDetonationController component.

DtDetonationControllerDescriptor is a DtComponentDescriptor that has additional information needed for providing parameters to a detonation controller. It provides the type of fuse to use and the proximity distance.

---

Constructor & Destructor Documentation

DtDetonationControllerDescriptor::DtDetonationControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtDetonationControllerDescriptor::DtDetonationControllerDescriptor	(	const DtDetonationControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtDetonationControllerDescriptor::~DtDetonationControllerDescriptor

(

)

[virtual]

destructor

DtDetonationControllerDescriptor::DtDetonationControllerDescriptor

(

)

[protected]

default constructor

---

Member Function Documentation

DtDetonationControllerDescriptor& DtDetonationControllerDescriptor::operator=

(

const DtDetonationControllerDescriptor &

orig

)

assignment

virtual DtString DtDetonationControllerDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtDetonationControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtDetonationControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

virtual const DtString& DtDetonationControllerDescriptor::detonatorFuse

(

)

const [virtual]

Accessor/mutator for #myFuseType.

virtual void DtDetonationControllerDescriptor::setDetonatorFuse

(

const DtString &

fuse

)

[virtual]

virtual DtReal DtDetonationControllerDescriptor::detonationProximity

(

)

const [virtual]

Accessor/mutator for myDetonationProximity.

virtual void DtDetonationControllerDescriptor::setDetonationProximity

(

DtReal

proximity

)

[virtual]

Accessor/mutator for myDetonationProximity.

virtual DtReal DtDetonationControllerDescriptor::malfunctionPercentage

(

)

const [virtual]

Accessor/mutator for myMalfunctionPercentage.

virtual void DtDetonationControllerDescriptor::setMalfunctionPercentage

(

DtReal

percent

)

[virtual]

Accessor/mutator for myMalfunctionPercentage.

virtual bool DtDetonationControllerDescriptor::amArmed

(

)

const [virtual]

Accessor/mutator for myAmArmed.

virtual void DtDetonationControllerDescriptor::setAmArmed

(

bool

armed

)

[virtual]

Accessor/mutator for myAmArmed.

virtual const DtRwObjectTypeList& DtDetonationControllerDescriptor::objTypesToDetect

(

)

const [virtual]

Accessor/mutator for #myObjTypesToSpotRep.

virtual void DtDetonationControllerDescriptor::setObjTypesToDetect

(

const DtRwObjectTypeList &

list

)

[virtual]

Accessor/mutator for #myObjTypesToSpotRep.

static DtComponentDescriptor* DtDetonationControllerDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.

---

Member Data Documentation

DtRwString DtDetonationControllerDescriptor::myFuseTypeString [protected]

Parameter Name: fuse-type
Parameter Description: Name of type of fuse to be used for detonation--proximity, timed...
Parameter Default Value:
.

DtRwReal DtDetonationControllerDescriptor::myDetonationProximity [protected]

Parameter Name: detonation-proximity-distance
Parameter Description: If using a proximity fuse, this specifies the distance in meters to the target within which the proximity fuse will be triggered and a detonation will occur.

Parameter Default Value:

DtRwReal DtDetonationControllerDescriptor::myMalfunctionPercentage [protected]

Parameter Name: malfunction-percentage
Parameter Description: This is the percent chance this detonator will fail.

Parameter Default Value: 0.0

DtRwBoolean DtDetonationControllerDescriptor::myAmArmed [protected]

Parameter Name: armed
Parameter Description: Defines whether this detonator is armed at creation of the entity.

Parameter Default Value: false

DtRwObjectTypeList DtDetonationControllerDescriptor::myObjTypesToDetect [protected]

Parameter Name: "object-types-to-detect"
Parameter Description: List of object types this controller would like the sensor to detect.

---

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

• include/vrfobjparam/detonationCtlrDesc.h