VR-Forces 4.10 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 | Private Member Functions
DtRotaryWingActuatorComponent Class Reference

DtRotaryWingActuatorComponent is a kinematics-based model of a rotary wing aircraft that converts collective, cyclic, and pedal into acceleration, velocity, position, rotational velocity, and orientation. More...

Inheritance diagram for DtRotaryWingActuatorComponent:
Inheritance graph
[legend]

Public Member Functions

 DtRotaryWingActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtRotaryWingActuatorComponent ()
 destructor Removes process state from process state manager before deleting it. More...
 
virtual bool init ()
 to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports. More...
 
virtual const chartype () const
 Returns a string identifies the class type of component. More...
 
virtual void tick ()
 Calculate new kinematic state. Calls updateAppearance(). More...
 
virtual void useFuel (double fuelUsed)
 Fuel manipulation functions. More...
 
virtual double fuelLeft () const
 
virtual double calculateFuel () const
 Calculate the fuel used in the last time step. More...
 
virtual void fallFromSky ()
 This member function is called when an entity has been destroyed and is still in the air. More...
 
- Public Member Functions inherited from DtActuatorComponent
virtual ~DtActuatorComponent ()
 destructor More...
 
virtual DtSimRadioradio ()
 
virtual bool tickWhileDestroyed () const
 By default, all actuators tick when the entity is destroyed. More...
 
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSimComponent ()
 destructor More...
 
virtual void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component. More...
 
DtComponentSystemparentSystem () const
 
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager. More...
 
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values. More...
 
virtual void postTick ()
 This function is called immediately after tick() is called. More...
 
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived. More...
 
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as More...
 
virtual double minTickPeriod () const
 access the minimum tick period More...
 
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time More...
 
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period More...
 
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally. More...
 
virtual double nextTickTime () const
 access the next tick time More...
 
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...
 
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at. More...
 
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. More...
 
virtual DtSimComponentnextComponent ()
 List management functions. More...
 
virtual DtSimComponentprevComponent ()
 
virtual void setListItem (DtListItem *item)
 Used by DtComponentList. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component. More...
 
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. More...
 
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. More...
 
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component. More...
 
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. More...
 
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. More...
 
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component. More...
 
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. More...
 
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. More...
 
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component. More...
 
virtual int priority () const
 Return the current connection priority for this component. More...
 
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. More...
 
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...
 
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. More...
 
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. More...
 
virtual const
DtComponentDescriptor
componentDescriptor () const
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in. More...
 
const DtPhysicalWorldphysicalWorld () const
 
DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any. More...
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtVrfObjectentity ()
 Gets the entity. More...
 
const DtVrfObjectentity () const
 
const DtVrfObjectconst_entity () const
 You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...
 
DtSimManagersimManager ()
 Gets the sim manager. More...
 
const DtSimManagersimManager () const
 
const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
 
DtVrfObjectStateRepositorylocalStateRepository ()
 Gets the local state repository. More...
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
const DtVrfObjectStateRepositoryconst_localStateRepository () const
 You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...
 
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component. More...
 
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component. More...
 
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component. More...
 
virtual bool isThreadSafe () const
 Returns true if this component is marked as being thread safe. More...
 
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. More...
 
virtual void onRestore ()
 Called whenever a component is restored. Default is no-op. More...
 
virtual void enable ()
 Is this component enabled or not. More...
 
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 More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
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. More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream. More...
 
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op. More...
 
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op. More...
 
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. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
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. More...
 
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. More...
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
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. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
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. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
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. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
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. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
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. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
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. More...
 
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. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentMarkThreadSafe (DtSimComponent *)
 Marks an instance of a component as being thread safe. More...
 
static DtSimComponentFactoryfactory ()
 A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...
 
static void addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
 Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 

Protected Member Functions

virtual bool createPortGroups ()
 Creates the local port groups. More...
 
virtual bool createPorts ()
 Creates the input ports and adds them to the component. More...
 
virtual bool createPSR ()
 Creates myProcessState data member, and adds it to our process state repository manager. More...
 
