chrono::vehicle::ChBrakeShafts Class Referenceabstract
  Description
Brake for wheeled vehicles modeled using a clutch between two shafts.
#include <ChBrakeShafts.h>
Inheritance diagram for chrono::vehicle::ChBrakeShafts:

Collaboration diagram for chrono::vehicle::ChBrakeShafts:

| Public Member Functions | |
| ChBrakeShafts (const std::string &name) | |
| virtual std::string | GetTemplateName () const override | 
| Get the name of the vehicle subsystem template. | |
| virtual void | Construct (std::shared_ptr< ChChassis > chassis, std::shared_ptr< ChSuspension > suspension, VehicleSide side) override | 
| Construct the brake by associating it to an existing suspension subsystem.  More... | |
| virtual void | Synchronize (double time, double braking) override | 
| Update the brake subsystem for the given braking driver input.  More... | |
| virtual double | GetBrakeTorque () override | 
| Get the current brake torque. | |
|  Public Member Functions inherited from chrono::vehicle::ChBrake | |
| void | Initialize (std::shared_ptr< ChChassis > chassis, std::shared_ptr< ChSuspension > suspension, VehicleSide side) | 
| Initialize the brake by associating it to an existing suspension subsystem.  More... | |
| virtual void | Advance (double step) | 
| Advance the state of the brake subsystem by the specified time step. | |
| void | EnableLocking (bool val) | 
| Enable/disable ability of locking (default: false).  More... | |
|  Public Member Functions inherited from chrono::vehicle::ChPart | |
| const std::string & | GetName () const | 
| Get the name identifier for this subsystem. | |
| void | SetName (const std::string &name) | 
| Set the name identifier for this subsystem. | |
| bool | IsInitialized () const | 
| Return flag indicating whether or not the part is fully constructed. | |
| virtual uint16_t | GetVehicleTag () const | 
| Get the tag of the associated vehicle.  More... | |
| int | GetBodyTag () const | 
| Get the tag for component bodies. | |
| double | GetMass () const | 
| Get the subsystem mass.  More... | |
| const ChFrame & | GetCOMFrame () const | 
| Get the current subsystem COM frame (relative to and expressed in the subsystem's reference frame).  More... | |
| const ChMatrix33 & | GetInertia () const | 
| Get the current subsystem inertia (relative to the subsystem COM frame).  More... | |
| const ChFrame & | GetTransform () const | 
| Get the current subsystem position relative to the global frame.  More... | |
| void | SetVisualizationType (VisualizationType vis) | 
| Set the visualization mode for this subsystem. | |
| virtual void | AddVisualizationAssets (VisualizationType vis) | 
| Add visualization assets to this subsystem, for the specified visualization mode. | |
| virtual void | RemoveVisualizationAssets () | 
| Remove all visualization assets from this subsystem. | |
| virtual void | SetOutput (bool state) | 
| Enable/disable output for this subsystem. | |
| bool | OutputEnabled () const | 
| Return the output state for this subsystem. | |
| virtual void | ExportComponentList (rapidjson::Document &jsonDocument) const | 
| Export this subsystem's component list to the specified JSON object.  More... | |
| virtual void | Output (ChOutput &database) const | 
| Output data for this subsystem's component list to the specified database. | |
| Protected Member Functions | |
| virtual double | GetShaftInertia ()=0 | 
| Get the brake shaft inertia. | |
| virtual double | GetMaxBrakingTorque ()=0 | 
| Get the max braking torque (for modulation =1) | |
|  Protected Member Functions inherited from chrono::vehicle::ChBrake | |
| ChBrake (const std::string &name) | |
| virtual void | InitializeInertiaProperties () override | 
| Initialize subsystem inertia properties.  More... | |
| virtual void | UpdateInertiaProperties () override | 
| Update subsystem inertia properties.  More... | |
|  Protected Member Functions inherited from chrono::vehicle::ChPart | |
| ChPart (const std::string &name) | |
| Construct a vehicle subsystem with the specified name. | |
| void | AddMass (double &mass) | 
| Add this subsystem's mass.  More... | |
| void | AddInertiaProperties (ChVector3d &com, ChMatrix33<> &inertia) | 
| Add this subsystem's inertia properties.  More... | |
| virtual void | Create (const rapidjson::Document &d) | 
| Create a vehicle subsystem from JSON data.  More... | |
| void | ExportBodyList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChBody >> bodies) const | 
| Export the list of bodies to the specified JSON document. | |
| void | ExportShaftList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChShaft >> shafts) const | 
| Export the list of shafts to the specified JSON document. | |
| void | ExportJointList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLink >> joints) const | 
| Export the list of joints to the specified JSON document. | |
| void | ExportCouplesList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChShaftsCouple >> couples) const | 
| Export the list of shaft couples to the specified JSON document. | |
| void | ExportMarkerList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChMarker >> markers) const | 
| Export the list of markers to the specified JSON document. | |
| void | ExportLinSpringList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLinkTSDA >> springs) const | 
| Export the list of translational springs to the specified JSON document. | |
| void | ExportRotSpringList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLinkRSDA >> springs) const | 
| Export the list of rotational springs to the specified JSON document. | |
| void | ExportBodyLoadList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLoadBodyBody >> loads) const | 
| Export the list of body-body loads to the specified JSON document. | |
| Protected Attributes | |
| double | m_modulation | 
| current braking input | |
| bool | m_locked | 
| is brake locked? | |
| std::shared_ptr< ChShaft > | m_shaft | 
| shaft attached to "fixed" body | |
| std::shared_ptr< ChShaftsClutch > | m_clutch | 
| clutch between the brake shaft and axle shaft | |
|  Protected Attributes inherited from chrono::vehicle::ChBrake | |
| bool | m_can_lock | 
| can the brake lock? | |
|  Protected Attributes inherited from chrono::vehicle::ChPart | |
| std::string | m_name | 
| subsystem name | |
| bool | m_initialized | 
| specifies whether or not the part is fully constructed | |
| bool | m_output | 
| specifies whether or not output is generated for this subsystem | |
| std::shared_ptr< ChPart > | m_parent | 
| parent subsystem (empty if parent is vehicle) | |
| double | m_mass | 
| subsystem mass | |
| ChMatrix33 | m_inertia | 
| inertia tensor (relative to subsystem COM) | |
| ChFrame | m_com | 
| COM frame (relative to subsystem reference frame) | |
| ChFrame | m_xform | 
| subsystem frame expressed in the global frame | |
| int | m_obj_tag | 
| tag for part objects | |
| Additional Inherited Members | |
|  Static Public Member Functions inherited from chrono::vehicle::ChPart | |
| static ChMatrix33 | TransformInertiaMatrix (const ChVector3d &moments, const ChVector3d &products, const ChMatrix33<> &vehicle_rot, const ChMatrix33<> &body_rot) | 
| Utility function for transforming inertia tensors between centroidal frames.  More... | |
|  Static Protected Member Functions inherited from chrono::vehicle::ChPart | |
| static void | RemoveVisualizationAssets (std::shared_ptr< ChPhysicsItem > item) | 
| Erase all visual shapes from the visual model associated with the specified physics item (if any). | |
| static void | RemoveVisualizationAsset (std::shared_ptr< ChPhysicsItem > item, std::shared_ptr< ChVisualShape > shape) | 
| Erase the given shape from the visual model associated with the specified physics item (if any). | |
Member Function Documentation
◆ Construct()
| 
 | overridevirtual | 
Construct the brake by associating it to an existing suspension subsystem.
- Parameters
- 
  chassis associated chassis subsystem suspension associated suspension subsystem side brake mounted on left/right side 
Implements chrono::vehicle::ChBrake.
◆ Synchronize()
| 
 | overridevirtual | 
Update the brake subsystem for the given braking driver input.
The input value is in the range [0,1].
 
braking = 0 indicates no braking braking = 1 indicates that the subsystem should provide maximum braking torque
Implements chrono::vehicle::ChBrake.
The documentation for this class was generated from the following files:
- /builds/uwsbel/chrono/src/chrono_vehicle/wheeled_vehicle/brake/ChBrakeShafts.h
- /builds/uwsbel/chrono/src/chrono_vehicle/wheeled_vehicle/brake/ChBrakeShafts.cpp
