Description

Base class for a brake subsystem.

#include <ChBrake.h>

Inheritance diagram for chrono::vehicle::ChBrake:

[legend]

Collaboration diagram for chrono::vehicle::ChBrake:

[legend]

Public Member Functions
virtual void	Initialize (std::shared_ptr< ChChassis > chassis, std::shared_ptr< ChSuspension > suspension, VehicleSide side)=0
	Initialize the brake by associating it to an existing suspension subsystem. More...

virtual void	Synchronize (double modulation)=0
	Update the brake subsystem: set the brake modulation. More...

void	EnableLocking (bool val)
	Enable/disable ability of locking (default: false). More...

virtual double	GetBrakeTorque ()=0
	Get the current brake torque.

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.

virtual std::string	GetTemplateName () const =0
	Get the name of the vehicle subsystem template.

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 (ChVehicleOutput &database) const
	Output data for this subsystem's component list to the specified database.

Protected Member Functions
	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 (ChVector<> &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...

Protected Attributes
bool	m_can_lock
	can the brake lock?

Protected Attributes inherited from chrono::vehicle::ChPart
std::string	m_name
	subsystem name

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

Additional Inherited Members
Static Public Member Functions inherited from chrono::vehicle::ChPart
static ChMatrix33	TransformInertiaMatrix (const ChVector<> &moments, const ChVector<> &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	ExportBodyList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChBody >> bodies)
	Export the list of bodies to the specified JSON document.

static void	ExportShaftList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChShaft >> shafts)
	Export the list of shafts to the specified JSON document.

static void	ExportJointList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLink >> joints)
	Export the list of joints to the specified JSON document.

static void	ExportCouplesList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChShaftsCouple >> couples)
	Export the list of shaft couples to the specified JSON document.

static void	ExportMarkerList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChMarker >> markers)
	Export the list of markers to the specified JSON document.

static void	ExportLinSpringList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLinkTSDA >> springs)
	Export the list of translational springs to the specified JSON document.

static void	ExportRotSpringList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLinkRSDA >> springs)
	Export the list of rotational springs to the specified JSON document.

static void	ExportBodyLoadList (rapidjson::Document &jsonDocument, std::vector< std::shared_ptr< ChLoadBodyBody >> loads)
	Export the list of body-body loads to the specified JSON document.

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

◆ EnableLocking()

void chrono::vehicle::ChBrake::EnableLocking ( bool val )

inline

Enable/disable ability of locking (default: false).

Note that a derived class may or may not support this option.

◆ Initialize()

virtual void chrono::vehicle::ChBrake::Initialize	(	std::shared_ptr< ChChassis >	chassis,
		std::shared_ptr< ChSuspension >	suspension,
		VehicleSide	side
	)

pure virtual

Initialize 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

Implemented in chrono::vehicle::ChBrakeSimple, and chrono::vehicle::ChBrakeShafts.

◆ InitializeInertiaProperties()

void chrono::vehicle::ChBrake::InitializeInertiaProperties ( )

overrideprotectedvirtual

Initialize subsystem inertia properties.

Derived classes must override this function and set the subsystem mass (m_mass) and, if constant, the subsystem COM frame and its inertia tensor. This function is called during initialization of the vehicle system.

Implements chrono::vehicle::ChPart.

◆ Synchronize()

virtual void chrono::vehicle::ChBrake::Synchronize ( double modulation )

pure virtual

Update the brake subsystem: set the brake modulation.

The input value is in the range [0,1].

  modulation = 0 indicates no braking
  modulation = 1 indicates that the subsystem should provide maximum braking torque

Implemented in chrono::vehicle::ChBrakeSimple, and chrono::vehicle::ChBrakeShafts.

◆ UpdateInertiaProperties()

void chrono::vehicle::ChBrake::UpdateInertiaProperties ( )

overrideprotectedvirtual

Update subsystem inertia properties.

Derived classes must override this function and set the global subsystem transform (m_xform) and, unless constant, the subsystem COM frame (m_com) and its inertia tensor (m_inertia). Calculate the current inertia properties and global frame of this subsystem. This function is called every time the state of the vehicle system is advanced in time.

Implements chrono::vehicle::ChPart.

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

/builds/uwsbel/chrono/src/chrono_vehicle/wheeled_vehicle/ChBrake.h
/builds/uwsbel/chrono/src/chrono_vehicle/wheeled_vehicle/ChBrake.cpp

Description

Public Member Functions

Protected Member Functions