GearboxJoint< T > Class Template Reference

A double axis gearbox joint. More...

#include <physics/physics.hh>

Inherits T.

Public Member Functions
	GearboxJoint (BasePtr _parent)
	Constructor. More...
virtual	~GearboxJoint ()
	Destructor. More...
virtual unsigned int	DOF () const
virtual void	FillMsg (msgs::Joint &_msg)
virtual double	GetGearboxRatio () const
	Get gearbox joint gear ratio. More...
virtual void	Load (sdf::ElementPtr _sdf)
	Load joint. More...
virtual void	SetGearboxRatio (double _gearRatio)=0
	Set gearbox joint gear ratio. More...

Protected Member Functions
virtual void	Init ()
	Initialize joint. More...

Protected Attributes
double	gearRatio
	Gearbox gearRatio. More...
std::string	referenceBody
	reference link/body for computing joint angles More...

Detailed Description

template<class T>
class gazebo::physics::GearboxJoint< T >

A double axis gearbox joint.

Constructor & Destructor Documentation

GearboxJoint()

GearboxJoint ( BasePtr  _parent )

inlineexplicit

Constructor.

Parameters

[in]

_parent

Parent link

~GearboxJoint()

virtual ~GearboxJoint ( )

inlinevirtual

Destructor.

Member Function Documentation

DOF()

virtual unsigned int DOF ( ) const

inlinevirtual

FillMsg()

virtual void FillMsg ( msgs::Joint &  _msg )

inlinevirtual

GetGearboxRatio()

virtual double GetGearboxRatio ( ) const

inlinevirtual

Get gearbox joint gear ratio.

Returns

Gear ratio value.

Init()

virtual void Init ( )

inlineprotectedvirtual

Initialize joint.

Reimplemented in ODEGearboxJoint.

Load()

virtual void Load ( sdf::ElementPtr  _sdf )

inlinevirtual

Load joint.

Parameters

[in]

_sdf

Pointer to SDF element

Reimplemented in ODEGearboxJoint.

SetGearboxRatio()

virtual void SetGearboxRatio ( double  _gearRatio )

pure virtual

Set gearbox joint gear ratio.

This must be implemented in a child class

Parameters

[in]	_index	Index of the axis.
[in]	_gearRatio	Gear ratio value.

Implemented in ODEGearboxJoint.

Referenced by GearboxJoint< ODEJoint >::GetGearboxRatio().

Member Data Documentation

gearRatio

double gearRatio

protected

Gearbox gearRatio.

Referenced by GearboxJoint< ODEJoint >::FillMsg(), GearboxJoint< ODEJoint >::GetGearboxRatio(), and GearboxJoint< ODEJoint >::Load().

referenceBody

std::string referenceBody

protected

reference link/body for computing joint angles

Referenced by GearboxJoint< ODEJoint >::FillMsg(), and GearboxJoint< ODEJoint >::Load().

---

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

• GearboxJoint.hh