VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtFixedWingActuatorComponent Class Reference

DtFixedWingActuatorComponent provides a simple, kinematics-based model for air motion based on throttle, stick, and pedal inputs. More...

Inheritance diagram for DtFixedWingActuatorComponent:
Inheritance graph
[legend]

Public Member Functions

 DtFixedWingActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtFixedWingActuatorComponent ()
 destructor Removes process state from process state manager before deleting it.
virtual bool init ()
 to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports.
virtual const chartype () const
 Returns a string identifies the class type of component.
virtual void tick ()
 Calls either doFlying or doTaxiing, based on a onGround() call to myFixedWingEntityState.
virtual void calculateBodyVelocity (const DtVector &oldRelativeVelocity, const DtDcm &newLocalOrientation, DtVector &newBodyVelocity)
 Put current velocity into body coordinates (AFTER rotating body).
virtual void calculateAirborneAcceleration (const DtVector oldLocalPosition, double oldSpeed, const DtDcm &newLocalOrientation, const DtVector &newBodyVelocity, double throttle, DtVector &newRelativeAcceleration)
 Calculates the sum acceleration from myBodyGravity, myBodyDrag and myBodyThrust.
- Public Member Functions inherited from DtActuatorComponent
virtual ~DtActuatorComponent ()
 destructor
virtual DtSimRadioradio ()
virtual bool tickWhileDestroyed () const
 By default, all actuators tick when the entity is destroyed.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time.
virtual void postTick ()
 This function is called immediately after tick() is called.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
