DtLaunchExpendableResourceControllerDescriptor Class Reference

DtLaunchExpendableResourceControllerDescriptor; descriptor for the DtLaunchExpendableResourceController component. More...

Inheritance diagram for DtLaunchExpendableResourceControllerDescriptor:

List of all members.

Public Member Functions
	DtLaunchExpendableResourceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtLaunchExpendableResourceControllerDescriptor (const DtLaunchExpendableResourceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtLaunchExpendableResourceControllerDescriptor &	operator= (const DtLaunchExpendableResourceControllerDescriptor &orig)
	assignment
virtual	~DtLaunchExpendableResourceControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	projectileStartSpeed () const
	Accessor/mutator for myProjectileStartSpeed.
virtual void	setProjectileStartSpeed (DtReal startSpeed)
	Accessor/mutator for myProjectileStartSpeed.
virtual DtVector	launcherOffset () const
	Accessor/mutator for myLauncherOffset.
virtual void	setLauncherOffset (const DtVector &offset)
	Accessor/mutator for myLauncherOffset.
virtual DtTaitBryan	launchOrientation () const
	Accessor/mutator for myLaunchOrientation.
virtual void	setLaunchOrientation (const DtTaitBryan &orient)
	Accessor/mutator for myLaunchOrientation.
virtual bool	autoLaunchEnabled () const
	Accessor/mutator for myAutoLaunchEnabled.
virtual void	setAutoLaunchEnabled (bool enable)
	Accessor/mutator for myAutoLaunchEnabled.
virtual const double	autoLaunchRange () const
	Accessor/mutator for myAutoLaunchRange.
virtual void	setAutoLaunchRange (const double range)
	Accessor/mutator for myAutoLaunchRange.
virtual const double	autoLaunchResetTime () const
	Accessor/mutator for myAutoLaunchResetTime.
virtual void	setAutoLaunchResetTime (const double time)
	Accessor/mutator for myAutoLaunchResetTime.
virtual const DtString &	autoLaunchResource () const
	Accessor/mutator for myAutoLaunchResource.
virtual void	setAutoLaunchResource (const DtString &Name)
	Accessor/mutator for myAutoLaunchResource.
virtual const int	autoLaunchResourceAmount () const
	Accessor/mutator for myAutoLaunchResourceAmount.
virtual void	setAutoLaunchResourceAmount (const int amount)
	Accessor/mutator for myAutoLaunchResourceAmount.
virtual const double	autoLaunchResourceInterval () const
	Accessor/mutator for myAutoLaunchResourceInterval.
virtual void	setAutoLaunchResourceInterval (const double interval)
	Accessor/mutator for myAutoLaunchResourceInterval.
virtual const DtAmmoSelectTable &	counterMeasuresSelectTable () const
	Accessor/mutator for myCMSelectTable.
virtual void	setCounterMeasuresSelectTable (const DtAmmoSelectTable &table)
	Accessor/mutator for myCMSelectTable.
virtual void	setCounterMeasuresSelectTableFilename (const DtString &filename)
	Accessor/mutator for myCMSelectTableFile.
virtual const DtString &	counterMeasuresSelectTableFilename ()
	Accessor/mutator for myCMSelectTableFile.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtLaunchExpendableResourceControllerDescriptor ()
	default constructor
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myAutoLaunchEnabled
	Parameter Name: auto-launch-enabled Parameter Description: When enabled the controller will check for the launch criteria currently just a range and if met will automatically launch the resource according to the default task.
DtRwReal	myAutoLaunchRange
	Parameter Name: auto-launch-range Parameter Description: Range within which the auto launcher will be triggered Parameter Default Value: 1500.0 Parameter Units: meters.
DtRwReal	myAutoLaunchResetTime
	Parameter Name: auto-launch-reset-time Parameter Description: Time between autolaunch tasks Parameter Default Value: 300.0 Parameter Units: seconds.
DtRwString	myAutoLaunchResource
	Parameter Name: auto-launch-default-resource Parameter Description: Name of resource to use in the auto launch task Parameter Default Value: Parameter Units:
DtRwInt	myAutoLaunchResourceAmount
	Parameter Name: auto-launch-number-of-resources Parameter Description: The default number of resources to launch per auto launch Parameter Default Value: 6 Parameter Units:
DtRwReal	myAutoLaunchResourceInterval
	Parameter Name: auto-launch-resource-interval Parameter Description: The default time between each resource being launched in the auto launch Parameter Default Value: 0.5 Parameter Units: seconds.
DtReaderWriterFile	myCMSelectTableFile
	Parameter Name: counter-measures-select-table-file Parameter Description: Filename used for the counter measures select table.
DtAmmoSelectTable	myCMSelectTable
	Parameter Name: counter-measures-select-table Parameter Description: Table that provides a list of counter measures that are appropriate for specific missile types.
DtRwReal	myProjectileStartSpeed
	Parameter Name: projectile-start-speed Parameter Description: Used in calculating the projectile velocity vector for the fire PDU and in determining flyout time.
DtRwVector	myLauncherOffset
	Parameter Name: launcher-offset Offset from orgin of launch vehicle where the resource object will be created.
DtRwTaitBryan	myLaunchOrientation
	Parameter Name: launch-orientation Parameter Description: //! Initial orientation (relative to the launching entity) for a newly created cruise missile.

---

Detailed Description

DtLaunchExpendableResourceControllerDescriptor; descriptor for the DtLaunchExpendableResourceController component.

DtLaunchExpendableResourceControllerDescriptor is a DtComponentDescriptor that has additional information needed for providing parameters to a LaunchExpendableResource controller. It provides the launcher offset from the entity's center,it's orientation with respect to the entity, and the starting speed for the resource being launched. It also allows the user to enable the system to automatically launch resources based on a range. The controller's autoLauncherTriggered uses this range to evaluate if an auto launch should occur. In here the user specifies the auto launch task--Resource to launch, how many, and time interval between launches.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtLaunchExpendableResourceControllerDescriptor::~DtLaunchExpendableResourceControllerDescriptor

(

)

[virtual]

destructor

DtLaunchExpendableResourceControllerDescriptor::DtLaunchExpendableResourceControllerDescriptor

(

)

[protected]

default constructor

---

Member Function Documentation

DtLaunchExpendableResourceControllerDescriptor& DtLaunchExpendableResourceControllerDescriptor::operator=

(

const DtLaunchExpendableResourceControllerDescriptor &

orig

)

assignment

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

DtLaunchExpendableResourceControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtLaunchExpendableResourceControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

virtual DtReal DtLaunchExpendableResourceControllerDescriptor::projectileStartSpeed

(

)

const [virtual]

Accessor/mutator for myProjectileStartSpeed.

virtual void DtLaunchExpendableResourceControllerDescriptor::setProjectileStartSpeed

(

DtReal

startSpeed

)

[virtual]

Accessor/mutator for myProjectileStartSpeed.

virtual DtVector DtLaunchExpendableResourceControllerDescriptor::launcherOffset

(

)

const [virtual]

Accessor/mutator for myLauncherOffset.

virtual void DtLaunchExpendableResourceControllerDescriptor::setLauncherOffset

(

const DtVector &

offset

)

[virtual]

Accessor/mutator for myLauncherOffset.

virtual DtTaitBryan DtLaunchExpendableResourceControllerDescriptor::launchOrientation

(

)

const [virtual]

Accessor/mutator for myLaunchOrientation.

virtual void DtLaunchExpendableResourceControllerDescriptor::setLaunchOrientation

(

const DtTaitBryan &

orient

)

[virtual]

Accessor/mutator for myLaunchOrientation.

virtual bool DtLaunchExpendableResourceControllerDescriptor::autoLaunchEnabled

(

)

const [virtual]

Accessor/mutator for myAutoLaunchEnabled.

virtual void DtLaunchExpendableResourceControllerDescriptor::setAutoLaunchEnabled

(

bool

enable

)

[virtual]

Accessor/mutator for myAutoLaunchEnabled.

virtual const double DtLaunchExpendableResourceControllerDescriptor::autoLaunchRange

(

)

const [virtual]

Accessor/mutator for myAutoLaunchRange.

virtual void DtLaunchExpendableResourceControllerDescriptor::setAutoLaunchRange

(

const double

range

)

[virtual]

Accessor/mutator for myAutoLaunchRange.

virtual const double DtLaunchExpendableResourceControllerDescriptor::autoLaunchResetTime

(

)

const [virtual]

Accessor/mutator for myAutoLaunchResetTime.

virtual void DtLaunchExpendableResourceControllerDescriptor::setAutoLaunchResetTime

(

const double

time

)

[virtual]

Accessor/mutator for myAutoLaunchResetTime.

virtual const DtString& DtLaunchExpendableResourceControllerDescriptor::autoLaunchResource

(

)

const [virtual]

Accessor/mutator for myAutoLaunchResource.

virtual void DtLaunchExpendableResourceControllerDescriptor::setAutoLaunchResource

(

const DtString &

Name

)

[virtual]

Accessor/mutator for myAutoLaunchResource.

virtual const int DtLaunchExpendableResourceControllerDescriptor::autoLaunchResourceAmount

(

)

const [virtual]

Accessor/mutator for myAutoLaunchResourceAmount.

virtual void DtLaunchExpendableResourceControllerDescriptor::setAutoLaunchResourceAmount

(

const int

amount

)

[virtual]

Accessor/mutator for myAutoLaunchResourceAmount.

virtual const double DtLaunchExpendableResourceControllerDescriptor::autoLaunchResourceInterval

(

)

const [virtual]

Accessor/mutator for myAutoLaunchResourceInterval.

virtual void DtLaunchExpendableResourceControllerDescriptor::setAutoLaunchResourceInterval

(

const double

interval

)

[virtual]

Accessor/mutator for myAutoLaunchResourceInterval.

virtual const DtAmmoSelectTable& DtLaunchExpendableResourceControllerDescriptor::counterMeasuresSelectTable

(

)

const [virtual]

Accessor/mutator for myCMSelectTable.

virtual void DtLaunchExpendableResourceControllerDescriptor::setCounterMeasuresSelectTable

(

const DtAmmoSelectTable &

table

)

[virtual]

Accessor/mutator for myCMSelectTable.

virtual void DtLaunchExpendableResourceControllerDescriptor::setCounterMeasuresSelectTableFilename

(

const DtString &

filename

)

[virtual]

Accessor/mutator for myCMSelectTableFile.

virtual const DtString& DtLaunchExpendableResourceControllerDescriptor::counterMeasuresSelectTableFilename

(

)

[virtual]

Accessor/mutator for myCMSelectTableFile.

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

DtRwBoolean DtLaunchExpendableResourceControllerDescriptor::myAutoLaunchEnabled [protected]

Parameter Name: auto-launch-enabled
Parameter Description: When enabled the controller will check for the launch criteria currently just a range and if met will automatically launch the resource according to the default task.

Parameter Default Value: True
Parameter Units:

DtRwReal DtLaunchExpendableResourceControllerDescriptor::myAutoLaunchRange [protected]

Parameter Name: auto-launch-range
Parameter Description: Range within which the auto launcher will be triggered
Parameter Default Value: 1500.0
Parameter Units: meters.

DtRwReal DtLaunchExpendableResourceControllerDescriptor::myAutoLaunchResetTime [protected]

Parameter Name: auto-launch-reset-time
Parameter Description: Time between autolaunch tasks
Parameter Default Value: 300.0
Parameter Units: seconds.

DtRwString DtLaunchExpendableResourceControllerDescriptor::myAutoLaunchResource [protected]

Parameter Name: auto-launch-default-resource
Parameter Description: Name of resource to use in the auto launch task
Parameter Default Value:
Parameter Units:

DtRwInt DtLaunchExpendableResourceControllerDescriptor::myAutoLaunchResourceAmount [protected]

Parameter Name: auto-launch-number-of-resources
Parameter Description: The default number of resources to launch per auto launch
Parameter Default Value: 6
Parameter Units:

DtRwReal DtLaunchExpendableResourceControllerDescriptor::myAutoLaunchResourceInterval [protected]

Parameter Name: auto-launch-resource-interval
Parameter Description: The default time between each resource being launched in the auto launch
Parameter Default Value: 0.5
Parameter Units: seconds.

DtReaderWriterFile DtLaunchExpendableResourceControllerDescriptor::myCMSelectTableFile [protected]

Parameter Name: counter-measures-select-table-file
Parameter Description: Filename used for the counter measures select table.

Parameter Default Value:

DtAmmoSelectTable DtLaunchExpendableResourceControllerDescriptor::myCMSelectTable [protected]

Parameter Name: counter-measures-select-table
Parameter Description: Table that provides a list of counter measures that are appropriate for specific missile types.

Parameter Default Value:

DtRwReal DtLaunchExpendableResourceControllerDescriptor::myProjectileStartSpeed [protected]

Parameter Name: projectile-start-speed
Parameter Description: Used in calculating the projectile velocity vector for the fire PDU and in determining flyout time.

Parameter Default Value: 0.
Parameter Units: meters/second

DtRwVector DtLaunchExpendableResourceControllerDescriptor::myLauncherOffset [protected]

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

Parameter Description: Offset from orgin of launch vehicle where the missile will be created, in body coordinates of the launch vehicle. In a body coordinate system, the axes are specified as follows:

• x-axis points out of the 'front' of the object
  
• y-axis points out of the 'side' of the object
  
• z-axis points out of the 'bottom' of the object
  Parameter Default Value: (0.0 0.0 0.0) (x, y, z)
  Parameter Units: meters

DtRwTaitBryan DtLaunchExpendableResourceControllerDescriptor::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

---

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

• include/vrfobjparam/launchExpendableResourceCtlrDesc.h