virtual void clampFrameRate ()
 Clamp the frame rate if the rate is too slow. More...
 
virtual void setLanded (const DtVector &localIntersectionPoint)
 Sets the parameters for a landed entity. More...
 
virtual bool checkFlyingWithoutFuel ()
 Check to see if the entity is flying without fuel, and call fallFromSky if so. More...
 
virtual void setYawAcceleration ()
 Find yaw acceleration and new rate. More...
 
virtual void calculateYawRate ()
 
virtual double calculateOneAxisOfOrientation (const int axis, const double angleInit, const double period, const double portValue, const double maxAccel, const double maxRate)
 For pitch and roll: More...
 
virtual void checkAndDetachIfNecessary ()
 If attached (embark) check to see if should be disembarked b/c the entity is no longer close to the entity it is currently attached to. More...
 
virtual void calculateOrientation ()
 Uses current local orientation, rotationRates in SR, and dT. More...
 
virtual void calculateNormalizedBodyVelocity ()
 Put current velocity into body coordinates (AFTER rotating body). More...
 
virtual void calculateLiftAcceleration ()
 Calculate scalar accel in direction of lift (perpendicular to wings). More...
 
virtual double altitudePowerFactor (const double altitude)
 Calculate a factor by which to multiply lift based on altitude. More...
 
virtual void calculateResultantAcceleration ()
 Sum the accelerations produced by forces acting on the body, and put the result into world coordinates. More...
 
virtual void integrate ()
 Find the new velocity and position. More...
 
virtual void updateRepository ()
 Sets the state to locally calculated values. More...
 
virtual void updateAirspeedToRepository ()
 /brief Called from updateRepository(). More...
 
virtual void updateDisplay ()
 Can be used to print control values in the console window. More...
 
virtual void checkLandedOrCrashed ()
 Check if the entity landed on the ground or crashed. More...
 
virtual bool isCrashedIntoGround (const DtVector &localPosition, DtVector &localIntersectionPoint) const
 Determines if the entity has crashed into the ground. More...
 
virtual void sendDetonation (const DtVector &geocentricLocation) const
 Sends a detonation interaction at the specified location, in geocentric coordinates. More...
 
virtual bool isSubsurface () const
 Determine whether or not the configured entity is a subsurface entity or not. More...
 
virtual bool componentInitialized () const
 Determine if the component has been properly initialized. More...
 
virtual bool engineOperational () const
 
virtual void updateAppearance ()
 Called from tick() to update the PowerPlantOn appearance bit to on if the entity is not in the landed state and engineOperational() is true. More...
 
virtual double heightAboveGroundSupport () const
 A cached value for the height of the entity origin above the lowest support point that contacts the ground (when landed). More...
 
virtual void updateOrderedSpeed ()
 Update the ordered speed with the ordered air speed. More...
 
virtual void preFirstTickInit ()
 Initialize member variables needed for air temp calculation. More...
 
- Protected Member Functions inherited from DtActuatorComponent
 DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual void setRadio (DtSimRadio *radio)
 
 DtActuatorComponent ()
 Default constructor; should not be called. More...
 
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT. More...
 
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. More...
 
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick. More...
 
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component. More...
 
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization. More...
 
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name. More...
 
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name. More...
 
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name. More...
 
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name. More...
 
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked. More...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 

Protected Attributes

DtRotaryWingEntityStateRepositorymyRotaryWingEntityState
 
DtRotaryWingActuatorDescriptormyRotaryWingActuatorDescriptor
 
DtReal myMaxDragAcceleration
 
DtVector myBodyRotationalAcceleration
 
DtVector myBodyRotationRates
 
DtTaitBryan myOrientation
 
DtDcm myBodyToLocalMatrix
 
DtDcm myLocalToBodyMatrix
 
DtReal mySpeedRatioSquared
 
DtVector myBodyVelocity
 
DtVector myNormalizedBodyVelocity
 
DtVector myBodyLift
 
DtVector myBodyAcceleration
 
DtVector myRelativeAcceleration
 