virtual DtListItem * listItem ()
virtual void putData (std::string &fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
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 actual stored.
virtual void addInputPort (DtInputPort *port)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPort (DtInputPort *port)
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name.
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component.
virtual void addOutputPort (DtOutputPort *port)
 Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void removeOutputPort (DtOutputPort *port)
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name.
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component.
virtual void addInputPortGroup (DtInputPortGroup *group)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name.
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component.
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name.
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component.
virtual int priority () const
 Return the current connection priority for this component.
virtual void setPriority (int priority)
 Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void setDT (double deltaT)
 Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const
DtComponentDescriptor
componentDescriptor () const
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_SystemcoordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component.
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component.
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component.
virtual bool isThreadSafe () const
 Returns true if this component is marked as being thread safe.
virtual void addVRLinkDeferredJob (const boost::function< void()> &callback)
 Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe.
virtual void onRestore ()
 Called whenever a component is restored. Default is no-op.
virtual void enable ()
 Is this component enabled or not.
virtual void disable ()
virtual bool isEnabled ()
virtual void setIsEnabled (bool yesNo)
virtual DtOutputStream & objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream & objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream & objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream & objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream & objectConsoleError (const DtString &channel="") const
virtual DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () const
- 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 DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (std::string &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 (std::string &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 void addAlias (const DtString &alias)
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () 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 bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called.
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
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)
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
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 &)
 Restores 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 DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

virtual void doFlying ()
 When the plane is in the air, this does the actual flying.
virtual void doTaxiing ()
 When the FWE is on the ground, this does the actual taxiing.
virtual bool isTouchingDown (const DtVector &newLocalPosition, const DtVector &newRelativeVelocity)
 Returns true of false depending on whether the aircraft is currently landing or not.
virtual bool isTakingOff (bool isOnGround, double speed)
 Returns true of false depending on whether the aircraft is currently taking off or not.
virtual bool updateGroundInteractionPoints (DtGroundInteractionPt *left, DtGroundInteractionPt *right, DtGroundInteractionPt *nose, DtGroundInteractionPt *center, const DtDcm &localOrientation, const DtVector &localPosition, double halfHeightOfTerrainIntersectChord)
virtual double calculateYawRate (double pedal)
 These functions are for when the FWEs are in the AIR.
virtual double calculatePitchRate (double stickYValue)
 Find pitch rate.
virtual double calculateRollRate (double stickXValue)
 Find roll rate.
virtual void calculateBodyRotationRates (double pedal, double stickXValue, double stickYValue, DtVector &newBodyRotationRates)
virtual void calculateOrientation (const DtDcm &oldLocalOrientation, const DtVector &newBodyRotationRates, DtDcm &newLocalOrientation)
 Uses current local orientation, rotationRates in SR, and dT.
virtual void calculateBodyGravity (const DtVector oldLocalPosition, const DtDcm &newLocalOrientation, DtVector &newBodyGravityAcceleration)
 Put acceleration due to gravity in body coordinates.
virtual void calculateThrustAcceleration (double throttle, DtVector &newBodyThrustAccleration)
 Calculate scalar accel in direction of thrust based on the throttle port and the maximum thrust, and store the value in myBodyThrust[0].
virtual void calculateDragAcceleration (double oldSpeed, const DtVector &newBodyVelocity, bool flapsDeployed, DtVector &newBodyDragAccleration)
 Calculate scalar drag accel opposite direction of current velocity.
virtual void fallFromSky (const DtString &reason=DtString::nullString())
 Causes the entity to fall from the sky.
virtual bool collidesWithGround (const DtVector &oldLocalPosition, const DtVector &newLocalPosition, DtVector &localCenterGoundPosition)
void integrate (const DtVector &oldLocalPosition, const DtVector &oldRelativeVelocity, const DtVector &newRelativeAcceleration, DtVector &newLocalPosition, DtVector &newRelativeVelocity, double maxSpeed=0)
 Integrates myRelativeVelocity and myLocalPosition.
virtual void useFuel (double fuelUsed)
 Assumes the fuel resource has resource name "fuel" If not found, fuel consumption not will not be modeled.
virtual double fuelLeft () const
virtual double fullMass () const
 Mass when fuel tank is full.
virtual double currentMass () const
 Calculates the current mass of the aircraft including fuel.
virtual void updateRepository (const DtVector &newLocalPosition, const DtVector &newRelativeVelocity, const DtVector &newRelativeAcceleration, const DtDcm &newLocalOrientation, const DtVector &newBodyRotationRates, bool isOnGround, const DtAppearance &newAppearance)
virtual void updateDisplay () const
virtual double maxThrustAcceleration () const
 These accessors to the actuator's parameters are provided for use by the controllers that must control it.
virtual double maxClimbRate () const
virtual double maxYawVelocity () const
virtual double maxPitchVelocity () const
virtual double maxRollVelocity () const
virtual double maxAltitude () const
virtual bool createPortGroups ()
 Creates the local port groups.
virtual bool createPorts ()
 Creates the input ports and adds them to the component.
virtual bool createPSR ()
 Creates myProcessState data member, and adds it to our process state repository manager.
virtual bool createFuelConsumptionModel ()
 Creates the fuel consumption model.
virtual void sendDetonation (const DtVector &geocentricPosition)
virtual void forceSpatialUpdate ()
 Forces a network update of all aircraft spatial data.
virtual void initializeSpatialAttributeList ()
 Initializes the list of attributes that are part of a spatial update.
 DtFixedWingActuatorComponent ()
 default constructor; not implemented
 DtFixedWingActuatorComponent (const DtFixedWingActuatorComponent &orig)
 copy constructor; not implemented
const
DtFixedWingActuatorComponent
operator= (const DtFixedWingActuatorComponent &orig)
 assignment operator; not implemented
virtual double calculateHeading (double oldHeading, double steering, double dT, double speed, double turningRadius)
 These functions are for when the FWEs are on the GROUND.
virtual void calculateScalarVelocityAndAcceleration (double oldPitch, double &scalarVelocity, double &scalarAcceleration)
 Computes the speed and acceleration for this tick, i.e. to publish.
virtual double calculateMaxGroundSpeed ()
virtual double calculateMaxGroundAcceleration ()
virtual double calculateAcceleration (double pitch, double maxSpeed, double maxAccel, double newSpeed)
 Calculate the acceleration based on the speed now (i.e., updated from last tick's speed using last tick's acceleration) and the max speed and accel limits.
virtual double calculateAccelerationFromThrottle ()
virtual double calculateAccelerationFromSlope (double slope)
 Slope is rise over run, i.e. tan(pitch)
virtual double calculateAccelerationFromResistance (double maxSpeed, double maxAccel)
virtual double calculateAccelerationFromBrake (double otherAccels)
virtual DtVector calculateProjectedLocation (const DtVector &oldLocalPosition, const DtVector &newBodyAcceleration, const DtVector &oldBodyVelocity, double newHeading)
virtual void calculateOrientationAndPositionOnGround (const DtVector &newLocalProjectedLocation, double newHeading, DtDcm &newLocalOrientation, DtVector &newLocalPosition)
- Protected Member Functions inherited from DtActuatorComponent
 DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual void setRadio (DtSimRadio *radio)
 DtActuatorComponent ()
 Default constructor; should not be called.
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT.
bool testInvariant () const
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager.
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick.
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component.
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name.
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Protected Attributes

DtFixedWingEntityStateRepositorymyFixedWingEntityState
DtFixedWingActuatorDescriptormyFixedWingActuatorDescriptor
DtAircraftFuelConsumptionModelmyFuelConsumptionModel
DtFixedWingFlightPSRmyProcessState
 Container for state data associated with this component.
bool mySentFallingMessage
 Used to make sure fall message is only sent once.
bool myPutTaxiingPlaneOnGround
 Used to make sure a taxiing, destroyed aircraft is only set down on the terrain once.
DtUpdateRepositoryOutputPortGroupmyUpdateRepositoryOutputPortGroup
 Port group used to set what values should be set into the VRF state repository.
bool myPreviouslyHadData
bool myKeepParentPosition
RTI::AttributeHandleSet * mySpatialAttributes
 Set of HLA object attributes that contain the spatial data for this aircraft.
Ports and Port Groups
DtInputPortGroupmyFixedWingControlPortGroup
 Input Port Group Name: fixed-wing-control
Input Port Group Description: Provides input to the fixed-wing actuator (flight-kinematics).
DtConstrainedAnalogInputPortmyThrottlePort
 Input Port Name: throttle
Input Port Description:
Input Port Range: 0.
DtConstrainedDualAxisAnalogInputPortmyStickPort
 Input Port Name: stick
Input Port Description:
Input Port Range: X:-1.
DtConstrainedAnalogInputPortmyPedalPort
 Input Port Name: pedal
Input Port Description:
Input Port Range: -1.
DtConstrainedAnalogInputPortmyBrakePort
 Input Port Name: brake
Input Port Description:
Input Port Range: 0.
DtBooleanInputPortmyFlapsDeployedPort
 Input Port Name: flaps
Input Port Description:
Input Port Range:
Input Port Default Value: false
Input Group Parent: fixed-wing-control.
- Protected Attributes inherited from DtActuatorComponent
DtSimRadiomyRadio
 Actuators can send messages.
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
DtVrfObjectStateRepositorymyLocalStateRepository
DtSimManagermySimManager
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs.
DtListItem * myListItem
DtInputPortMap myInputPortList
DtOutputPortMap myOutputPortList
DtInputPortGroupMap myInputPortGroupList
DtOutputPortGroupMap myOutputPortGroupList
int myPriority
double myMinTickPeriod
double myMinTickPeriodVariance
double myNextTickTime
double myLastTickSimTime
double myDT
bool myIsEnabled
 Indicates whether this component should be enabled for ticking or not.
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick.
bool myIsThreadSafe
 Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false.
const DtComponentDescriptormyComponentDescriptor
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed.
bool myTickEveryFrame
 Flag indicating that tickPeriod is set to 0, and the component will tick every frame.
DtTaskVisualizationMap myTaskVisualizations
 The visualization objects to be drawn for this component.
double myNextTaskVisTickTime
 The next tick time for updating the task visualizations.
__itt_string_handlemyTickITTStringHandle
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
DtReaderWriterRegistrymyParentRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
DtReaderWritermyDefaultValue
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.
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 )()
- Protected Types inherited from DtSimComponent
typedef std::map< DtString,
DtInputPort * > 
DtInputPortMap
typedef std::map< DtString,
DtOutputPort * > 
DtOutputPortMap
typedef std::map< DtString,
DtInputPortGroup * > 
DtInputPortGroupMap
typedef std::map< DtString,
DtOutputPortGroup * > 
DtOutputPortGroupMap
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

