DtCruiseMissileLaunchControllerDescriptor Class Reference

DtCruiseMissileLaunchControllerDescriptor; descriptor for the DtCruiseMissileLaunchController component. More...

Inheritance diagram for DtCruiseMissileLaunchControllerDescriptor:

List of all members.

Public Member Functions
	DtCruiseMissileLaunchControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtCruiseMissileLaunchControllerDescriptor (const DtCruiseMissileLaunchControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtCruiseMissileLaunchControllerDescriptor &	operator= (const DtCruiseMissileLaunchControllerDescriptor &orig)
	assignment
virtual	~DtCruiseMissileLaunchControllerDescriptor ()
	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 DtTaitBryan	launchOrientation () const
	Accessor/mutator for myLaunchOrientation.
virtual void	setLaunchOrientation (const DtTaitBryan &orient)
	Accessor/mutator for myLaunchOrientation.
virtual DtReal	minTimeBetweenLaunch () const
	Accessor/mutator for myMinTimeBetweenLaunch.
virtual void	setMinTimeBetweenLaunch (DtReal time)
	Accessor/mutator for myMinTimeBetweenLaunch.
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 orgin of launch vehicle where the missile will be created.
DtRwTaitBryan	myLaunchOrientation
	Parameter Name: launch-orientation Parameter Description: //! Initial orientation (relative to the launching entity) for a newly created cruise missile.
DtRwReal	myMinTimeBetweenLaunch
	Parameter Name: min-time-between-launch Parameter Description: Minumum time between cruise missile launches.
DtRwString	myRangeName
	Name given to any range item associated with this descriptor.
Private Member Functions
	DtCruiseMissileLaunchControllerDescriptor ()
	default constructor -- not implemented.

---

Detailed Description

DtCruiseMissileLaunchControllerDescriptor; descriptor for the DtCruiseMissileLaunchController component.

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

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtCruiseMissileLaunchControllerDescriptor::~DtCruiseMissileLaunchControllerDescriptor

(

)

[virtual]

destructor

DtCruiseMissileLaunchControllerDescriptor::DtCruiseMissileLaunchControllerDescriptor

(

)

[private]

default constructor -- not implemented.

---

Member Function Documentation

DtCruiseMissileLaunchControllerDescriptor& DtCruiseMissileLaunchControllerDescriptor::operator=

(

const DtCruiseMissileLaunchControllerDescriptor &

orig

)

assignment

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

DtCruiseMissileLaunchControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtObjectType DtCruiseMissileLaunchControllerDescriptor::munitionType

(

)

const [virtual]

Accessor/mutator for myMunitionType.

virtual void DtCruiseMissileLaunchControllerDescriptor::setMunitionType

(

const DtObjectType &

objType

)

[virtual]

Accessor/mutator for myMunitionType.

virtual DtString DtCruiseMissileLaunchControllerDescriptor::munitionName

(

)

const [virtual]

Accessor/mutator for myMunitionName.

virtual void DtCruiseMissileLaunchControllerDescriptor::setMunitionName

(

const DtString &

name

)

[virtual]

Accessor/mutator for myMunitionName.

virtual DtVector DtCruiseMissileLaunchControllerDescriptor::launchOffset

(

)

const [virtual]

Accessor/mutator for myLaunchOffset.

virtual void DtCruiseMissileLaunchControllerDescriptor::setLaunchOffset

(

const DtVector &

offset

)

[virtual]

Accessor/mutator for myLaunchOffset.

virtual DtTaitBryan DtCruiseMissileLaunchControllerDescriptor::launchOrientation

(

)

const [virtual]

Accessor/mutator for myLaunchOrientation.

virtual void DtCruiseMissileLaunchControllerDescriptor::setLaunchOrientation

(

const DtTaitBryan &

orient

)

[virtual]

Accessor/mutator for myLaunchOrientation.

virtual DtReal DtCruiseMissileLaunchControllerDescriptor::minTimeBetweenLaunch

(

)

const [virtual]

Accessor/mutator for myMinTimeBetweenLaunch.

virtual void DtCruiseMissileLaunchControllerDescriptor::setMinTimeBetweenLaunch

(

DtReal

time

)

[virtual]

Accessor/mutator for myMinTimeBetweenLaunch.

virtual const DtString& DtCruiseMissileLaunchControllerDescriptor::rangeName

(

)

const [virtual]

Accessor/mutator for myRangeName.

virtual void DtCruiseMissileLaunchControllerDescriptor::setRangeName

(

const DtString &

rangeName

)

[virtual]

Accessor/mutator for myRangeName.

virtual DtComponentDescriptor* DtCruiseMissileLaunchControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

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

DtRwObjectType DtCruiseMissileLaunchControllerDescriptor::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 DtCruiseMissileLaunchControllerDescriptor::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 DtCruiseMissileLaunchControllerDescriptor::myLaunchOffset [protected]

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

Parameter Description: Offset from orgin 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

DtRwTaitBryan DtCruiseMissileLaunchControllerDescriptor::myLaunchOrientation [protected]

Parameter Name: launch-orientation
Parameter Description: //! Initial orientation (relative to the launching entity) for a newly created cruise missile.

Parameter Default Value: (0 0 0) (heading, pitch, roll)
Parameter Units: radians

DtRwReal DtCruiseMissileLaunchControllerDescriptor::myMinTimeBetweenLaunch [protected]

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

Parameter Default Value: 0.0
Parameter Units: seconds

DtRwString DtCruiseMissileLaunchControllerDescriptor::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/cruiseMisLaunchDesc.h