DtVector myRelativeVelocity
 
DtReal mySpeed
 
DtVector myLocalPosition
 
DtVector myLocalOrientation
 
DtReal myAltitudeAGL
 
DtVector myPreviousGroundClampedPosition
 
bool myPrintedOutOfFuelMessage
 
DtRotaryWingFlightPSRmyProcessState
 Container for state data associated with this component. More...
 
DtUpdateRepositoryOutputPortGroupmyUpdateRepositoryOutputPortGroup
 Port group used to set what values should be set into the VRF state repository. More...
 
double myHeightAboveGroundSupport
 Cached value from heightAboveGroundSupport. More...
 
DtAirspeedCalculatormyAirSpeedCalculator
 Air Speed Calculator for updating state properties Created in init() More...
 
double myLastSpeed
 myLastSpeed is used in tick() to catch velocity changes while paused, due to setCurrentSpeed() or setAltitude(). More...
 
Ports and Port Groups
DtInputPortGroupmyRotaryWingControlPortGroup
 Input Port Group Name: rotary-wing-control
Input Port Group Description: More...
 
DtConstrainedAnalogInputPortmyThrottlePort
 Input Port Name: throttle
Input Port Description:
Input Port Range: 0. More...
 
DtConstrainedDualAxisAnalogInputPortmyCyclicPort
 Input Port Name: cyclic
Input Port Description:
Input Port Range: X: -1. More...
 
DtConstrainedAnalogInputPortmyPedalPort
 Input Port Name: pedal
Input Port Description:
Input Port Range: -1. More...
 
DtConstrainedAnalogInputPortmyCollectivePort
 Input Port Name: collective
Input Port Description:
Input Port Range: 0. More...
 
- Protected Attributes inherited from DtActuatorComponent
DtSimRadiomyRadio
 Actuators can send messages. More...
 
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
 
DtVrfObjectStateRepositorymyLocalStateRepository
 
DtSimManagermySimManager
 
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs. More...
 
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. More...
 
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick. More...
 
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. More...
 
const DtComponentDescriptormyComponentDescriptor
 
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...
 
bool myTickEveryFrame
 Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...
 
DtTaskVisualizationMap myTaskVisualizations
 The visualization objects to be drawn for this component. More...
 
double myNextTaskVisTickTime
 The next tick time for updating the task visualizations. More...
 
DtSymbolString myFullComponentName
 
- 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. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 

Private Member Functions

 DtRotaryWingActuatorComponent ()
 default constructor; not implemented More...
 
 DtRotaryWingActuatorComponent (const DtRotaryWingActuatorComponent &orig)
 copy constructor; not implemented More...
 
DtRotaryWingActuatorComponentoperator= (const DtRotaryWingActuatorComponent &orig)
 assignment operator; not implemented More...
 

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
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Detailed Description

DtRotaryWingActuatorComponent is a kinematics-based model of a rotary wing aircraft that converts collective, cyclic, and pedal into acceleration, velocity, position, rotational velocity, and orientation.

End User Description: In addition, the actuator implements ground detection.

Uses Descriptor Type: DtRotaryWingActuatorDescriptor

Constructor & Destructor Documentation

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

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).
virtual DtRotaryWingActuatorComponent::~DtRotaryWingActuatorComponent ( )
virtual

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

DtRotaryWingActuatorComponent::DtRotaryWingActuatorComponent ( )
private

default constructor; not implemented

DtRotaryWingActuatorComponent::DtRotaryWingActuatorComponent ( const DtRotaryWingActuatorComponent orig)
private

copy constructor; not implemented

Member Function Documentation

virtual bool DtRotaryWingActuatorComponent::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* DtRotaryWingActuatorComponent::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
DtRotaryWingActuatorType

Implements DtSimComponent.

virtual void DtRotaryWingActuatorComponent::tick ( )
virtual

Calculate new kinematic state. Calls updateAppearance().

Reimplemented from DtSimComponent.

virtual void DtRotaryWingActuatorComponent::useFuel ( double  fuelUsed)
virtual