DtFixedWingActuatorComponent provides a simple, kinematics-based model for air motion based on throttle, stick, and pedal inputs.

End User Description: DtFixedWingActuatorComponent is based on the original DtFixedWingActuatorComponent, but instead of stick and pedal control values causing changes in rotational acceleration, in this simplified model they effect changes in rotational velocity instead. So 0 x/y stick and 0 pedal will result in no rotation of the airframe.

Uses Descriptor Type: DtComponentDescriptor

Constructor & Destructor Documentation

DtFixedWingActuatorComponent::DtFixedWingActuatorComponent ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtFixedWingActuatorComponent::~DtFixedWingActuatorComponent ( )
virtual

destructor Removes process state from process state manager before deleting it.

DtFixedWingActuatorComponent::DtFixedWingActuatorComponent ( )
protected

default constructor; not implemented

DtFixedWingActuatorComponent::DtFixedWingActuatorComponent ( const DtFixedWingActuatorComponent orig)
protected

copy constructor; not implemented

Member Function Documentation

virtual bool DtFixedWingActuatorComponent::init ( )
virtual

to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports.

Reimplemented from DtActuatorComponent.

virtual const char* DtFixedWingActuatorComponent::type ( ) const
virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns
DtFixedWingActuatorType

Implements DtSimComponent.

