Description

Base class for a single idler (template definition).

#include <ChSingleIdler.h>

Inheritance diagram for chrono::vehicle::ChSingleIdler:
Collaboration diagram for chrono::vehicle::ChSingleIdler:

Public Member Functions

 ChSingleIdler (const std::string &name)
 
virtual std::string GetTemplateName () const override
 Get the name of the vehicle subsystem template.
 
virtual GuidePinType GetType () const final override
 Return the type of track shoe consistent with this idler.
 
virtual void Initialize (std::shared_ptr< ChBodyAuxRef > chassis, const ChVector<> &location, ChTrackAssembly *track) override
 Initialize this idler subsystem. More...
 
virtual void AddVisualizationAssets (VisualizationType vis) override
 Add visualization assets for the idler subsystem.
 
virtual void RemoveVisualizationAssets () override final
 Remove visualization assets for the idler subsystem.
 
- Public Member Functions inherited from chrono::vehicle::ChIdler
 ChIdler (const std::string &name)
 
std::shared_ptr< ChBodyGetWheelBody () const
 Get a handle to the road wheel body.
 
std::shared_ptr< ChLinkLockRevoluteGetRevolute () const
 Get a handle to the revolute joint.
 
virtual double GetWheelRadius () const =0
 Get the radius of the idler wheel.
 
void SetCollide (bool val)
 Turn on/off collision flag for the idler wheel.
 
virtual double GetMass () const
 Get the mass of the idler subsystem.
 
void LogConstraintViolations ()
 Log current constraint violations.
 
- 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.
 
void SetVisualizationType (VisualizationType vis)
 Set the visualization mode for this subsystem.
 
virtual void SetOutput (bool state)
 Enable/disable output for this subsystem.
 
bool OutputEnabled () const
 Return the output state for this subsystem.
 

Protected Member Functions

virtual double GetWheelWidth () const =0
 Return the width of the idler wheel.
 
- Protected Member Functions inherited from chrono::vehicle::ChIdler
virtual const ChVector GetLocation (PointId which)=0
 Return the location of the specified hardpoint. More...
 
virtual double GetWheelMass () const =0
 Return the mass of the idler wheel body.
 
virtual const ChVectorGetWheelInertia ()=0
 Return the moments of inertia of the idler wheel body.
 
virtual double GetCarrierMass () const =0
 Return the mass of the carrier body.
 
virtual const ChVectorGetCarrierInertia ()=0
 Return the moments of inertia of the carrier body.
 
virtual double GetCarrierVisRadius () const =0
 Return a visualization radius for the carrier body.
 
virtual double GetPrismaticPitchAngle () const =0
 Return the pitch angle of the prismatic joint.
 
virtual std::shared_ptr< ChLinkTSDA::ForceFunctorGetTensionerForceCallback () const =0
 Return the functor object for spring force.
 
virtual double GetTensionerFreeLength () const =0
 Return the free length for the tensioner spring.
 
virtual void CreateContactMaterial (ChContactMethod contact_method)=0
 Create the contact material consistent with the specified contact method.
 
virtual void ExportComponentList (rapidjson::Document &jsonDocument) const override
 Export this subsystem's component list to the specified JSON object. More...
 
virtual void Output (ChVehicleOutput &database) const override
 Output data for this subsystem's component list to the specified database.
 
- Protected Member Functions inherited from chrono::vehicle::ChPart
virtual void Create (const rapidjson::Document &d)
 Create a vehicle subsystem from JSON data. More...
 

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 Types inherited from chrono::vehicle::ChIdler
enum  PointId {
  WHEEL, CARRIER, CARRIER_CHASSIS, TSDA_CARRIER,
  TSDA_CHASSIS, NUM_POINTS
}
 Identifiers for the various hardpoints. 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.
 
- Protected Attributes inherited from chrono::vehicle::ChIdler
std::shared_ptr< ChBodym_wheel
 handle to the idler wheel body
 
std::shared_ptr< ChBodym_carrier
 handle to the carrier body
 
std::shared_ptr< ChLinkLockRevolutem_revolute
 handle to wheel-carrier revolute joint
 
std::shared_ptr< ChLinkLockPrismaticm_prismatic
 handle to carrier-chassis translational joint
 
std::shared_ptr< ChLinkTSDAm_tensioner
 handle to the TSDA tensioner element
 
std::shared_ptr< ChMaterialSurfacem_material
 contact material;
 
ChTrackAssemblym_track
 containing track assembly
 
- 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
 

Constructor & Destructor Documentation

◆ ChSingleIdler()

chrono::vehicle::ChSingleIdler::ChSingleIdler ( const std::string &  name)
Parameters
[in]namename of the subsystem

Member Function Documentation

◆ Initialize()

void chrono::vehicle::ChSingleIdler::Initialize ( std::shared_ptr< ChBodyAuxRef chassis,
const ChVector<> &  location,
ChTrackAssembly track 
)
overridevirtual

Initialize this idler subsystem.

Parameters
[in]chassishandle to the chassis body
[in]locationlocation relative to the chassis frame
[in]trackcontaining track assembly

Reimplemented from chrono::vehicle::ChIdler.


The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono_vehicle/tracked_vehicle/idler/ChSingleIdler.h
  • /builds/uwsbel/chrono/src/chrono_vehicle/tracked_vehicle/idler/ChSingleIdler.cpp