![]() |
VR-Forces 4.3.1 Class Documentation
|
DtFixedWingGunneryControllerDescriptor, descriptor for the DtFixedWingGunneryController component. More...

Public Member Functions | |
| DtFixedWingGunneryControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| constructor | |
| DtFixedWingGunneryControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtFixedWingGunneryControllerDescriptor (const DtFixedWingGunneryControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtFixedWingGunneryControllerDescriptor & | operator= (const DtFixedWingGunneryControllerDescriptor &orig) |
| assignment | |
| virtual | ~DtFixedWingGunneryControllerDescriptor () |
| destructor | |
| virtual DtString | type () const |
| Returns the type of component this descriptor describes. | |
| virtual DtComponentDescriptor * | clone (DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual bool | checkLOS () const |
| Accessor/mutator for myCheckLOS. | |
| virtual void | setCheckLOS (bool checkLOSFlag) |
| Accessor/mutator for myCheckLOS. | |
| virtual double | maxAlignmentAngle () const |
| Accessor/mutator for myMaxAlignmentAngle. | |
| virtual void | setMaxAlightmentAngle (double angle) |
| Accessor/mutator for myMaxAlignmentAngle. | |
| virtual double | entryAltitude () const |
| Accessor/mutator for myEntryAltitude. | |
| virtual void | setEntryAltitude (const double agl) |
| Accessor/mutator for myEntryAltitude. | |
| virtual double | entryAirspeed () const |
| Accessor/mutator for myEntryAirspeed. | |
| virtual void | setEntryAirspeed (const double speed) |
| Accessor/mutator for myEntryAirspeed. | |
| virtual double | diveAngle () const |
| Accessor/mutator for myDiveAngle. | |
| virtual void | setDiveAngle (const double angle) |
| Accessor/mutator for myDiveAngle. | |
| virtual double | strafeRange () const |
| Accessor/mutator for myStrafeRange. | |
| virtual void | setStrafeRange (const double range) |
| Accessor/mutator for myStrafeRange. | |
| virtual double | aaEngageRange () const |
| Accessor/mutator for myAaEngageRange. | |
| virtual void | setAaEngageRange (const double range) |
| Accessor/mutator for myAaEngageRange. | |
| virtual double | aaBreakoffRange () const |
| Accessor/mutator for myAaBreakoffRange. | |
| virtual void | setAaBreakoffRange (const double range) |
| Accessor/mutator for myAaBreakoffRange. | |
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 DtReaderWriter::SearchPaths &searchPaths, 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 () const |
| 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) | |
| pseudo-copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| 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 | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| 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 void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op. | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. | |
| 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 const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| std::string | debugText () const |
| 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 bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. | |
| 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 void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
| 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. | |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual DtReaderWriter * | defaultRWValue () |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restires object from given xml file. | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. | |
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 DtReaderWriter::SearchPaths &searchPaths, 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 char * | theXmlType () |
| The type that is used when archiving to an XML stream. | |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &) |
| Given a filename, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromXml (const DtString &) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. | |
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter > | |
| static DtObjectCounter::CounterType | ObjectCount () |
| static const DtObjectContainer * | ObjectContainer () |
Protected Member Functions | |
| DtFixedWingGunneryControllerDescriptor () | |
| default constructor; not implemented | |
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. | |
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter > | |
| DtObjectDebugger () | |
| DtObjectDebugger (const DtObjectDebugger &) | |
| ~DtObjectDebugger () | |
Protected Attributes | |
parameters | |
These parameters are available for setting in the OPD files. | |
| DtRwBoolean | myCheckLOS |
| Parameter Name: check-LOS Parameter Description: Determines whether any checks are done to see if the target is visible each tick. | |
| DtRwReal | myMaxAlignmentAngle |
| Parameter Name: max-alignment-angle Parameter Description: The maximum angle that between the gun bore sight and the direction to the target which will be considered aligned with the the target. | |
| DtRwReal | myEntryAltitude |
| Parameter Name: entry-altitude Parameter Description: The altitude (AGL) at which to begin a strafing attack. | |
| DtRwReal | myEntryAirspeed |
| Parameter Name: entry-airspeed Parameter Description: The airspeed at which to begin the strafing attack. | |
| DtRwReal | myDiveAngle |
| Parameter Name: dive-angle Parameter Description: The angle at which to perform a strafing attack. | |
| DtRwReal | myStrafeRange |
| Parameter Name: strafe-range Parameter Description: The range from the target at which to begin the strafing attack. | |
| DtRwReal | myAaEngageRange |
| Parameter Name: aa-engage-range Parameter Description: The (maximum) range at which to engage another aircraft with guns. | |
| DtRwReal | myAaBreakoffRange |
| Parameter Name: aa-breakoff-range Parameter Description: The (minimum) range below which a aerial gun attack is broken off. | |
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: Average tick period for this component. | |
| DtRwReal | myMinTickPeriodVariance |
| Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period. | |
| DtRwBoolean | myTickPeriodUsesRealTime |
| Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick. | |
| 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 |
| DtReaderWriterRegistry * | myParentRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| DtReaderWriter * | myDefaultValue |
| 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::vector< DtFilename > | SearchPaths |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
Static Protected Attributes inherited from DtComponentDescriptor | |
| static DtComponentDescriptorFactory * | myFactory |
DtFixedWingGunneryControllerDescriptor, descriptor for the DtFixedWingGunneryController component.
A DtComponentDescriptor that has parameter information needed the fixed wing gunnery controller, which controls strafing and aerial gun combat.
| DtFixedWingGunneryControllerDescriptor::DtFixedWingGunneryControllerDescriptor | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
constructor
| DtFixedWingGunneryControllerDescriptor::DtFixedWingGunneryControllerDescriptor | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
| DtFixedWingGunneryControllerDescriptor::DtFixedWingGunneryControllerDescriptor | ( | const DtFixedWingGunneryControllerDescriptor & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
|
virtual |
destructor
|
protected |
default constructor; not implemented
| DtFixedWingGunneryControllerDescriptor& DtFixedWingGunneryControllerDescriptor::operator= | ( | const DtFixedWingGunneryControllerDescriptor & | 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 myCheckLOS.
|
virtual |
Accessor/mutator for myCheckLOS.
|
virtual |
Accessor/mutator for myMaxAlignmentAngle.
|
virtual |
Accessor/mutator for myMaxAlignmentAngle.
|
virtual |
Accessor/mutator for myEntryAltitude.
|
virtual |
Accessor/mutator for myEntryAltitude.
|
virtual |
Accessor/mutator for myEntryAirspeed.
|
virtual |
Accessor/mutator for myEntryAirspeed.
|
virtual |
Accessor/mutator for myDiveAngle.
Dive angle is in radians, and a positive angle is a pitch down.
|
virtual |
Accessor/mutator for myDiveAngle.
Dive angle is in radians, and a positive angle is a pitch down.
|
virtual |
Accessor/mutator for myStrafeRange.
|
virtual |
Accessor/mutator for myStrafeRange.
|
virtual |
Accessor/mutator for myAaEngageRange.
|
virtual |
Accessor/mutator for myAaEngageRange.
|
virtual |
Accessor/mutator for myAaBreakoffRange.
|
virtual |
Accessor/mutator for myAaBreakoffRange.
|
static |
Reimplemented from DtComponentDescriptor.
|
protected |
Parameter Name: check-LOS
Parameter Description: Determines whether any checks are done to see if the target is visible each tick.
If false, any target that is provided on the input port is assumed to be trackable and visible.
Parameter Default Value: True.
|
protected |
Parameter Name: max-alignment-angle
Parameter Description: The maximum angle that between the gun bore sight and the direction to the target which will be considered aligned with the the target.
The gun system will only fire when the gun is aligned with the target.
Parameter Default Value: 0.15
Parameter Units: Radians.
|
protected |
Parameter Name: entry-altitude
Parameter Description: The altitude (AGL) at which to begin a strafing attack.
Parameter Default Value: 500.0
Parameter Units: meters
|
protected |
Parameter Name: entry-airspeed
Parameter Description: The airspeed at which to begin the strafing attack.
Parameter Default Value: 120.0
Parameter Units: meters-per-second
|
protected |
Parameter Name: dive-angle
Parameter Description: The angle at which to perform a strafing attack.
A positive value; always indicates a pitch down.
Parameter Default Value: 0.44
Parameter Units: radians
|
protected |
Parameter Name: strafe-range
Parameter Description: The range from the target at which to begin the strafing attack.
Parameter Default Value: 1000.0
Parameter Units: meters
|
protected |
Parameter Name: aa-engage-range
Parameter Description: The (maximum) range at which to engage another aircraft with guns.
Parameter Default Value: 1000.0
Parameter Units: meters
|
protected |
Parameter Name: aa-breakoff-range
Parameter Description: The (minimum) range below which a aerial gun attack is broken off.
Parameter Default Value: 100.0
Parameter Units: meters