virtual void DtFixedWingActuatorComponent::tick ( )
virtual

Calls either doFlying or doTaxiing, based on a onGround() call to myFixedWingEntityState.

Reimplemented from DtSimComponent.

static DtSimComponent* DtFixedWingActuatorComponent::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.
virtual void DtFixedWingActuatorComponent::calculateBodyVelocity ( const DtVector oldRelativeVelocity,
const DtDcm &  newLocalOrientation,
DtVector newBodyVelocity 
)
virtual

Put current velocity into body coordinates (AFTER rotating body).

Uses myLocalToBodyMatrix, which is calculated by calculateOrientation(). Stores the result in myNormalizedBodyVelocity.

virtual void DtFixedWingActuatorComponent::calculateAirborneAcceleration ( const DtVector  oldLocalPosition,
double  oldSpeed,
const DtDcm &  newLocalOrientation,
const DtVector newBodyVelocity,
double  throttle,
DtVector newRelativeAcceleration 
)
virtual

Calculates the sum acceleration from myBodyGravity, myBodyDrag and myBodyThrust.

Stores the result in myRelativeAcceleration. This function should only be called when the FWE is in the AIR!

virtual void DtFixedWingActuatorComponent::doFlying ( )
protectedvirtual

When the plane is in the air, this does the actual flying.

virtual void DtFixedWingActuatorComponent::doTaxiing ( )
protectedvirtual

When the FWE is on the ground, this does the actual taxiing.

virtual bool DtFixedWingActuatorComponent::isTouchingDown ( const DtVector newLocalPosition,
const DtVector newRelativeVelocity 
)
protectedvirtual

Returns true of false depending on whether the aircraft is currently landing or not.

virtual bool DtFixedWingActuatorComponent::isTakingOff ( bool  isOnGround,
double  speed 
)
protectedvirtual

Returns true of false depending on whether the aircraft is currently taking off or not.

virtual bool DtFixedWingActuatorComponent::updateGroundInteractionPoints ( DtGroundInteractionPt left,
DtGroundInteractionPt right,
DtGroundInteractionPt nose,
DtGroundInteractionPt center,
const DtDcm &  localOrientation,
const DtVector localPosition,
double  halfHeightOfTerrainIntersectChord 
)
protectedvirtual
virtual double DtFixedWingActuatorComponent::calculateYawRate ( double  pedal)
protectedvirtual

These functions are for when the FWEs are in the AIR.

They are NOT supposed to be called when the FWEs are on the GROUND.

Find yaw rate.

virtual double DtFixedWingActuatorComponent::calculatePitchRate ( double  stickYValue)
protectedvirtual

Find pitch rate.

virtual double DtFixedWingActuatorComponent::calculateRollRate ( double  stickXValue)
protectedvirtual

Find roll rate.

virtual void DtFixedWingActuatorComponent::calculateBodyRotationRates ( double  pedal,
double  stickXValue,
double  stickYValue,
DtVector newBodyRotationRates 
)
protectedvirtual
virtual void DtFixedWingActuatorComponent::calculateOrientation ( const DtDcm &  oldLocalOrientation,
const DtVector newBodyRotationRates,
DtDcm &  newLocalOrientation 
)
protectedvirtual

Uses current local orientation, rotationRates in SR, and dT.

Results placed in object pointed to by orientation argument.

virtual void DtFixedWingActuatorComponent::calculateBodyGravity ( const DtVector  oldLocalPosition,
const DtDcm &  newLocalOrientation,
DtVector newBodyGravityAcceleration 
)
protectedvirtual

Put acceleration due to gravity in body coordinates.

virtual void DtFixedWingActuatorComponent::calculateThrustAcceleration ( double  throttle,
DtVector newBodyThrustAccleration 
)
protectedvirtual

Calculate scalar accel in direction of thrust based on the throttle port and the maximum thrust, and store the value in myBodyThrust[0].

virtual void DtFixedWingActuatorComponent::calculateDragAcceleration ( double  oldSpeed,
const DtVector newBodyVelocity,
bool  flapsDeployed,
DtVector newBodyDragAccleration 
)
protectedvirtual

Calculate scalar drag accel opposite direction of current velocity.

