All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public 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]

Public Member Functions

 ScrewJoint (BasePtr _parent)
 Constructor. More...
 
virtual ~ScrewJoint ()
 Destructor. More...
 
virtual math::Vector3 GetAnchor (int _index) const
 Get the anchor. More...
 
virtual unsigned int GetAngleCount () const
  More...
 
virtual double GetThreadPitch (unsigned int _index)=0
 Get screw joint thread pitch. More...
 
virtual void Load (sdf::ElementPtr _sdf)
 Load a ScrewJoint. More...
 
virtual void SetAnchor (int _index, const math::Vector3 &_anchor)
 Set the anchor. More...
 
virtual void SetThreadPitch (int _index, double _threadPitch)=0
 Set screw joint thread pitch. More...
 

Protected Attributes

math::Vector3 fakeAnchor
 The anchor value is not used internally. More...
 
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 >
math::Vector3 gazebo::physics::ScrewJoint< T >::GetAnchor ( int  _index) const
virtual

Get the anchor.

Parameters
[in]_indexIndex of the axis. Not Used.
Returns
Anchor for the joint.
template<class T>
virtual unsigned int gazebo::physics::ScrewJoint< T >::GetAngleCount ( ) const
inlinevirtual

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

Get screw joint thread pitch.

This must be implemented in a child class

Parameters
[in]_indexIndex of the axis.
Returns
_threadPitch Thread pitch value.

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

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

Load a ScrewJoint.

Parameters
[in]_sdfSDF value to load from

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

template<class T >
void gazebo::physics::ScrewJoint< T >::SetAnchor ( int  _index,
const math::Vector3 _anchor 
)
virtual

Set the anchor.

Parameters
[in]_indexIndex of the axis. Not Used.
[in]_anchorAnchor value for the joint.
template<class T>
virtual void gazebo::physics::ScrewJoint< T >::SetThreadPitch ( int  _index,
double  _threadPitch 
)
pure virtual

Set screw joint thread pitch.

This must be implemented in a child class

Parameters
[in]_indexIndex of the axis.
[in]_threadPitchThread pitch value.

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

Member Data Documentation

template<class T>
math::Vector3 gazebo::physics::ScrewJoint< T >::fakeAnchor
protected

The anchor value is not used internally.

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

Pitch of the thread.

Referenced by gazebo::physics::ScrewJoint< SimbodyJoint >::Load().


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