Fuel manipulation functions.

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

virtual double DtRotaryWingActuatorComponent::fuelLeft ( ) const
virtual
virtual double DtRotaryWingActuatorComponent::calculateFuel ( ) const
virtual

Calculate the fuel used in the last time step.

virtual void DtRotaryWingActuatorComponent::fallFromSky ( )
virtual

This member function is called when an entity has been destroyed and is still in the air.

The only acceleration applied is gravity. All rotation rates are set to 0.0. When the entity intersects the ground, a detonation interaction is generated at the point of impact. A munition type of <2, 0, 0, 0, 0, 0, 0> is used.

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

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).
Returns
New instance of this class.
virtual bool DtRotaryWingActuatorComponent::createPortGroups ( )
protectedvirtual

Creates the local port groups.

Reimplemented from DtSimComponent.

virtual bool DtRotaryWingActuatorComponent::createPorts ( )
protectedvirtual

Creates the input ports and adds them to the component.

Reimplemented from DtSimComponent.

virtual bool DtRotaryWingActuatorComponent::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 void DtRotaryWingActuatorComponent::clampFrameRate ( )
protectedvirtual

Clamp the frame rate if the rate is too slow.

virtual void DtRotaryWingActuatorComponent::setLanded ( const DtVector localIntersectionPoint)
protectedvirtual

Sets the parameters for a landed entity.

virtual bool DtRotaryWingActuatorComponent::checkFlyingWithoutFuel ( )
protectedvirtual

Check to see if the entity is flying without fuel, and call fallFromSky if so.

virtual void DtRotaryWingActuatorComponent::setYawAcceleration ( )
protectedvirtual

Find yaw acceleration and new rate.

virtual void DtRotaryWingActuatorComponent::calculateYawRate ( )
protectedvirtual
virtual double DtRotaryWingActuatorComponent::calculateOneAxisOfOrientation ( const int  axis,
const double  angleInit,
const double  period,
const double  portValue,
const double  maxAccel,
const double  maxRate 
)
protectedvirtual

For pitch and roll:

virtual void DtRotaryWingActuatorComponent::checkAndDetachIfNecessary ( )
protectedvirtual

If attached (embark) check to see if should be disembarked b/c the entity is no longer close to the entity it is currently attached to.

virtual void DtRotaryWingActuatorComponent::calculateOrientation ( )
protectedvirtual

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

Results placed in object pointed to by orientation argument.

virtual void DtRotaryWingActuatorComponent::calculateNormalizedBodyVelocity ( )
protectedvirtual

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

virtual void DtRotaryWingActuatorComponent::calculateLiftAcceleration ( )
protectedvirtual

Calculate scalar accel in direction of lift (perpendicular to wings).

virtual double DtRotaryWingActuatorComponent::altitudePowerFactor ( const double  altitude)
protectedvirtual

Calculate a factor by which to multiply lift based on altitude.

Assumes that at 0 MSL, this factor will be 1.0; at altitude = maxAltitude, full power (collective = 1.0) will produce a lift of g (gravity acceleration), thus producing 0 net lift. Factor = (g - full-collective-lift-acceleration)/ full-collective-lift-acceleration * (altitude / max-altitude)

  • 1.0.
virtual void DtRotaryWingActuatorComponent::calculateResultantAcceleration ( )
protectedvirtual

Sum the accelerations produced by forces acting on the body, and put the result into world coordinates.

virtual void DtRotaryWingActuatorComponent::integrate ( )
protectedvirtual

Find the new velocity and position.

virtual void DtRotaryWingActuatorComponent::updateRepository ( )
protectedvirtual

Sets the state to locally calculated values.

virtual void DtRotaryWingActuatorComponent::updateAirspeedToRepository ( )
protectedvirtual

/brief Called from updateRepository().

