XBot::Hand Class Reference

Hand. More...

#include <Hand.h>

Collaboration diagram for XBot::Hand:

Public Types
typedef std::shared_ptr< Hand >	Ptr
typedef std::shared_ptr< const Hand >	ConstPtr

Public Member Functions
	Hand (int hand_id, std::string hand_name)
	Constructor with the hand id. More...
int	getHandId ()
	get the hand id More...
const std::string &	getHandName ()
	get the hand name More...
void	grasp (double grasp_percentage)
	grasp till grasp_percentage More...
double	getGraspReference ()
	get the grasp reference set with grasp_percentage More...
double	getGraspState () const
	get actual grasp percentage More...
void	setGraspState (double grasp_state)
	set the grasp state read from the hand More...

Detailed Description

Hand.

Member Typedef Documentation

ConstPtr

typedef std::shared_ptr<const Hand> XBot::Hand::ConstPtr

Ptr

typedef std::shared_ptr<Hand> XBot::Hand::Ptr

Constructor & Destructor Documentation

Hand()

XBot::Hand::Hand	(	int	hand_id,
		std::string	hand_name
	)

Constructor with the hand id.

Parameters

hand_id	the hand id
hand_name	the hand name

Member Function Documentation

getGraspReference()

double XBot::Hand::getGraspReference

(

)

get the grasp reference set with grasp_percentage

Returns

double the grasp reference set in previous grasp() function

getGraspState()

double XBot::Hand::getGraspState

(

)

const

get actual grasp percentage

Returns

double the actual grasp percentage

getHandId()

int XBot::Hand::getHandId

(

)

get the hand id

Returns

int the hand id

getHandName()

const std::string & XBot::Hand::getHandName

(

)

get the hand name

Returns

const std::string& the hand name

grasp()

void XBot::Hand::grasp

(

double

grasp_percentage

)

grasp till grasp_percentage

Parameters

grasp_percentage

grasp percentage from 0.0 to 1.0 (0% to 100% grasp)

setGraspState()

void XBot::Hand::setGraspState

(

double

grasp_state

)

set the grasp state read from the hand

Parameters

grasp_state

the grasp state to set

Returns

void

---

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

• /home/travis/build/ADVRHumanoids/forest_ws/src/XBotInterface/include/XBotInterface/Hand.h
• /home/travis/build/ADVRHumanoids/forest_ws/src/XBotInterface/src/Hand.cpp