Stores the result in myBodyDrag. This function should only be called when the FWE is in the AIR! When flapsDeployed is true, the drag from flaps is factored in as well.

virtual void DtFixedWingActuatorComponent::fallFromSky ( const DtString reason = DtString::nullString())
protectedvirtual

Causes the entity to fall from the sky.

If this is the first time this method was called since the entity has been flying correctly, the optional reason message is passed to the object console for the entity.

virtual bool DtFixedWingActuatorComponent::collidesWithGround ( const DtVector oldLocalPosition,
const DtVector newLocalPosition,
DtVector localCenterGoundPosition 
)
protectedvirtual
void DtFixedWingActuatorComponent::integrate ( const DtVector oldLocalPosition,
const DtVector oldRelativeVelocity,
const DtVector newRelativeAcceleration,
DtVector newLocalPosition,
DtVector newRelativeVelocity,
double  maxSpeed = 0 
)
protected

Integrates myRelativeVelocity and myLocalPosition.

virtual void DtFixedWingActuatorComponent::useFuel ( double  fuelUsed)
protectedvirtual

Assumes the fuel resource has resource name "fuel" If not found, fuel consumption not will not be modeled.

virtual double DtFixedWingActuatorComponent::fuelLeft ( ) const
protectedvirtual
virtual double DtFixedWingActuatorComponent::fullMass ( ) const
protectedvirtual

Mass when fuel tank is full.

virtual double DtFixedWingActuatorComponent::currentMass ( ) const
protectedvirtual

Calculates the current mass of the aircraft including fuel.

virtual double DtFixedWingActuatorComponent::calculateHeading ( double  oldHeading,
double  steering,
double  dT,
double  speed,
double  turningRadius 
)
protectedvirtual

These functions are for when the FWEs are on the GROUND.

They are NOT supposed to be called when the FWEs are in the AIR.

virtual void DtFixedWingActuatorComponent::calculateScalarVelocityAndAcceleration ( double  oldPitch,
double scalarVelocity,
double scalarAcceleration 
)
protectedvirtual

Computes the speed and acceleration for this tick, i.e. to publish.

virtual double DtFixedWingActuatorComponent::calculateMaxGroundSpeed ( )
protectedvirtual
virtual double DtFixedWingActuatorComponent::calculateMaxGroundAcceleration ( )
protectedvirtual
virtual double DtFixedWingActuatorComponent::calculateAcceleration ( double  pitch,
double  maxSpeed,
double  maxAccel,
double  newSpeed 
)
protectedvirtual

Calculate the acceleration based on the speed now (i.e., updated from last tick's speed using last tick's acceleration) and the max speed and accel limits.

virtual double DtFixedWingActuatorComponent::calculateAccelerationFromThrottle ( )
protectedvirtual
virtual double DtFixedWingActuatorComponent::calculateAccelerationFromSlope ( double  slope)
protectedvirtual

Slope is rise over run, i.e. tan(pitch)

virtual double DtFixedWingActuatorComponent::calculateAccelerationFromResistance ( double  maxSpeed,
double  maxAccel 
)
protectedvirtual
virtual double DtFixedWingActuatorComponent::calculateAccelerationFromBrake ( double  otherAccels)
protectedvirtual
virtual DtVector DtFixedWingActuatorComponent::calculateProjectedLocation ( const DtVector oldLocalPosition,
const DtVector newBodyAcceleration,
const DtVector oldBodyVelocity,
double  newHeading 
)
protectedvirtual
virtual void DtFixedWingActuatorComponent::calculateOrientationAndPositionOnGround ( const DtVector newLocalProjectedLocation,
double  newHeading,
DtDcm &  newLocalOrientation,
DtVector newLocalPosition 
)
protectedvirtual
virtual void DtFixedWingActuatorComponent::updateRepository ( const DtVector newLocalPosition,
const DtVector newRelativeVelocity,
const DtVector newRelativeAcceleration,
const DtDcm &  newLocalOrientation,
const DtVector newBodyRotationRates,
bool  isOnGround,
const DtAppearance &  newAppearance 
)
protectedvirtual
virtual void DtFixedWingActuatorComponent::updateDisplay ( ) const
protectedvirtual
virtual double DtFixedWingActuatorComponent::maxThrustAcceleration ( ) const
protectedvirtual

These accessors to the actuator's parameters are provided for use by the controllers that must control it.

