Description

Base class for a vehicle driveline subsystem.

#include <ChDriveline.h>

Inheritance diagram for chrono::vehicle::ChDriveline:

[legend]

Collaboration diagram for chrono::vehicle::ChDriveline:

Public Member Functions
	ChDriveline (const std::string &name)

std::shared_ptr< ChShaft >	GetDriveshaft () const
	Get a handle to the driveshaft. More...

virtual double	GetDriveshaftSpeed () const
	Get the angular speed of the driveshaft. More...

virtual void	Synchronize (double torque)
	Update the driveline subsystem. More...

Public Member Functions inherited from chrono::vehicle::ChPart
	ChPart (const std::string &name)
	Construct a vehicle subsystem with the specified name. More...

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.

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 Attributes
std::shared_ptr< ChShaft >	m_driveshaft
	shaft connection to the powertrain

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

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

Protected Member Functions inherited from chrono::vehicle::ChPart
virtual void	Create (const rapidjson::Document &d)
	Create a vehicle subsystem from JSON data. 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< ChLinkRotSpringCB >> 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.

Member Function Documentation

◆ GetDriveshaft()

std::shared_ptr<ChShaft> chrono::vehicle::ChDriveline::GetDriveshaft ( ) const

inline

Get a handle to the driveshaft.

Return a pointer to the shaft that connects this driveline to a powertrain system.

◆ GetDriveshaftSpeed()

virtual double chrono::vehicle::ChDriveline::GetDriveshaftSpeed ( ) const

inlinevirtual

Get the angular speed of the driveshaft.

This represents the output from the driveline subsystem that is passed to the powertrain system. The default implementation returns the driveline's driveshaft speed.

Reimplemented in chrono::vehicle::ChSimpleDrivelineXWD, chrono::vehicle::gator::Gator_SimpleDriveline, chrono::vehicle::ChSimpleDriveline, chrono::vehicle::ChSimpleTrackDriveline, and chrono::vehicle::generic::Generic_SimpleDriveline.

◆ Synchronize()

virtual void chrono::vehicle::ChDriveline::Synchronize ( double torque )

inlinevirtual

Update the driveline subsystem.

The motor torque represents the input to the driveline subsystem from the powertrain system. The default implementation applies this torque to the driveline's driveshaft.

Reimplemented in chrono::vehicle::ChSimpleDrivelineXWD, chrono::vehicle::ChSimpleDriveline, chrono::vehicle::generic::Generic_SimpleDriveline, and chrono::vehicle::gator::Gator_SimpleDriveline.

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

/builds/uwsbel/chrono/src/chrono_vehicle/ChDriveline.h
/builds/uwsbel/chrono/src/chrono_vehicle/ChDriveline.cpp

Description

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GetDriveshaft()

◆ GetDriveshaftSpeed()

◆ Synchronize()