VR-Forces 4.1 Class Documentation
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)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtRotaryWingActuatorComponent ()
 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 DtString type () const
 Returns a string identifies the class type of component.
virtual void tick ()
 Calculate new kinematic state.
virtual void useFuel (double fuelUsed)
 Fuel manipulation functions.
virtual double fuelLeft () const
virtual double calculateFuel () const
 Calculate the fuel used in the last time step.
virtual void fallFromSky ()
 This member function is called when an entity has been destroyed and is still in the air.
- Public Member Functions inherited from DtActuatorComponent
virtual ~DtActuatorComponent ()
 destructor
virtual DtSimBaseRadioradio ()
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 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 (FILE *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 DtFilename &searchPath, 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 void enable ()
 Is this component enabled or not.
virtual void disable ()
 Is this component enabled or not.
virtual bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStream & objectConsoleDebug () const
virtual DtOutputStream & objectConsoleVerbose () const
virtual DtOutputStream & objectConsoleInfo () const
virtual DtOutputStream & objectConsoleWarn () const
virtual DtOutputStream & objectConsoleError () 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)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

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 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 void clampFrameRate ()
 Clamp the frame rate if the rate is too slow.
virtual void setLanded (const DtVector &localIntersectionPoint)
 Sets the parameters for a landed entity.
virtual bool checkFlyingWithoutFuel ()
 Check to see if the entity is flying without fuel, and call fallFromSky if so.
virtual void calculateYawAcceleration ()
 Find yaw acceleration and new rate.
virtual void calculateYawRate ()
virtual void calculatePitchAcceleration ()
 Find pitch acceleration and new rate.
virtual void calculatePitchRate ()
virtual void calculateRollAcceleration ()
 Find roll acceleration and new rate.
virtual void calculateRollRate ()
virtual void calculateOrientation ()
 Uses current local orientation, rotationRates in SR, and dT.
virtual void calculateNormalizedBodyVelocity ()
 Put current velocity into body coordinates (AFTER rotating body).
virtual void calculateBodyGravity ()
 Put acceleration due to gravity in body coordinates.
virtual void calculateLiftAcceleration ()
 Calculate scalar accel in direction of lift (perpendicular to wings).
virtual void calculateDragAcceleration ()
 Calculate scalar drag accel opposite direction of current velocity.
virtual void calculateResultantAcceleration ()
 Sum the accelerations produced by forces acting on the body, and put the result into world coordinates.
virtual void integrate ()
 Find the new velocity and position.
virtual void updateRepository ()
 Sets the state to locally calculated values.
virtual void updateDisplay () const
 Can be used to print control values in the console window.
virtual void checkLandedOrCrashed ()
 Check if the entity landed on the ground or crashed.
virtual bool isCrashedIntoGround (const DtVector &localPosition, DtVector &localIntersectionPoint) const
 Determines if the entity has crashed into the ground.
virtual void sendDetonation (const DtVector &geocentricLocation) const
 Sends a detonation interaction at the specified location, in geocentric coordinates.
virtual bool isSubsurface () const
 Determine whether or not the configured entity is a subsurface entity or not.
virtual bool componentInitialized () const
 Determine if the component has been properly initialized.
virtual bool engineOperational () const
- Protected Member Functions inherited from DtActuatorComponent
 DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
 DtActuatorComponent (const DtActuatorComponent &orig)
 copy constructor
const DtActuatorComponentoperator= (const DtActuatorComponent &orig)
 assignment operator
virtual void setRadio (DtSimBaseRadio *radio)
 DtActuatorComponent ()
 Default constructor; should not be called.
- Protected Member Functions inherited from DtSimComponent
bool testInvariant () 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
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.

Protected Attributes

DtRotaryWingEntityStateRepositorymyRotaryWingEntityState
DtRotaryWingActuatorDescriptormyRotaryWingActuatorDescriptor
DtReal myMaxDragAcceleration
DtVector myBodyRotationalAcceleration
DtVector myBodyRotationRates
DtTaitBryan myOrientation
DtDcm myBodyToLocalMatrix
DtDcm myLocalToBodyMatrix
DtReal mySpeedRatioSquared
DtVector myBodyVelocity
DtVector myNormalizedBodyVelocity
DtVector myBodyDrag
DtVector myBodyGravity
DtVector myBodyLift
DtVector myBodyAcceleration
DtVector myRelativeAcceleration
DtVector myRelativeVelocity
DtReal mySpeed
DtVector myLocalPosition
DtVector myLocalOrientation
DtReal myAltitude
DtVector myPreviousGroundClampedPosition
bool myPrintedOutOfFuelMessage
DtRotaryWingFlightPSRmyProcessState
 Container for state data associated with this component.
Ports and Port Groups
DtInputPortGroupmyRotaryWingControlPortGroup
 Input Port Group Name: rotary-wing-control
Input Port Group Description:
DtConstrainedAnalogInputPortmyThrottlePort
 Input Port Name: throttle
Input Port Description:
Input Port Range: 0.
DtConstrainedDualAxisAnalogInputPortmyCyclicPort
 Input Port Name: cyclic
Input Port Description:
Input Port Range: X: -1.
DtConstrainedAnalogInputPortmyPedalPort
 Input Port Name: pedal
Input Port Description:
Input Port Range: -1.
DtConstrainedAnalogInputPortmyCollectivePort
 Input Port Name: collective
Input Port Description:
Input Port Range: 0.
- Protected Attributes inherited from DtActuatorComponent
DtSimBaseRadiomyRadio
 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.
const DtComponentDescriptormyComponentDescriptor
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

Private Member Functions

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

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
- 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

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 
)

(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 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 DtString 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.

Returns
DtRotaryWingActuatorType

Reimplemented from DtSimComponent.

virtual void DtRotaryWingActuatorComponent::tick ( )
virtual

Calculate new kinematic state.

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

(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 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::calculateYawAcceleration ( )
protectedvirtual

Find yaw acceleration and new rate.

virtual void DtRotaryWingActuatorComponent::calculateYawRate ( )
protectedvirtual
virtual void DtRotaryWingActuatorComponent::calculatePitchAcceleration ( )
protectedvirtual

Find pitch acceleration and new rate.

virtual void DtRotaryWingActuatorComponent::calculatePitchRate ( )
protectedvirtual
virtual void DtRotaryWingActuatorComponent::calculateRollAcceleration ( )
protectedvirtual

Find roll acceleration and new rate.

virtual void DtRotaryWingActuatorComponent::calculateRollRate ( )
protectedvirtual
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::calculateBodyGravity ( )
protectedvirtual

Put acceleration due to gravity in body coordinates.

virtual void DtRotaryWingActuatorComponent::calculateLiftAcceleration ( )
protectedvirtual

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

virtual void DtRotaryWingActuatorComponent::calculateDragAcceleration ( )
protectedvirtual

Calculate scalar drag accel opposite direction of current velocity.

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::updateDisplay ( ) const
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.
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::myBodyDrag
protected
DtVector DtRotaryWingActuatorComponent::myBodyGravity
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::myAltitude
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).


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)