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

The DtRotaryWingPilotController class creates the rotary-wing-control port group needed to control rotary-wing actuators. More...

Inheritance diagram for DtRotaryWingPilotController:
Inheritance graph
[legend]

Public Member Functions

 DtRotaryWingPilotController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtRotaryWingPilotController ()
 destructor
virtual bool init ()
 Overridden to initialize myRotaryWingEntityState.
virtual void tick ()
 Reads the data from the guidance ports into the state repository.
virtual const chartype () const
 Returns a string identifies the class type of component.
virtual
DtConstrainedAnalogOutputPort
throttlePort ()
virtual
DtConstrainedAnalogOutputPort
collectivePort ()
virtual
DtConstrainedDualAxisAnalogOutputPort
cyclicPort ()
virtual
DtConstrainedAnalogOutputPort
pedalPort ()
virtual bool createGuidancePortGroup ()
 Create the guidance ports from the task controllers.
virtual bool createDesiredPositionPort ()
 Create the guidance ports from the task controllers.
virtual bool createDesiredVelocityPort ()
 Create the guidance ports from the task controllers.
virtual bool createDesiredAccelerationPort ()
 Create the guidance ports from the task controllers.
virtual bool createDesiredHeadingPort ()
 Create the guidance ports from the task controllers.
virtual bool createPositionSelectorPort ()
 Create the guidance ports from the task controllers.
virtual bool createVelocitySelectorPort ()
 Create the guidance ports from the task controllers.
virtual bool createAccelerationSelectorPort ()
 Create the guidance ports from the task controllers.
virtual bool createHeadingSelectorPort ()
 Create the guidance ports from the task controllers.
virtual bool createAggressivenessPort ()
 Create the guidance ports from the task controllers.
virtual bool createPowerDownPort ()
 Create the guidance ports from the task controllers.
virtual DtVectorInputPortdesiredPositionPort ()
 Accessors for guidance ports.
virtual DtVectorInputPortdesiredVelocityPort ()
 Accessors for guidance ports.
virtual DtVectorInputPortdesiredAccelerationPort ()
 Accessors for guidance ports.
virtual DtAnalogInputPortdesiredHeadingPort ()
 Accessors for guidance ports.
virtual DtAnalogInputPortpositionSelectorPort ()
 Accessors for guidance ports.
virtual DtAnalogInputPortvelocitySelectorPort ()
 Accessors for guidance ports.
virtual DtAnalogInputPortaccelerationSelectorPort ()
 Accessors for guidance ports.
virtual DtAnalogInputPortheadingSelectorPort ()
 Accessors for guidance ports.
virtual DtAnalogInputPortaggressivenessPort ()
 Accessors for guidance ports.
virtual DtBooleanInputPortpowerDownPort ()
 Accessors for guidance ports.
virtual bool createRotaryWingControlPortGroup ()
 These are called in init to create the ports used to communicate with the actuator.
virtual bool createThrottlePort ()
 These are called in init to create the ports used to communicate with the actuator.
virtual bool createCollectivePort ()
 These are called in init to create the ports used to communicate with the actuator.
virtual bool createCyclicPort ()
 These are called in init to create the ports used to communicate with the actuator.
virtual bool createPedalPort ()
 These are called in init to create the ports used to communicate with the actuator.
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtControllerComponent ()
 destructor
virtual DtSimRadioradio ()
 The radio this component is listening to.
virtual void taskNotify (const DtSimTask &task)
 This is used by the entity to notify all controllers that a new task has been received.
virtual void clearTask ()
 Called when you want to clear out this component's task state.
