All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gazebo::physics::ScrewJoint< T > Class Template Referenceabstract

A screw joint, which has both prismatic and rotational DOFs. More...

#include <physics/physics.hh>

Inheritance diagram for gazebo::physics::ScrewJoint< T >:
Inheritance graph
[legend]
Collaboration diagram for gazebo::physics::ScrewJoint< T >:
Collaboration graph
[legend]

Public Member Functions

 ScrewJoint (BasePtr _parent)
 Constructor. More...
 
virtual ~ScrewJoint ()
 Destructor. More...
 
virtual unsigned int GetAngleCount () const
 
virtual double GetThreadPitch ()=0
 Get screw joint thread pitch. More...
 
virtual void Load (sdf::ElementPtr _sdf)
 Load a ScrewJoint. More...
 
virtual void SetThreadPitch (double _threadPitch)=0
 Set screw joint thread pitch. More...
 

Protected Member Functions

virtual void Init ()
 Initialize joint. More...
 

Protected Attributes

double threadPitch
 Pitch of the thread. More...
 

Detailed Description

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

A screw joint, which has both prismatic and rotational DOFs.

Constructor & Destructor Documentation

template<class T>
gazebo::physics::ScrewJoint< T >::ScrewJoint ( BasePtr  _parent)
inlineexplicit

Constructor.

Parameters
[in]_parentParent of the joint.
template<class T>
virtual gazebo::physics::ScrewJoint< T >::~ScrewJoint ( )
inlinevirtual

Destructor.

Member Function Documentation

template<class T>
virtual unsigned int gazebo::physics::ScrewJoint< T >::GetAngleCount ( ) const
inlinevirtual
template<class T>
virtual double gazebo::physics::ScrewJoint< T >::GetThreadPitch ( )
pure virtual

Get screw joint thread pitch.

Thread Pitch is defined as angular motion per linear motion or rad / m in metric. This must be implemented in a child class

Returns
_threadPitch Thread pitch value.

Implemented in gazebo::physics::BulletScrewJoint, gazebo::physics::SimbodyScrewJoint, gazebo::physics::DARTScrewJoint, and gazebo::physics::ODEScrewJoint.

template<class T>
virtual void gazebo::physics::ScrewJoint< T >::Init ( )
inlineprotectedvirtual

Initialize joint.

Reimplemented in gazebo::physics::BulletScrewJoint, and gazebo::physics::DARTScrewJoint.

template<class T>
virtual void gazebo::physics::ScrewJoint< T >::Load ( sdf::ElementPtr  _sdf)
inlinevirtual
template<class T>
virtual void gazebo::physics::ScrewJoint< T >::SetThreadPitch ( double  _threadPitch)
pure virtual

Set screw joint thread pitch.

Thread Pitch is defined as angular motion per linear motion or rad / m in metric. This must be implemented in a child class To clarify direction, these are modeling right handed threads with positive thread_pitch, i.e. the child Link is the nut (interior threads) while the parent Link is the bolt/screw (exterior threads).

Parameters
[in]_threadPitchThread pitch value.

Implemented in gazebo::physics::BulletScrewJoint, gazebo::physics::SimbodyScrewJoint, gazebo::physics::DARTScrewJoint, and gazebo::physics::ODEScrewJoint.

Member Data Documentation

template<class T>
double gazebo::physics::ScrewJoint< T >::threadPitch
protected

Pitch of the thread.


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