VR-Forces 4.8 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
DtAutomotiveActuatorComponent Class Reference

DtAutomotiveActuatorComponent provides a kinematics-based model of an automotive system. More...

Inheritance diagram for DtAutomotiveActuatorComponent:
Inheritance graph
[legend]

Public Member Functions

 DtAutomotiveActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtAutomotiveActuatorComponent ()
 destructor More...
 
virtual bool init ()
 Calls createPSR() to create our process state repository. More...
 
virtual const chartype () const
 Returns a string identifies the class type of component. More...
 
virtual void tick ()
 Calculate new kinematic state. 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 preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time. 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...
 
- Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent >
static DtObjectCounter::CounterType ObjectCount ()
 
static const DtObjectContainer * ObjectContainer ()
 

Protected Member Functions

virtual double maxSpeedSoilFactor () const
 
virtual double accelSoilFactor () const
 
virtual double decelSoilFactor () const
 
virtual DtString soilTypeString () const
 Returns the soil type under the groundCenter interaction point. More...
 
virtual DtSoilFactorssoilFactors (const DtString &soilType) const
 
virtual void useFuel (double fuelUsed)
 Looks up the resource named “fuel” in the entity’s Resource Manager. More...
 
virtual double fuelLeft () const
 Looks up the resource named “fuel” in the entity’s Resource Manager. More...
 
virtual void updateRepository (const DtVector &localPosition, const DtVector &localVelocity, const DtVector &localAcceleration, const DtTaitBryan &localOrientation, const DtVector &rotationalVelocity, double newHeading)
 Updates the local state repository: It places the position, velocity, acceleration, and orientation arguments into the local repository. More...
 
virtual double calculateMaxDecelerationFromBrake (double brake)
 
virtual double calculateAccelerationFromEngine (double throttle, double speed, DtAutoTransmissionGear gear, double pitch)
 
virtual void calculateFactorsFromSoilAndWeather (const DtVector &location, double &tractionFactor, double &dragFactor)
 Calculates factors affecting drag of the soil and limits on traction based on soil type and weather. More...
 
virtual double calculateMaximumTractionAcceleration (const double tractionFactor)
 Calculates the maximum traction force available. More...
 
virtual double calculateSoilDragDeceleration (const double dragFactor, const double speed)
 Calculates the drag acceleration caused by the drag factor. More...
 
virtual double calculateAccelerationFromSlope (double pitch)
 
virtual void calculateOrientationAndPosition (const DtVector &newLocalProjectedLocation, double newHeading, DtDcm &newLocalOrientation, DtVector &newLocalPosition)
 Calculates the orientation and position of the entity, given a new location and heading. More...
 
virtual bool useHighFidelityGroundClamping () const
 
virtual bool useNavDataGroundClamping () const
 
bool groundClamp (double heading, const DtVector &location, DtAttachedTerrain &terrain, DtVector &newNormal, bool &dataAvailable)
 Clamps the entity to the ground at the specified location, and determines the normal of the plane the entity is on at that location. More...
 
void groundClampHighFidelity (double heading, const DtVector &location, DtAttachedTerrain &terrain, DtVector &newNormal, bool &dataAvailable)
 Uses all four ground interaction points to determine the plane of the entity and the soil type. More...
 
void groundClampLowFidelity (double heading, const DtVector &location, DtAttachedTerrain &terrain, DtVector &newNormal, bool &dataAvailable)
 Uses only the center ground interaction point. More...
 
void groundClampWithNavData (double heading, const DtVector &location, DtAttachedTerrain &terrain, DtVector &newNormal)
 Uses nav data for ground clamping. More...
 
virtual double calculateHeading (const double oldHeading, const DtVector &oldBodyVelocity, const DtAutoTransmissionGear gear, const double steering, const double throttle, const double speed, const double maxTractionAcceleration, const double soilDragFactor, const double dT)
 Determines the new heading given the old heading, the velocity, gear, steering, throttle, tractionFactor, and time delta. More...
 
virtual DtVector calculateBodyAcceleration (double throttle, DtAutoTransmissionGear gear, double brake, const DtVector &oldBodyVelocity, double oldPitch, double maxTractionAcceleration, double dragFactor, double dT)
 Calculates the linear acceleration in body coordinates of the entity in meters/second/second. More...
 