virtual double DtFixedWingActuatorComponent::maxClimbRate ( ) const
protectedvirtual
virtual double DtFixedWingActuatorComponent::maxYawVelocity ( ) const
protectedvirtual
virtual double DtFixedWingActuatorComponent::maxPitchVelocity ( ) const
protectedvirtual
virtual double DtFixedWingActuatorComponent::maxRollVelocity ( ) const
protectedvirtual
virtual double DtFixedWingActuatorComponent::maxAltitude ( ) const
protectedvirtual
virtual bool DtFixedWingActuatorComponent::createPortGroups ( )
protectedvirtual

Creates the local port groups.

Reimplemented from DtSimComponent.

virtual bool DtFixedWingActuatorComponent::createPorts ( )
protectedvirtual

Creates the input ports and adds them to the component.

Reimplemented from DtSimComponent.

virtual bool DtFixedWingActuatorComponent::createPSR ( )
protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual bool DtFixedWingActuatorComponent::createFuelConsumptionModel ( )
protectedvirtual

Creates the fuel consumption model.

virtual void DtFixedWingActuatorComponent::sendDetonation ( const DtVector geocentricPosition)
protectedvirtual
virtual void DtFixedWingActuatorComponent::forceSpatialUpdate ( )
protectedvirtual

Forces a network update of all aircraft spatial data.

virtual void DtFixedWingActuatorComponent::initializeSpatialAttributeList ( )
protectedvirtual

Initializes the list of attributes that are part of a spatial update.

const DtFixedWingActuatorComponent& DtFixedWingActuatorComponent::operator= ( const DtFixedWingActuatorComponent orig)
protected

assignment operator; not implemented

Member Data Documentation

DtFixedWingEntityStateRepository* DtFixedWingActuatorComponent::myFixedWingEntityState
protected
DtFixedWingActuatorDescriptor* DtFixedWingActuatorComponent::myFixedWingActuatorDescriptor
protected
DtAircraftFuelConsumptionModel* DtFixedWingActuatorComponent::myFuelConsumptionModel
protected
DtInputPortGroup* DtFixedWingActuatorComponent::myFixedWingControlPortGroup
protected

Input Port Group Name: fixed-wing-control
Input Port Group Description: Provides input to the fixed-wing actuator (flight-kinematics).

DtConstrainedAnalogInputPort* DtFixedWingActuatorComponent::myThrottlePort
protected

Input Port Name: throttle
Input Port Description:
Input Port Range: 0.

to 1.
Input Port Default Value:
Input Group Parent: fixed-wing-control

DtConstrainedDualAxisAnalogInputPort* DtFixedWingActuatorComponent::myStickPort
protected

Input Port Name: stick
Input Port Description:
Input Port Range: X:-1.

to 1., Y:-1. to 1.
Input Port Default Value:
Input Group Parent: fixed-wing-control

DtConstrainedAnalogInputPort* DtFixedWingActuatorComponent::myPedalPort
protected

Input Port Name: pedal
Input Port Description:
Input Port Range: -1.

to 1.
Input Port Default Value:
Input Group Parent: fixed-wing-control

DtConstrainedAnalogInputPort* DtFixedWingActuatorComponent::myBrakePort
protected

Input Port Name: brake
Input Port Description:
Input Port Range: 0.

to 1.
Input Port Default Value:
Input Group Parent: fixed-wing-control

DtBooleanInputPort* DtFixedWingActuatorComponent::myFlapsDeployedPort
protected

Input Port Name: flaps
Input Port Description:
Input Port Range:
Input Port Default Value: false
Input Group Parent: fixed-wing-control.

DtFixedWingFlightPSR* DtFixedWingActuatorComponent::myProcessState
protected

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

bool DtFixedWingActuatorComponent::mySentFallingMessage
protected

Used to make sure fall message is only sent once.

bool DtFixedWingActuatorComponent::myPutTaxiingPlaneOnGround
protected

Used to make sure a taxiing, destroyed aircraft is only set down on the terrain once.

DtUpdateRepositoryOutputPortGroup* DtFixedWingActuatorComponent::myUpdateRepositoryOutputPortGroup
protected

Port group used to set what values should be set into the VRF state repository.

All values are in local coordinates

bool DtFixedWingActuatorComponent::myPreviouslyHadData
protected
bool DtFixedWingActuatorComponent::myKeepParentPosition
protected
RTI::AttributeHandleSet* DtFixedWingActuatorComponent::mySpatialAttributes
protected

Set of HLA object attributes that contain the spatial data for this aircraft.

Initialized during init() from the list of attribute names specified in #theSpatialAttributeNames.


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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)