![]() |
VR-Forces 4.2 Class Documentation
|
DtLaunchExpendableResourceControllerDescriptor; descriptor for the DtLaunchExpendableResourceController component. More...

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. | |
Public Member Functions inherited from DtComponentDescriptor | |
| DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtComponentDescriptor & | operator= (const DtComponentDescriptor &orig) |
| assignment | |
| virtual | ~DtComponentDescriptor () |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| Overrides base class putData to output our type. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actually stored. | |
| virtual bool | init () |
| Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. | |
| bool | operator== (const DtComponentDescriptor &) const |
| DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual void | setComponentType (const DtString &componentType) |
| Type of DtSimComponent this descriptor is associated with. | |
| virtual const DtString & | componentType () const |
| Type of DtSimComponent this descriptor is associated with. | |
| virtual void | setMinTickPeriod (DtReal minTickPeriod) |
| virtual DtReal | minTickPeriod () const |
| virtual void | setMinTickPeriodVariance (DtReal minTickPeriodVariance) |
| virtual DtReal | minTickPeriodVariance () const |
| virtual void | setTickPeriodUsesRealTime (bool value) |
| Accessor/mutator for myTickPeriodUsesRealTime. | |
| virtual bool | tickPeriodUsesRealTime () const |
| Accessor/mutator for myTickPeriodUsesRealTime. | |
| virtual const DtString & | processStateRepositoryName () const |
| Name which this component will assign to its PSR. | |
| virtual void | setProcessStateRepositoryName (const DtString &name) |
| Name which this component will assign to its PSR. | |
| virtual const DtString & | processStateRepositoryType () const |
| Type of PSR this component will create. | |
| virtual void | setProcessStateRepositoryType (const DtString &type) |
| Type of PSR this component will create. | |
| virtual void | setIsEnabled (bool yesNo) |
| Is the component enabled or not. | |
| virtual bool | isEnabled () const |
| Is the component enabled or not. | |
| virtual void | setDebugActive (bool active) |
| Should detailed debug info be printed for this component. | |
| virtual bool | debugActive () |
| Should detailed debug info be printed for this component. | |
| virtual void | setCreateComponent (bool yesNo) |
| Should the component be created or not. | |
| virtual bool | createComponent () const |
| Should the component be created or not. | |
Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| virtual bool | isReadonly () const |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. | |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| Returns true if this variable has a child p in it's chain. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| The specified flags are used for optional values. | |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| The variable name, if this object is a variable reference. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Static Public Member Functions | |
| static DtComponentDescriptor * | creator () |
| | |
Static Public Member Functions inherited from DtComponentDescriptor | |
| static void | addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn) |
| Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory. | |
| static DtComponentDescriptor * | createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e. | |
| static DtComponentDescriptor * | createComponentDescriptor (const char *pName) |
| Creates and initializes a new instance of this class. | |
| static DtComponentDescriptorFactory * | factory () |
| The factory for creating objects of type DtComponentDescriptor. | |
| static void | setFactory (DtComponentDescriptorFactory *factory) |
| The factory for creating objects of type DtComponentDescriptor. | |
Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (FILE *fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
Protected Member Functions | |
| DtLaunchExpendableResourceControllerDescriptor () | |
| default constructor | |
Protected Member Functions inherited from DtComponentDescriptor | |
| DtComponentDescriptor () | |
| default constructor; not implemented | |
Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| Checks to see if this RW object is a variable reference that can be bound using the provided bindings. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
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. | |
Protected Attributes inherited from DtComponentDescriptor | |
| DtRwBoolean | myIsEnabled |
| DtRwBoolean | myDebug |
| This parameter defaults to false. | |
| DtRwBoolean | myCreateComponent |
| DtRwString | myComponentType |
| Parameter Name: component-type Parameter Description: String identifying type of component. | |
| DtRwReal | myMinTickPeriod |
| Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component. | |
| DtRwReal | myMinTickPeriodVariance |
| Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component. | |
| DtRwBoolean | myTickPeriodUsesRealTime |
| Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time. | |
| DtRwString | myProcessStateRepositoryName |
| Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component. | |
| DtRwString | myProcessStateRepositoryType |
| Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component. | |
Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| aliasContainer | myAliases |
| Container for the aliases which represent alternative names for the object. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
Additional Inherited Members | |
Public Types inherited from DtReaderWriter | |
| typedef std::vector < DtSymbolString > | aliasContainer |
| typedef std::vector < DtSymbolString >::iterator | aliasIter |
| typedef std::vector < DtSymbolString > ::const_iterator | aliasConstIter |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
Static Protected Attributes inherited from DtComponentDescriptor | |
| static DtComponentDescriptorFactory * | myFactory |
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.
| DtLaunchExpendableResourceControllerDescriptor::DtLaunchExpendableResourceControllerDescriptor | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtLaunchExpendableResourceControllerDescriptor::DtLaunchExpendableResourceControllerDescriptor | ( | const DtLaunchExpendableResourceControllerDescriptor & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
|
protected |
default constructor
| DtLaunchExpendableResourceControllerDescriptor& DtLaunchExpendableResourceControllerDescriptor::operator= | ( | const DtLaunchExpendableResourceControllerDescriptor & | orig | ) |
assignment
|
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.
Reimplemented from DtComponentDescriptor.
|
virtual |
Reimplemented from DtComponentDescriptor.
|
virtual |
Accessor/mutator for myProjectileStartSpeed.
|
virtual |
Accessor/mutator for myProjectileStartSpeed.
|
virtual |
Accessor/mutator for myLauncherOffset.
|
virtual |
Accessor/mutator for myLauncherOffset.
|
virtual |
Accessor/mutator for myLaunchOrientation.
|
virtual |
Accessor/mutator for myLaunchOrientation.
|
virtual |
Accessor/mutator for myAutoLaunchEnabled.
|
virtual |
Accessor/mutator for myAutoLaunchEnabled.
|
virtual |
Accessor/mutator for myAutoLaunchRange.
|
virtual |
Accessor/mutator for myAutoLaunchRange.
|
virtual |
Accessor/mutator for myAutoLaunchResetTime.
|
virtual |
Accessor/mutator for myAutoLaunchResetTime.
|
virtual |
Accessor/mutator for myAutoLaunchResource.
|
virtual |
Accessor/mutator for myAutoLaunchResource.
|
virtual |
Accessor/mutator for myAutoLaunchResourceAmount.
|
virtual |
Accessor/mutator for myAutoLaunchResourceAmount.
|
virtual |
Accessor/mutator for myAutoLaunchResourceInterval.
|
virtual |
Accessor/mutator for myAutoLaunchResourceInterval.
|
virtual |
Accessor/mutator for myCMSelectTable.
|
virtual |
Accessor/mutator for myCMSelectTable.
|
virtual |
Accessor/mutator for myCMSelectTableFile.
|
virtual |
Accessor/mutator for myCMSelectTableFile.
|
static |
Reimplemented from DtComponentDescriptor.
|
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:
|
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.
|
protected |
Parameter Name: auto-launch-reset-time
Parameter Description: Time between autolaunch tasks
Parameter Default Value: 300.0
Parameter Units: seconds.
|
protected |
Parameter Name: auto-launch-default-resource
Parameter Description: Name of resource to use in the auto launch task
Parameter Default Value:
Parameter Units:
|
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:
|
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.
|
protected |
Parameter Name: counter-measures-select-table-file
Parameter Description: Filename used for the counter measures select table.
Parameter Default Value:
|
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:
|
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
|
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:
|
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