Override this method to calculate air speed and set state properties. Uses myAltitudeAGL and myLocalPosition as ground speed. Sets state properties "IndicatedAirspeed", "TrueAirspeed", "MachNumber". Uses myAirSpeedCalculator to calculate from ground speed (i.e. entity velocity). To use a different air speed calculator, see DtAirspeedCalculatorFactory in airspeedCalculator.h. Register a class derived from DtAirspeedCalculator with the factory. During registration, either override the default type "DtAirspeedCalculator" or register a new type. See DtRotaryWingActuatorDescriptor::myAirspeedCalculatorType in vrfobjparam. See also "data/simulationModelSets/EntityLevel/vrfSim/systems/movement/rotary-wing-attack.sysdef. Factory changes can be made at application initialization, e.g. in DtInitializeVrfPlugin(DtCgf* cgf). Just make a call to DtAirspeedCalculatorFactory::instance().registerAirSpeedCalculatorCreator(<string>, <static_creator_function>);

virtual void DtRotaryWingActuatorComponent::updateDisplay ( )
protectedvirtual

Can be used to print control values in the console window.

virtual void DtRotaryWingActuatorComponent::checkLandedOrCrashed ( )
protectedvirtual

Check if the entity landed on the ground or crashed.

If landed, ground clamp the actuator. If crashed, set isDestroyed and isSmoking. Checks to see if the entity is below ground. If it is, the entity is set to destroyed, flaming, and smoking. Its velocity and acceleration vectors are set to <0.0, 0.0, 0.0>, and its Z-coordinate is set to the height of the terrain at that <X, Y> coordinate. If it is not below ground, checkLandedOrCrashed() checks to see if the following criteria are met for being in a landed state: Velocity along the (database) Z axis is greater than -3.0 meters/second, but less than 2.0 * dT meters/second Height above terrain is less than 2.0 meters Overall entity speed is less than 4.0 meters/second. If one or more of these criteria is false, checkLandedOrCrashed() sets the SR Landed flag to false and returns. Otherwise, the variables myLandPosition and myLandHeading are set to the entity�s current position and heading, and DtRotaryWingEntity::land() is called. The velocity, acceleration, and rotational velocity vectors are all set to <0.0, 0.0, 0.0>.

virtual bool DtRotaryWingActuatorComponent::isCrashedIntoGround ( const DtVector localPosition,
DtVector localIntersectionPoint 
) const
protectedvirtual

Determines if the entity has crashed into the ground.

Returns
A boolean indicating whether or not the entity has crashed into the ground.
Parameters
localPositionThe position to test, in database coordinates.
physWorldThe physicalWorld to test against.
localIntersectionPointThis parameter is filled with the results of the intersection test with the terrain database.
Note
The localIntersectionPoint is always calculated, even if the entity has not crashed into the ground.
virtual void DtRotaryWingActuatorComponent::sendDetonation ( const DtVector geocentricLocation) const
protectedvirtual

Sends a detonation interaction at the specified location, in geocentric coordinates.

virtual bool DtRotaryWingActuatorComponent::isSubsurface ( ) const
protectedvirtual

Determine whether or not the configured entity is a subsurface entity or not.

Returns
True if the configured entity is a subsurface and false if it isn't.
Note
This is not intended for general use, as it will most likely be removed when proper subsurface components are developed.
virtual bool DtRotaryWingActuatorComponent::componentInitialized ( ) const
protectedvirtual

Determine if the component has been properly initialized.

The component must have a valid sim manager, entity state, actuator descriptor, and process state rep to be initialized properly. Additionally, it must have a valid terrain database, a valid coordinate system in the terrain database, and a valid exercise clock in order to be used. If any of these are missing, then the function returns false.

Returns
True if the component is initialized and ready to be ticked.
virtual bool DtRotaryWingActuatorComponent::engineOperational ( ) const
protectedvirtual
Returns
True as long as the entity is not destroyed and the entity is not "mobility killed", based on its appearance.
virtual void DtRotaryWingActuatorComponent::updateAppearance ( )
protectedvirtual

Called from tick() to update the PowerPlantOn appearance bit to on if the entity is not in the landed state and engineOperational() is true.

virtual double DtRotaryWingActuatorComponent::heightAboveGroundSupport ( ) const
protectedvirtual