- 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 (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 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
virtual bool tickWhileDestroyed () const
 If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
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 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 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 (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual void addAlias (const DtString &alias)
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const 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 DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value.
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

virtual bool createPortGroups ()
 Overridden to call createRotaryWingControlPortGroup() and createGuidancePortGroup()
virtual bool createPorts ()
 Overridden to create rotary wing ports.
virtual void setStateFromPorts ()
 Sets the state repository variables from the ports.
 DtRotaryWingPilotController ()
 default constructor; not implemented
 DtRotaryWingPilotController (const DtRotaryWingPilotController &orig)
 copy constructor; not implemented
const DtRotaryWingPilotControlleroperator= (const DtRotaryWingPilotController &orig)
 assignment operator; not implemented
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
virtual void setRadio (DtSimRadio *radio)
- 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.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Protected Attributes

DtRotaryWingEntityStateRepositorymyRotaryWingEntityState
DtVector myNormalizedBodyVelocity
Ports and Port Groups
DtOutputPortGroupmyRotaryWingControlPortGroup
 Output Port Group Name: rotary-wing-control
Output Port Group Description:
DtConstrainedAnalogOutputPortmyThrottlePort
 Output Port Name: throttle
Output Port Description: The position of the throttle control.
DtConstrainedAnalogOutputPortmyCollectivePort
 Output Port Name: collective
Output Port Description: The position of the collective control.
DtConstrainedDualAxisAnalogOutputPortmyCyclicPort
 Output Port Name: cyclic
Output Port Description: The position of the collective control in X and Y.
DtConstrainedAnalogOutputPortmyPedalPort
 Output Port Name: pedal
Output Port Description: The position of the pedal controls.
DtInputPortGroupmyGuidancePortGroup
 Input Port Group Name: guidance
Input Port Group Description: Group of input ports that define the desired heading/position/velocity/acceleration and flight properties.
DtVectorInputPortmyDesiredPositionPort
 Input Port Name: desired-position
Input Port Description: The desired position of the entity.
DtVectorInputPortmyDesiredVelocityPort
 Input Port Name: desired-velocity
Input Port Description: The desired velocity of the entity
Input Port Range: Database coordinates.
DtVectorInputPortmyDesiredAccelerationPort
 Input Port Name: desired-acceleration
Input Port Description: The desired acceleration of the entity
Input Port Range: Database coordinates.
DtAnalogInputPortmyDesiredHeadingPort
 Input Port Name: desired-heading
Input Port Description:
Input Port Range: -1.
DtAnalogInputPortmyPositionSelectorPort
 Input Port Name: position-selector
Input Port Description: Determines whether the desired-position port is used.
DtAnalogInputPortmyVelocitySelectorPort
 Input Port Name: velocity-selector
Input Port Description: Determines whether the desired-velocity port is used.
DtAnalogInputPortmyAccelerationSelectorPort
 Input Port Name: acceleration-selector
Input Port Description: Determines whether the desired-acceleration port is used.
DtAnalogInputPortmyHeadingSelectorPort
 Input Port Name: heading-selector
Input Port Description: Determines whether the desired-heading port is used.
DtAnalogInputPortmyAggressivenessPort
 Input Port Name: aggressiveness
Input Port Description: How aggressively the autopilot will move the controls to gain the desired values.
DtBooleanInputPortmyPowerDownPort
 Input Port Name: power-down
Input Port Description: Determines whether the control values will all be set to 0.
- Protected Attributes inherited from DtControllerComponent
DtSimRadiomyRadio
 Controller components 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.
- 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.

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

The DtRotaryWingPilotController class creates the rotary-wing-control port group needed to control rotary-wing actuators.

Uses Descriptor Type: DtComponentDescriptor

Constructor & Destructor Documentation

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

destructor

DtRotaryWingPilotController::DtRotaryWingPilotController ( )
protected

default constructor; not implemented

DtRotaryWingPilotController::DtRotaryWingPilotController ( const DtRotaryWingPilotController orig)
protected

copy constructor; not implemented

Member Function Documentation

virtual bool DtRotaryWingPilotController::init ( )
virtual

Overridden to initialize myRotaryWingEntityState.

Reimplemented from DtControllerComponent.

Reimplemented in DtSimpleRotaryWingPilot, and DtRotaryWingJoyFlightController.

virtual void DtRotaryWingPilotController::tick ( )
virtual

Reads the data from the guidance ports into the state repository.

Reimplemented from DtSimComponent.

Reimplemented in DtSimpleRotaryWingPilot.

virtual const char* DtRotaryWingPilotController::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
DtRotaryWingPilotControllerType

Implements DtControllerComponent.

Reimplemented in DtSimpleRotaryWingPilot, and DtRotaryWingJoyFlightController.

virtual bool DtRotaryWingPilotController::createGuidancePortGroup ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createDesiredPositionPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createDesiredVelocityPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createDesiredAccelerationPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createDesiredHeadingPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createPositionSelectorPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createVelocitySelectorPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createAccelerationSelectorPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createHeadingSelectorPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createAggressivenessPort ( )
virtual

Create the guidance ports from the task controllers.

virtual bool DtRotaryWingPilotController::createPowerDownPort ( )
virtual

Create the guidance ports from the task controllers.

virtual DtVectorInputPort* DtRotaryWingPilotController::desiredPositionPort ( )
virtual

Accessors for guidance ports.

virtual DtVectorInputPort* DtRotaryWingPilotController::desiredVelocityPort ( )
virtual

Accessors for guidance ports.

virtual DtVectorInputPort* DtRotaryWingPilotController::desiredAccelerationPort ( )
virtual

Accessors for guidance ports.

virtual DtAnalogInputPort* DtRotaryWingPilotController::desiredHeadingPort ( )
virtual

Accessors for guidance ports.

virtual DtAnalogInputPort* DtRotaryWingPilotController::positionSelectorPort ( )
virtual

Accessors for guidance ports.

virtual DtAnalogInputPort* DtRotaryWingPilotController::velocitySelectorPort ( )
virtual

Accessors for guidance ports.

virtual DtAnalogInputPort* DtRotaryWingPilotController::accelerationSelectorPort ( )
virtual

Accessors for guidance ports.

virtual DtAnalogInputPort* DtRotaryWingPilotController::headingSelectorPort ( )
virtual

Accessors for guidance ports.

virtual DtAnalogInputPort* DtRotaryWingPilotController::aggressivenessPort ( )
virtual

Accessors for guidance ports.

virtual DtBooleanInputPort* DtRotaryWingPilotController::powerDownPort ( )
virtual

Accessors for guidance ports.

virtual bool DtRotaryWingPilotController::createRotaryWingControlPortGroup ( )
virtual

These are called in init to create the ports used to communicate with the actuator.

virtual bool DtRotaryWingPilotController::createThrottlePort ( )
virtual

These are called in init to create the ports used to communicate with the actuator.

virtual bool DtRotaryWingPilotController::createCollectivePort ( )
virtual

These are called in init to create the ports used to communicate with the actuator.

virtual bool DtRotaryWingPilotController::createCyclicPort ( )
virtual

These are called in init to create the ports used to communicate with the actuator.

virtual bool DtRotaryWingPilotController::createPedalPort ( )
virtual

These are called in init to create the ports used to communicate with the actuator.

virtual DtConstrainedAnalogOutputPort* DtRotaryWingPilotController::throttlePort ( )
virtual
virtual DtConstrainedAnalogOutputPort* DtRotaryWingPilotController::collectivePort ( )
virtual
virtual DtConstrainedDualAxisAnalogOutputPort* DtRotaryWingPilotController::cyclicPort ( )
virtual
virtual DtConstrainedAnalogOutputPort* DtRotaryWingPilotController::pedalPort ( )
virtual
static DtSimComponent* DtRotaryWingPilotController::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.

Reimplemented in DtSimpleRotaryWingPilot, and DtRotaryWingJoyFlightController.

virtual bool DtRotaryWingPilotController::createPortGroups ( )
protectedvirtual
virtual bool DtRotaryWingPilotController::createPorts ( )
protectedvirtual

Overridden to create rotary wing ports.

Reimplemented from DtSimComponent.

Reimplemented in DtSimpleRotaryWingPilot.

virtual void DtRotaryWingPilotController::setStateFromPorts ( )
protectedvirtual

Sets the state repository variables from the ports.

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

assignment operator; not implemented

Member Data Documentation

DtRotaryWingEntityStateRepository* DtRotaryWingPilotController::myRotaryWingEntityState
protected
DtOutputPortGroup* DtRotaryWingPilotController::myRotaryWingControlPortGroup
protected

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

DtConstrainedAnalogOutputPort* DtRotaryWingPilotController::myThrottlePort
protected

Output Port Name: throttle
Output Port Description: The position of the throttle control.


Output Port Range: 0. to 1.
Output Port Default Value:
Output Group Parent: rotary-wing-control

DtConstrainedAnalogOutputPort* DtRotaryWingPilotController::myCollectivePort
protected

Output Port Name: collective
Output Port Description: The position of the collective control.


Output Port Range: 0. to 1.
Output Port Default Value:
Output Group Parent: rotary-wing-control

DtConstrainedDualAxisAnalogOutputPort* DtRotaryWingPilotController::myCyclicPort
protected

Output Port Name: cyclic
Output Port Description: The position of the collective control in X and Y.


Output Port Range: X: -1. to 1. Y: -1 to 1.
Output Port Default Value:
Output Group Parent: rotary-wing-control

DtConstrainedAnalogOutputPort* DtRotaryWingPilotController::myPedalPort
protected

Output Port Name: pedal
Output Port Description: The position of the pedal controls.


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

DtInputPortGroup* DtRotaryWingPilotController::myGuidancePortGroup
protected

Input Port Group Name: guidance
Input Port Group Description: Group of input ports that define the desired heading/position/velocity/acceleration and flight properties.


DtVectorInputPort* DtRotaryWingPilotController::myDesiredPositionPort
protected

Input Port Name: desired-position
Input Port Description: The desired position of the entity.


Input Port Range: Database coordinates.
Input Group Parent: guidance

DtVectorInputPort* DtRotaryWingPilotController::myDesiredVelocityPort
protected

Input Port Name: desired-velocity
Input Port Description: The desired velocity of the entity
Input Port Range: Database coordinates.


Input Group Parent: guidance

DtVectorInputPort* DtRotaryWingPilotController::myDesiredAccelerationPort
protected

Input Port Name: desired-acceleration
Input Port Description: The desired acceleration of the entity
Input Port Range: Database coordinates.


Input Group Parent: guidance

DtAnalogInputPort* DtRotaryWingPilotController::myDesiredHeadingPort
protected

Input Port Name: desired-heading
Input Port Description:
Input Port Range: -1.

to 1.
Input Group Parent: guidance

DtAnalogInputPort* DtRotaryWingPilotController::myPositionSelectorPort
protected

Input Port Name: position-selector
Input Port Description: Determines whether the desired-position port is used.

Set to 1.0 to use, otherwise 0.0.
Input Port Range: 0.0 to 1.0
Input Group Parent: guidance

DtAnalogInputPort* DtRotaryWingPilotController::myVelocitySelectorPort
protected

Input Port Name: velocity-selector
Input Port Description: Determines whether the desired-velocity port is used.

Set to 1.0 to use, otherwise 0.0. Desired velocity will be scaled by selector.
Input Port Range: 0.0 to 1.0
Input Group Parent: guidance

DtAnalogInputPort* DtRotaryWingPilotController::myAccelerationSelectorPort
protected

Input Port Name: acceleration-selector
Input Port Description: Determines whether the desired-acceleration port is used.

Set to 1.0 to use, otherwise 0.0.
Input Port Range: 0. to 1.
Input Group Parent: guidance

DtAnalogInputPort* DtRotaryWingPilotController::myHeadingSelectorPort
protected

Input Port Name: heading-selector
Input Port Description: Determines whether the desired-heading port is used.

Set to 1.0 to use, otherwise 0.0.
Input Port Range: 0. to 1.
Input Group Parent: guidance

DtAnalogInputPort* DtRotaryWingPilotController::myAggressivenessPort
protected

Input Port Name: aggressiveness
Input Port Description: How aggressively the autopilot will move the controls to gain the desired values.

0.0 will result in no movement of the controls.
Input Port Range: 0. to 1.
Input Group Parent: guidance

DtBooleanInputPort* DtRotaryWingPilotController::myPowerDownPort
protected

Input Port Name: power-down
Input Port Description: Determines whether the control values will all be set to 0.

Set power-down to true if the entity is landed and you wish it to stay landed on the ground. Setting power-down to true while the entity is not landed will likely result in the entity crashing to the ground. Input Port Range: True/False
Input Group Parent: guidance

DtVector DtRotaryWingPilotController::myNormalizedBodyVelocity
protected

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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)