virtual DtVector calculateBodyVelocity (const DtVector &oldBodyVelocity, const DtVector &newBodyAcceleration, double dT)
 
virtual DtVector calculateProjectedLocation (const DtVector &oldLocalPosition, const DtVector &newBodyAcceleration, const DtVector &oldBodyVelocity, double newHeading)
 
virtual bool checkForTerrainCollisions () const
 
virtual bool foundTerrainCollision (double heading, const DtVector &oldLocalPosition, const DtVector &newLocalPosition, DtVrfChordIntersectionRecord &collisionIntersectionRecord) const
 Checks the terrain in between the specified old and new positions, along the specified heading for any terrain intersections. More...
 
virtual bool createMovementChord (DtChord &movementChord, double heading, const DtVector &oldLocalPosition, const DtVector &newLocalPosition) const
 Creates a chord along the specified heading, starting at the old position and ending at the new position, but each location is increased by the half height of the entity so that the check is done along the center of the entity's movement. More...
 
virtual bool terrainPassable (double heading, const DtVrfChordIntersectionRecord &terrainIntersectionRecord) const
 Determines if the terrain referenced in the intersection record is "passable" by the entity. More...
 
virtual double calculateMaxSpeed ()
 Calculates the maximum speed for the entity, considering soil factors. More...
 
virtual double calculateMaxAcceleration ()
 TODO – used? More...
 
virtual void calculateDirectionOfLinearMotion (const DtDcm &newLocalOrientation, const DtVector &newLocalPosition, DtDcm &newLocalDirectionOfLinearMotion)
 Computes direction of linear motion. More...
 
virtual double slopeBoostRate () const
 Slope boost rate– entity parameters provide a max acceleration, which is related to max power, but also a max slope. More...
 
virtual void setSlopeBoostRate (const double boost)
 
virtual double calculateSlopeBoostRate ()
 Calculate the boost rate for an entity, based on their allowed max acceleration and the maximum slope they are supposed to be able to climb. More...
 
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 bool rotationalVelocityShouldBeClamped (const DtVector &bodyRotationalVelocity)
 Returns true if given magnitude of body rotational velocity is < 0.0001 radians/sec, false otherwise. More...
 
virtual double steeringControlValue () const
 
virtual double throttleControlValue () const
 
virtual double brakeControlValue () const
 
virtual DtAutoTransmissionGear gearControlValue () const
 
virtual bool parkingBrakeControlValue () const
 
virtual bool checkIfMoveOntoEmbarked (const DtVector &localPosition)
 Check to see if there are any entities at the location given that can be moved onto for embarkation. More...
 
virtual bool checkAndDisembarkIfEmbarked (const DtVector &localPosition)
 
- 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 Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 
 DtObjectDebugger (const DtObjectDebugger &)
 
 ~DtObjectDebugger ()
 

Protected Attributes

DtGroundVehicleStateRepositorymyGroundVehicleState
 
DtAutomotivePSRmyProcessState
 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...
 
Ports and Port Groups
DtConstrainedAnalogInputPortmyThrottlePort
 Input Port Name: throttle
Input Port Description:
Input Port Range:
Input Port Default Value: 0
Input Group Parent: More...
 
DtConstrainedAnalogInputPortmySteeringPort
 Input Port Name: steering
Input Port Description:
Input Port Range: -1.0 to 1.0
Input Port Default Value: 0
Input Group Parent: More...
 
DtConstrainedAnalogInputPortmyBrakePort
 Input Port Name: brake
Input Port Description:
Input Port Range: 0.0 to 1.0
Input Port Default Value: 0
Input Group Parent: automotive-control. More...
 
DtConstrainedIntegerInputPortmyGearPort
 Input Port Name: gear
Input Port Description:
Input Port Default Value: 0
Input Port Range: Reverse, Neutral, Forward, Pivot
Input Group Parent: automotive-control. More...
 
DtBooleanInputPortmyParkingBrakePort
 Input Port Name: parking-brake
Input Port Description:
Input Port Range:
Input Port Default Value: True (Brake On)
Input Group Parent: automotive-control. More...
 
DtInputPortGroupmyAutomotiveControlPortGroup
 Input Port Group Name: automotive-control
