DtLaserGuidedLauncherControllerDescriptor Class Reference

Parameters for the DtLaserGuidedLauncherController. More...

Inheritance diagram for DtLaserGuidedLauncherControllerDescriptor:

List of all members.

Public Member Functions
	DtLaserGuidedLauncherControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtLaserGuidedLauncherControllerDescriptor (const DtLaserGuidedLauncherControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtLaserGuidedLauncherControllerDescriptor &	operator= (const DtLaserGuidedLauncherControllerDescriptor &orig)
	assignment
virtual	~DtLaserGuidedLauncherControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtObjectType	munitionType () const
	Accessor/mutator for myMunitionType.
virtual void	setMunitionType (const DtObjectType &objType)
	Accessor/mutator for myMunitionType.
virtual DtString	munitionName () const
	Accessor/mutator for myMunitionName.
virtual void	setMunitionName (const DtString &name)
	Accessor/mutator for myMunitionName.
virtual DtVector	launchOffset () const
	Accessor/mutator for myLaunchOffset.
virtual void	setLaunchOffset (const DtVector &offset)
	Accessor/mutator for myLaunchOffset.
virtual DtReal	minTimeBetweenLaunch () const
	Accessor/mutator for myMinTimeBetweenLaunch.
virtual void	setMinTimeBetweenLaunch (DtReal time)
	Accessor/mutator for myMinTimeBetweenLaunch.
virtual DtReal	maxAngleOffBoresight () const
	Accessor/mutator for myMaxAngleOffBoresight.
virtual void	setMaxAngleOffBoresight (DtReal angle)
	Accessor/mutator for myMaxAngleOffBoresight.
virtual int	designatorCode () const
virtual void	setDesignatorCode (int value)
virtual const DtString &	rangeName () const
	Accessor/mutator for myRangeName.
virtual void	setRangeName (const DtString &rangeName)
	Accessor/mutator for myRangeName.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwObjectType	myMunitionType
	Parameter Name: munition-type Parameter Description: Object type used to create the missile when it is fired.
DtRwString	myMunitionName
	Parameter Name: munition-name Parameter Description: Name of munition used to check for quantity in the entity's resource list.
DtRwVector	myLaunchOffset
	Parameter Name: launch-offset Offset from origin of launch vehicle where the missile will be created.
DtRwReal	myMinTimeBetweenLaunch
	Parameter Name: min-time-between-launch Parameter Description: Minimum time between cruise missile launches.
DtRwReal	myMaxAngleOffBoresight
	Parameter Name: max-angle-off-boresight Parameter Description: The maximum angle between the launcher orientation and the angle to the target where the launcher will still fire the missile.
DtRwInt	myDesignatorCode
	Parameter Name: designator-code Parameter Description: The default laser designator code that will be used by this launcher.
DtRwString	myRangeName
	Name given to any range item associated with this descriptor.
Private Member Functions
	DtLaserGuidedLauncherControllerDescriptor ()
	default constructor -- not implemented.

---

Detailed Description

Parameters for the DtLaserGuidedLauncherController.

Determines what type of cruise missile munition will be used, and how it will be launched.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtLaserGuidedLauncherControllerDescriptor::~DtLaserGuidedLauncherControllerDescriptor

(

)

[virtual]

destructor

DtLaserGuidedLauncherControllerDescriptor::DtLaserGuidedLauncherControllerDescriptor

(

)

[private]

default constructor -- not implemented.

---

Member Function Documentation

DtLaserGuidedLauncherControllerDescriptor& DtLaserGuidedLauncherControllerDescriptor::operator=

(

const DtLaserGuidedLauncherControllerDescriptor &

orig

)

assignment

virtual DtString DtLaserGuidedLauncherControllerDescriptor::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:

DtLaserGuidedLauncherControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIntegratedLaserGuidedLauncherDescriptor.

virtual DtObjectType DtLaserGuidedLauncherControllerDescriptor::munitionType

(

)

const [virtual]

Accessor/mutator for myMunitionType.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMunitionType

(

const DtObjectType &

objType

)

[virtual]

Accessor/mutator for myMunitionType.

virtual DtString DtLaserGuidedLauncherControllerDescriptor::munitionName

(

)

const [virtual]

Accessor/mutator for myMunitionName.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMunitionName

(

const DtString &

name

)

[virtual]

Accessor/mutator for myMunitionName.

virtual DtVector DtLaserGuidedLauncherControllerDescriptor::launchOffset

(

)

const [virtual]

Accessor/mutator for myLaunchOffset.

virtual void DtLaserGuidedLauncherControllerDescriptor::setLaunchOffset

(

const DtVector &

offset

)

[virtual]

Accessor/mutator for myLaunchOffset.

virtual DtReal DtLaserGuidedLauncherControllerDescriptor::minTimeBetweenLaunch

(

)

const [virtual]

Accessor/mutator for myMinTimeBetweenLaunch.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMinTimeBetweenLaunch

(

DtReal

time

)

[virtual]

Accessor/mutator for myMinTimeBetweenLaunch.

virtual DtReal DtLaserGuidedLauncherControllerDescriptor::maxAngleOffBoresight

(

)

const [virtual]

Accessor/mutator for myMaxAngleOffBoresight.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMaxAngleOffBoresight

(

DtReal

angle

)

[virtual]

Accessor/mutator for myMaxAngleOffBoresight.

virtual int DtLaserGuidedLauncherControllerDescriptor::designatorCode

(

)

const [virtual]

See also:

myDesignatorCode

virtual void DtLaserGuidedLauncherControllerDescriptor::setDesignatorCode

(

int

value

)

[virtual]

See also:

myDesignatorCode

virtual const DtString& DtLaserGuidedLauncherControllerDescriptor::rangeName

(

)

const [virtual]

Accessor/mutator for myRangeName.

virtual void DtLaserGuidedLauncherControllerDescriptor::setRangeName

(

const DtString &

rangeName

)

[virtual]

Accessor/mutator for myRangeName.

virtual DtComponentDescriptor* DtLaserGuidedLauncherControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIntegratedLaserGuidedLauncherDescriptor.

static DtComponentDescriptor* DtLaserGuidedLauncherControllerDescriptor::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.

Reimplemented in DtIntegratedLaserGuidedLauncherDescriptor.

---

Member Data Documentation

DtRwObjectType DtLaserGuidedLauncherControllerDescriptor::myMunitionType [protected]

Parameter Name: munition-type
Parameter Description: Object type used to create the missile when it is fired.

Parameter Default Value: (0 0 0 0 0 0 0)

DtRwString DtLaserGuidedLauncherControllerDescriptor::myMunitionName [protected]

Parameter Name: munition-name
Parameter Description: Name of munition used to check for quantity in the entity's resource list.

This is the name that will be looked up in the entitiy's resources and decremented.
Parameter Default Value: ""

DtRwVector DtLaserGuidedLauncherControllerDescriptor::myLaunchOffset [protected]

Parameter Name: launch-offset
Offset from origin of launch vehicle where the missile will be created.

Parameter Description: Offset from origin of launch vehicle where the missile will be created, in body coordinates of the launch vehicle.
Parameter Default Value: (0.0 0.0 0.0) (x, y, z)
Parameter Units: meters

DtRwReal DtLaserGuidedLauncherControllerDescriptor::myMinTimeBetweenLaunch [protected]

Parameter Name: min-time-between-launch
Parameter Description: Minimum time between cruise missile launches.

Parameter Default Value: 0.0
Parameter Units: seconds

DtRwReal DtLaserGuidedLauncherControllerDescriptor::myMaxAngleOffBoresight [protected]

Parameter Name: max-angle-off-boresight
Parameter Description: The maximum angle between the launcher orientation and the angle to the target where the launcher will still fire the missile.

Parameter Default Value: 0.35 (20 degrees)
Parameter Units: radians

DtRwInt DtLaserGuidedLauncherControllerDescriptor::myDesignatorCode [protected]

Parameter Name: designator-code
Parameter Description: The default laser designator code that will be used by this launcher.

The launcher will only be able to fire on targets designated by a laser with this code. It can be changed at runtime. If -1 is specified, each entity will be assigned a pseudo-random laser code at creation.
Parameter Default Value: -1

DtRwString DtLaserGuidedLauncherControllerDescriptor::myRangeName [protected]

Name given to any range item associated with this descriptor.

Parameter Default Value:

---

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

• include/vrfobjparam/laserGuidedLauncherDesc.h