A cached value for the height of the entity origin above the lowest support point that contacts the ground (when landed).

Computed from bounding volume and other support point.

virtual void DtRotaryWingActuatorComponent::updateOrderedSpeed ( )
protectedvirtual

Update the ordered speed with the ordered air speed.

virtual void DtRotaryWingActuatorComponent::preFirstTickInit ( )
protectedvirtual

Initialize member variables needed for air temp calculation.

Reimplemented from DtSimComponent.

DtRotaryWingActuatorComponent& DtRotaryWingActuatorComponent::operator= ( const DtRotaryWingActuatorComponent orig)
private

assignment operator; not implemented

Member Data Documentation

DtRotaryWingEntityStateRepository* DtRotaryWingActuatorComponent::myRotaryWingEntityState
protected
DtRotaryWingActuatorDescriptor* DtRotaryWingActuatorComponent::myRotaryWingActuatorDescriptor
protected
DtInputPortGroup* DtRotaryWingActuatorComponent::myRotaryWingControlPortGroup
protected

Input Port Group Name: rotary-wing-control
Input Port Group Description:

DtConstrainedAnalogInputPort* DtRotaryWingActuatorComponent::myThrottlePort
protected

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

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

DtConstrainedDualAxisAnalogInputPort* DtRotaryWingActuatorComponent::myCyclicPort
protected

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

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

DtConstrainedAnalogInputPort* DtRotaryWingActuatorComponent::myPedalPort
protected

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

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

DtConstrainedAnalogInputPort* DtRotaryWingActuatorComponent::myCollectivePort
protected

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

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

DtReal DtRotaryWingActuatorComponent::myMaxDragAcceleration
protected
DtVector DtRotaryWingActuatorComponent::myBodyRotationalAcceleration
protected
DtVector DtRotaryWingActuatorComponent::myBodyRotationRates
protected
DtTaitBryan DtRotaryWingActuatorComponent::myOrientation
protected
DtDcm DtRotaryWingActuatorComponent::myBodyToLocalMatrix
protected
DtDcm DtRotaryWingActuatorComponent::myLocalToBodyMatrix
protected
DtReal DtRotaryWingActuatorComponent::mySpeedRatioSquared
protected
DtVector DtRotaryWingActuatorComponent::myBodyVelocity
protected
DtVector DtRotaryWingActuatorComponent::myNormalizedBodyVelocity
protected
DtVector DtRotaryWingActuatorComponent::myBodyLift
protected
DtVector DtRotaryWingActuatorComponent::myBodyAcceleration
protected
DtVector DtRotaryWingActuatorComponent::myRelativeAcceleration
protected
DtVector DtRotaryWingActuatorComponent::myRelativeVelocity
protected
DtReal DtRotaryWingActuatorComponent::mySpeed
protected
DtVector DtRotaryWingActuatorComponent::myLocalPosition
protected
DtVector DtRotaryWingActuatorComponent::myLocalOrientation
protected
DtReal DtRotaryWingActuatorComponent::myAltitudeAGL
protected
DtVector DtRotaryWingActuatorComponent::myPreviousGroundClampedPosition
protected
bool DtRotaryWingActuatorComponent::myPrintedOutOfFuelMessage
protected
DtRotaryWingFlightPSR* DtRotaryWingActuatorComponent::myProcessState
protected

Container for state data associated with this component.

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

DtUpdateRepositoryOutputPortGroup* DtRotaryWingActuatorComponent::myUpdateRepositoryOutputPortGroup
protected

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

All values are in local coordinates

double DtRotaryWingActuatorComponent::myHeightAboveGroundSupport
protected

Cached value from heightAboveGroundSupport.

DtAirspeedCalculator* DtRotaryWingActuatorComponent::myAirSpeedCalculator
protected

Air Speed Calculator for updating state properties Created in init()

double DtRotaryWingActuatorComponent::myLastSpeed
protected

myLastSpeed is used in tick() to catch velocity changes while paused, due to setCurrentSpeed() or setAltitude().

When current speed does not match last speed while paused, recalculate true air speed.


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)