Input Port Group Description: Provides input to the automotive actuator (powertrain). More...
 
DtBooleanInputPortmyClampToNavDataPort
 Input Port Name: clamp-to-nav-data
Input Port Description: Tells the actuator that it should temporarily use nav data for ground clamping rather than the terrain. More...
 
Temporary variables, not saved to PSR
const
DtAutomotiveActuatorDescriptor
myAutomotiveDescriptor
 
bool myKeepParentPosition
 
DtUUID myWasJustEmbarkedOn
 
double myLastPitch
 
double myLastPitchHeading
 
DtVector myLastPitchLocation
 
double mySlopeBoostRate
 
- 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

 DtAutomotiveActuatorComponent ()
 Default constructor; not implemented. More...
 
 DtAutomotiveActuatorComponent (const DtAutomotiveActuatorComponent &orig)
 Copy constructor; not implemented. More...
 
const
DtAutomotiveActuatorComponent
operator= (const DtAutomotiveActuatorComponent &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

DtAutomotiveActuatorComponent provides a kinematics-based model of an automotive system.

End User Description: The DtAutomotiveActuatorComponent converts throttle, brake, and steering into orientation, acceleration, velocity, and position.

Examples

Constructor & Destructor Documentation

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

destructor

DtAutomotiveActuatorComponent::DtAutomotiveActuatorComponent ( )
private

Default constructor; not implemented.

DtAutomotiveActuatorComponent::DtAutomotiveActuatorComponent ( const DtAutomotiveActuatorComponent orig)
private

Copy constructor; not implemented.

Member Function Documentation

virtual bool DtAutomotiveActuatorComponent::init ( )
virtual

Calls createPSR() to create our process state repository.

Reimplemented from DtActuatorComponent.

Reimplemented in MyActuatorComponent.

virtual const char* DtAutomotiveActuatorComponent::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
DtAutomotiveActuatorType

Implements DtSimComponent.

Reimplemented in MyActuatorComponent.

virtual void DtAutomotiveActuatorComponent::tick ( )
virtual

Calculate new kinematic state.

Reimplemented from DtSimComponent.

Reimplemented in MyActuatorComponent.

static DtSimComponent* DtAutomotiveActuatorComponent::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 double DtAutomotiveActuatorComponent::maxSpeedSoilFactor ( ) const
protectedvirtual
Returns
Max speed factor (0-1.) for the current terrain.
virtual double DtAutomotiveActuatorComponent::accelSoilFactor ( ) const
protectedvirtual
Returns
Acceleration factor (0-1.) for the current terrain.
virtual double DtAutomotiveActuatorComponent::decelSoilFactor ( ) const
protectedvirtual
Returns
Deceleration factor (0-1.) for the current terrain.
virtual DtString DtAutomotiveActuatorComponent::soilTypeString ( ) const
protectedvirtual

Returns the soil type under the groundCenter interaction point.

virtual DtSoilFactors* DtAutomotiveActuatorComponent::soilFactors ( const DtString soilType) const
protectedvirtual
Returns
Ptr to the soil factors instance in the entity's parameter entry.
NULL if the entity is on unspecified type terrain.
virtual void DtAutomotiveActuatorComponent::useFuel ( double  fuelUsed)
protectedvirtual

Looks up the resource named “fuel” in the entity’s Resource Manager.

If the resource is not found, useFuel() just returns. If the resource is found, the amount of fuel passed as the argument to useFuel() is deducted from the resource. When the resource reaches 0, a warning is printed (using DtWarn).

Parameters
fuelUsedAmount of fuel to deplete.
virtual double DtAutomotiveActuatorComponent::fuelLeft ( ) const
protectedvirtual

Looks up the resource named “fuel” in the entity’s Resource Manager.

If the resource is not found, it returns an appropriately large constant to implement unlimited fuel. Otherwise, the value of the resource is returned.

Returns
Amount of fuel resource still available.
virtual void DtAutomotiveActuatorComponent::updateRepository ( const DtVector localPosition,
const DtVector localVelocity,
const DtVector localAcceleration,
const DtTaitBryan &  localOrientation,
const DtVector rotationalVelocity,
double  newHeading 
)
protectedvirtual

Updates the local state repository: It places the position, velocity, acceleration, and orientation arguments into the local repository.

It puts the heading into the repository. It calculates the current speed from the velocity vector passed and sets that value in the local repository. It calculates the distance traveled this frame (speed * dT) and uses that and the fuel consumption ground vehicle parameter to determine the fuel used, and then calls useFuel().

Parameters
localPositionPosition in local (database) coordinates in meters.
localVelocityVelocity in local (database) coordinates in meters/second.
localVelocityVelocity in local (database) coordinates in meters/second/second.
localOrientationLocal orientation of entity in radians.
rotationalVelocityIn radians/second.
newHeadingIn radians.
virtual double DtAutomotiveActuatorComponent::calculateMaxDecelerationFromBrake ( double  brake)
protectedvirtual
Returns
The maximum possible deceleration resulting from the current application of the brake for this tick. This value is always non-negative, regardless of direction of movement. This calculation does not consider traction limits of soil or weather.
virtual double DtAutomotiveActuatorComponent::calculateAccelerationFromEngine ( double  throttle,
double  speed,
DtAutoTransmissionGear  gear,
double  pitch 
)
protectedvirtual
Returns
The acceleration resulting from the internal engine systems of this entity. Result is signed, with positive being body-forward acceleration and negative body-reverse. Assumes that the vehicle is moving in the direction that its gear enables. Acceleration = the entity parameter max acceleration at speed 0, but decreases to zero at entity parameter value of max speed; there are no effects from soil or slope included.
virtual void DtAutomotiveActuatorComponent::calculateFactorsFromSoilAndWeather ( const DtVector location,
double tractionFactor,
double dragFactor 
)
protectedvirtual

Calculates factors affecting drag of the soil and limits on traction based on soil type and weather.

Parameters
locationEntity location in local coordinates.
tractionFactorOutput factor. 1.0 = perfect traction, 0 = no traction.
dragFactorOutput factor. 1.0 = no soil drag; 0 = high soil drag (0.01 is effectively the minimum value).
virtual double DtAutomotiveActuatorComponent::calculateMaximumTractionAcceleration ( const double  tractionFactor)
protectedvirtual

Calculates the maximum traction force available.

This is the max that can be used for acceleration or braking, or lateral acceleration. Computed from maxStoppingAcceleration * tractionFactor.

Returns
A positive acceleration value; the value must be signed appropriately for forward and reverse movement.
virtual double DtAutomotiveActuatorComponent::calculateSoilDragDeceleration ( const double  dragFactor,
const double  speed 
)
protectedvirtual

Calculates the drag acceleration caused by the drag factor.

Normally the dragFactor comes from calculateFactorsFromSoilAndWeather. The calculation multiplies a constant by speed^2 x (1-factor)/factor. Factor values below 0.01 are treated as 0.01. The constant in 0.02, estimated empirically.

Returns
A positive value representing deceleration.
virtual double DtAutomotiveActuatorComponent::calculateAccelerationFromSlope ( double  pitch)
protectedvirtual
Parameters
pitchis the inclination of the ground as an angle in radians.
Returns
The acceleration resulting from the specified slope.
Note
Returns a signed value, representing body-forward acceleration.
virtual void DtAutomotiveActuatorComponent::calculateOrientationAndPosition ( const DtVector newLocalProjectedLocation,
double  newHeading,
DtDcm &  newLocalOrientation,
DtVector newLocalPosition 
)
protectedvirtual

Calculates the orientation and position of the entity, given a new location and heading.

Checks for intersections with the terrain, to determine altitude and orientation (from support points) from 1/4 of the height of the entity's bounding volume as a rough approximation of the entity's wheel's or tread (or knees).

Returns
nothing, but sets the specified orientation and position appropriately.
Note
As a side effect, this also fills in the soil type, position, and altitude information of the groundCenter of the vrfObject. This is done through the placePoints() call from the state repository.
virtual bool DtAutomotiveActuatorComponent::useHighFidelityGroundClamping ( ) const
protectedvirtual
Returns
a boolean signifying whether or not to use high fidelity ground clamping when calculating the orientation of the entity.
Note
it currently just returns the value of the user specified parameter in the automotivePSR, which defaults to true.
virtual bool DtAutomotiveActuatorComponent::useNavDataGroundClamping ( ) const
protectedvirtual
Returns
a boolean signifying whether or not to use nav data for ground clamping when calculating the orientation of the entity.
bool DtAutomotiveActuatorComponent::groundClamp ( double  heading,
const DtVector location,
DtAttachedTerrain terrain,
DtVector newNormal,
bool dataAvailable 
)
protected

Clamps the entity to the ground at the specified location, and determines the normal of the plane the entity is on at that location.

Returns
a boolean indicating success or failure in performing the ground clamping and determining the new normal.
Note
As a side effect of this function, the soil type in the center ground interaction point is set.

The type of ground clamping also depends on the entity's configuration. Either high or low fidelity ground clamping is performed as specified.

See Also
groundClampHighFidelity
groundClampLowFidelity
void DtAutomotiveActuatorComponent::groundClampHighFidelity ( double  heading,
const DtVector location,
DtAttachedTerrain terrain,
DtVector newNormal,
bool dataAvailable 
)
protected

Uses all four ground interaction points to determine the plane of the entity and the soil type.

The left, right, and other support points are used to determine the plane, and the returned normal is the normal to that plane.

void DtAutomotiveActuatorComponent::groundClampLowFidelity ( double  heading,
const DtVector location,
DtAttachedTerrain terrain,
DtVector newNormal,
bool dataAvailable 
)
protected

Uses only the center ground interaction point.

The normal is the normal of the polygon on which the center point sits. And the soil type is also the polygon's. This requires fewer intersection tests with the terrain, but also may return an incorrect normal if the entity is sitting across several polygons.

void DtAutomotiveActuatorComponent::groundClampWithNavData ( double  heading,
const DtVector location,
DtAttachedTerrain terrain,
DtVector newNormal 
)
protected

Uses nav data for ground clamping.

Only used in certain circumstances when nav data is not readily available.

virtual double DtAutomotiveActuatorComponent::calculateHeading ( const double  oldHeading,
const DtVector oldBodyVelocity,
const DtAutoTransmissionGear  gear,
const double  steering,
const double  throttle,
const double  speed,
const double  maxTractionAcceleration,
const double  soilDragFactor,
const double  dT 
)
protectedvirtual

Determines the new heading given the old heading, the velocity, gear, steering, throttle, tractionFactor, and time delta.

Parameters
gearDtAutoTransmission value for gear.
steeringInput value in [-1, 1] for steering. Note that when steering = -1 or 1, the vehicle should steer at its minimum turn radius.
throttleInput value in [0, 1] for throttle setting
maxTractionAccelerationThe maximum acceleration that can be applied to the ground by the wheels/tracks forward or backward. Always positive.
soilDragFactorA value in [0, 1] that indicates the amount of drag caused by the soil, where 1 = no (extra) drag.
Returns
The new heading value.
virtual DtVector DtAutomotiveActuatorComponent::calculateBodyAcceleration ( double  throttle,
DtAutoTransmissionGear  gear,
double  brake,
const DtVector oldBodyVelocity,
double  oldPitch,
double  maxTractionAcceleration,
double  dragFactor,
double  dT 
)
protectedvirtual

Calculates the linear acceleration in body coordinates of the entity in meters/second/second.

Calls following functions for components of the acceleration: calculateAccelerationFromEngine() calculateAccelerationFromSlope() calculateMaxDecelerationFromBrake()

virtual DtVector DtAutomotiveActuatorComponent::calculateBodyVelocity ( const DtVector oldBodyVelocity,
const DtVector newBodyAcceleration,
double  dT 
)
protectedvirtual
virtual DtVector DtAutomotiveActuatorComponent::calculateProjectedLocation ( const DtVector oldLocalPosition,
const DtVector newBodyAcceleration,
const DtVector oldBodyVelocity,
double  newHeading 
)
protectedvirtual
virtual bool DtAutomotiveActuatorComponent::checkForTerrainCollisions ( ) const
protectedvirtual
Returns
a boolean signifying whether or not the terrain should be checked for collisions with the entity's bounding volume while it moves. If this returns true, the entity will not move through the terrain. If this is false, it may move through terrain polygons, such as building walls when moving to a new location.
Note
it currently just returns the value of the user specified parameter in the automotivePSR.
virtual bool DtAutomotiveActuatorComponent::foundTerrainCollision ( double  heading,
const DtVector oldLocalPosition,
const DtVector newLocalPosition,
DtVrfChordIntersectionRecord collisionIntersectionRecord 
) const
protectedvirtual

Checks the terrain in between the specified old and new positions, along the specified heading for any terrain intersections.

Returns
a boolean signifying whether or not a terrain collision was found. If so, a valid intersection record is returned in the user specified intersection record.
virtual bool DtAutomotiveActuatorComponent::createMovementChord ( DtChord movementChord,
double  heading,
const DtVector oldLocalPosition,
const DtVector newLocalPosition 
) const
protectedvirtual

Creates a chord along the specified heading, starting at the old position and ending at the new position, but each location is increased by the half height of the entity so that the check is done along the center of the entity's movement.

Additionally, the chord is extended in the heading direction by the half-length of the entity to ensure that collision with the front of the entity and not just the center, are detected.

Returns
a boolean signifying whether or not the chord could be created.
Note
Returns a valid chord in movementChord only if the return value is true.
virtual bool DtAutomotiveActuatorComponent::terrainPassable ( double  heading,
const DtVrfChordIntersectionRecord terrainIntersectionRecord 
) const
protectedvirtual

Determines if the terrain referenced in the intersection record is "passable" by the entity.

Currently, just looks at the slope of the terrain. If the slope is greater than 80 degrees, the terrain is considered impassable.

virtual double DtAutomotiveActuatorComponent::calculateMaxSpeed ( )
protectedvirtual

Calculates the maximum speed for the entity, considering soil factors.

virtual double DtAutomotiveActuatorComponent::calculateMaxAcceleration ( )
protectedvirtual

TODO – used?

Calculates the maximum acceleration for the entity, considering soil factors

virtual void DtAutomotiveActuatorComponent::calculateDirectionOfLinearMotion ( const DtDcm &  newLocalOrientation,
const DtVector newLocalPosition,
DtDcm &  newLocalDirectionOfLinearMotion 
)
protectedvirtual

Computes direction of linear motion.

In base class, this is equivalent to newLocalOrientation, so it sets newLocalDirectionOfLinearMotion = newLocalOrientation.

virtual double DtAutomotiveActuatorComponent::slopeBoostRate ( ) const
protectedvirtual

Slope boost rate– entity parameters provide a max acceleration, which is related to max power, but also a max slope.

If max acceleration indicates the max forward force the vehicle can generate, then that would determine the max slope (i.e. max slope = asin(max acceleration/g)). Since max slope is given separately, that must indicate the force available, apparently through low gearing.

virtual void DtAutomotiveActuatorComponent::setSlopeBoostRate ( const double  boost)
protectedvirtual
virtual double DtAutomotiveActuatorComponent::calculateSlopeBoostRate ( )
protectedvirtual

Calculate the boost rate for an entity, based on their allowed max acceleration and the maximum slope they are supposed to be able to climb.

Since the actuator computes acceleration from a = f(throttle, speed, max acceleration) - slope acceleration, where f is the engine acceleration, we provide a boost to f so that it remains > slope acceleration up to max slope.
Boost = pitch / (max pitch) * (slope acceleration at max slope - f at 1 mps) * throttle. This boost will allow the vehicle to maintain 1 mps speed at full throttle at its max slope. The value of Boost/slope/throttle is computed and set in init().

virtual bool DtAutomotiveActuatorComponent::createPortGroups ( )
protectedvirtual

Creates the local port groups.

Reimplemented from DtSimComponent.

virtual bool DtAutomotiveActuatorComponent::createPorts ( )
protectedvirtual

Creates the input ports and adds them to the component.

Reimplemented from DtSimComponent.

virtual bool DtAutomotiveActuatorComponent::createPSR ( )
protectedvirtual

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

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

virtual bool DtAutomotiveActuatorComponent::rotationalVelocityShouldBeClamped ( const DtVector bodyRotationalVelocity)
protectedvirtual

Returns true if given magnitude of body rotational velocity is < 0.0001 radians/sec, false otherwise.

Called in tick() to determine whether or not to clamp small values for velocity to zero.

virtual double DtAutomotiveActuatorComponent::steeringControlValue ( ) const
protectedvirtual
Returns
Value on mySteeringPort if an active connection, otherwise 0.
virtual double DtAutomotiveActuatorComponent::throttleControlValue ( ) const
protectedvirtual
Returns
Value on myThrottlePort if an active connection, otherwise 0.
virtual double DtAutomotiveActuatorComponent::brakeControlValue ( ) const
protectedvirtual
Returns
Value on myBreakPort if an active connection, otherwise 1.
virtual DtAutoTransmissionGear DtAutomotiveActuatorComponent::gearControlValue ( ) const
protectedvirtual
Returns
Value on myGearPort if an active connection, otherwise DtAutoGearForward.
virtual bool DtAutomotiveActuatorComponent::parkingBrakeControlValue ( ) const
protectedvirtual
Returns
Value on myParkingBrakePort if an active connection, otherwise false.
virtual bool DtAutomotiveActuatorComponent::checkIfMoveOntoEmbarked ( const DtVector localPosition)
protectedvirtual

Check to see if there are any entities at the location given that can be moved onto for embarkation.

If ther are then check to see if they are intersected. Return true if is

virtual bool DtAutomotiveActuatorComponent::checkAndDisembarkIfEmbarked ( const DtVector localPosition)
protectedvirtual
const DtAutomotiveActuatorComponent& DtAutomotiveActuatorComponent::operator= ( const DtAutomotiveActuatorComponent orig)
private

assignment operator; not implemented

Member Data Documentation

DtConstrainedAnalogInputPort* DtAutomotiveActuatorComponent::myThrottlePort
protected

Input Port Name: throttle
Input Port Description:
Input Port Range:
Input Port Default Value: 0
Input Group Parent:

DtConstrainedAnalogInputPort* DtAutomotiveActuatorComponent::mySteeringPort
protected

Input Port Name: steering
Input Port Description:
Input Port Range: -1.0 to 1.0
Input Port Default Value: 0
Input Group Parent:

DtConstrainedAnalogInputPort* DtAutomotiveActuatorComponent::myBrakePort
protected

Input Port Name: brake
Input Port Description:
Input Port Range: 0.0 to 1.0
Input Port Default Value: 0
Input Group Parent: automotive-control.

DtConstrainedIntegerInputPort* DtAutomotiveActuatorComponent::myGearPort
protected

Input Port Name: gear
Input Port Description:
Input Port Default Value: 0
Input Port Range: Reverse, Neutral, Forward, Pivot
Input Group Parent: automotive-control.

DtBooleanInputPort* DtAutomotiveActuatorComponent::myParkingBrakePort
protected

Input Port Name: parking-brake
Input Port Description:
Input Port Range:
Input Port Default Value: True (Brake On)
Input Group Parent: automotive-control.

DtInputPortGroup* DtAutomotiveActuatorComponent::myAutomotiveControlPortGroup
protected

Input Port Group Name: automotive-control
Input Port Group Description: Provides input to the automotive actuator (powertrain).

DtBooleanInputPort* DtAutomotiveActuatorComponent::myClampToNavDataPort
protected

Input Port Name: clamp-to-nav-data
Input Port Description: Tells the actuator that it should temporarily use nav data for ground clamping rather than the terrain.


Input Port Range:
Input Port Default Value: False

DtGroundVehicleStateRepository* DtAutomotiveActuatorComponent::myGroundVehicleState
protected
DtAutomotivePSR* DtAutomotiveActuatorComponent::myProcessState
protected

Container for state data associated with this component.

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

DtUpdateRepositoryOutputPortGroup* DtAutomotiveActuatorComponent::myUpdateRepositoryOutputPortGroup
protected

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

All values are in local coordinates

const DtAutomotiveActuatorDescriptor* DtAutomotiveActuatorComponent::myAutomotiveDescriptor
protected
bool DtAutomotiveActuatorComponent::myKeepParentPosition
protected
DtUUID DtAutomotiveActuatorComponent::myWasJustEmbarkedOn
protected
double DtAutomotiveActuatorComponent::myLastPitch
protected
double DtAutomotiveActuatorComponent::myLastPitchHeading
protected
DtVector DtAutomotiveActuatorComponent::myLastPitchLocation
protected
double DtAutomotiveActuatorComponent::mySlopeBoostRate
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)