Gripper Class Reference

A gripper abstraction. More...

#include <physics/physics.hh>

Public Member Functions

 Gripper (ModelPtr _model)
 Constructor. More...
 
virtual ~Gripper ()
 Destructor. More...
 
virtual void Init ()
 Initialize. More...
 
bool IsAttached () const
 True if the gripper is attached to another model. More...
 
virtual void Load (sdf::ElementPtr _sdf)
 Load the gripper. More...
 
std::string Name () const
 Return the name of the gripper. More...
 

Detailed Description

A gripper abstraction.

A gripper is a collection of links that act as a gripper. This class will intelligently generate fixed joints between the gripper and an object within the gripper. This allows the object to be manipulated without falling or behaving poorly.

Constructor & Destructor Documentation

◆ Gripper()

Gripper ( ModelPtr  _model)
explicit

Constructor.

Parameters
[in]_modelThe model which contains the Gripper.

◆ ~Gripper()

virtual ~Gripper ( )
virtual

Destructor.

Member Function Documentation

◆ Init()

virtual void Init ( )
virtual

Initialize.

◆ IsAttached()

bool IsAttached ( ) const

True if the gripper is attached to another model.

Returns
True if the gripper is active and a joint has been created between the gripper and another model.

◆ Load()

virtual void Load ( sdf::ElementPtr  _sdf)
virtual

Load the gripper.

Parameters
[in]_sdfShared point to an sdf element that contains the list of links in the gripper.

◆ Name()

std::string Name ( ) const

Return the name of the gripper.

Returns
Name of the gripper

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