<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->
<HEAD>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<style type="text/css">
.floatright { float: right; margin: 0 0 1em 1em; }
body {
font-family: sans-serif;
#font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
background-color: #FFF;
color:#000;
}
a:link {
color: #A00;
}
a:visited {
color: #800;
}
a { text-decoration: none; }
a:hover { text-decoration: underline; }
.timestamp { text-align:right; background-color: #DDD; font-size:75%;}
h1 {
font-size:160%;
}
h2 {
font-size:110%;
#color: #FFF;
#background-color: #666;
#padding:3px;
}
h3 { text-align:left; }
img {
border: 0;
}
ul.menu {
position:relative;
left:-2.5em;
margin-bottom:0px;
margin-top:0px;
}
ul.menu1 {
position:relative;
left:-2.1em;
margin-bottom:0px;
margin-top:0px;
}
li.menu {
list-style-type: none;
position:relative;
#left:-0.5em;
}
#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}
#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }
div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}
div.topbar { position: absolute; top:0px; left:9em; margin:1em; }
</style>
<TITLE>Player Manual</TITLE>
</HEAD>
<body>
<div id="sidebar">
<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>
<div class="box">
<div class=title>Player</div>
<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>
<div class="box">
<div class=title>User</div>
<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>
</ul>
</div>
<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>
<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>
</div>
<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
<div class="headertitle">
<h1>gripper<br/>
<small>
[<a class="el" href="group__interfaces.html">Interface specifications</a>]</small>
</h1> </div>
</div>
<div class="contents">
<p>Gripper interface.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga027449a37ce518c8d5cc23ba5443c72f"></a><!-- doxytag: member="interface_gripper::PLAYER_GRIPPER_DATA_STATE" ref="ga027449a37ce518c8d5cc23ba5443c72f" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#ga027449a37ce518c8d5cc23ba5443c72f">PLAYER_GRIPPER_DATA_STATE</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga40aca4010c039aef83f109dec1c53c49"></a><!-- doxytag: member="interface_gripper::PLAYER_GRIPPER_REQ_GET_GEOM" ref="ga40aca4010c039aef83f109dec1c53c49" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#ga40aca4010c039aef83f109dec1c53c49">PLAYER_GRIPPER_REQ_GET_GEOM</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request subtype: get geometry. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#gac77f5a5c66b1342c31f5fbf38a9cd80d">PLAYER_GRIPPER_CMD_OPEN</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command: Open (<a class="el" href="group__interface__gripper.html#gac77f5a5c66b1342c31f5fbf38a9cd80d">PLAYER_GRIPPER_CMD_OPEN</a>). <a href="#gac77f5a5c66b1342c31f5fbf38a9cd80d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#gac043e19a527151d851fe227df5c5297c">PLAYER_GRIPPER_CMD_CLOSE</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command: Close (<a class="el" href="group__interface__gripper.html#gac043e19a527151d851fe227df5c5297c">PLAYER_GRIPPER_CMD_CLOSE</a>). <a href="#gac043e19a527151d851fe227df5c5297c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#gaf84fd214b8a463a35bda6a66bef67c5d">PLAYER_GRIPPER_CMD_STOP</a> 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command: Stop (<a class="el" href="group__interface__gripper.html#gaf84fd214b8a463a35bda6a66bef67c5d">PLAYER_GRIPPER_CMD_STOP</a>). <a href="#gaf84fd214b8a463a35bda6a66bef67c5d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#ga53f66d15dc3a313eec49b1f8021116d0">PLAYER_GRIPPER_CMD_STORE</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command: Store (<a class="el" href="group__interface__gripper.html#ga53f66d15dc3a313eec49b1f8021116d0">PLAYER_GRIPPER_CMD_STORE</a>). <a href="#ga53f66d15dc3a313eec49b1f8021116d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#ga5850a4271404b3a9063305b8dd38673c">PLAYER_GRIPPER_CMD_RETRIEVE</a> 5</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command: Retrieve (<a class="el" href="group__interface__gripper.html#ga5850a4271404b3a9063305b8dd38673c">PLAYER_GRIPPER_CMD_RETRIEVE</a>). <a href="#ga5850a4271404b3a9063305b8dd38673c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafd937de20b8846b80c8ebab9d70550fb"></a><!-- doxytag: member="interface_gripper::PLAYER_GRIPPER_STATE_OPEN" ref="gafd937de20b8846b80c8ebab9d70550fb" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#gafd937de20b8846b80c8ebab9d70550fb">PLAYER_GRIPPER_STATE_OPEN</a> 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gripper state: open. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga39491a0f4217803a268824c260fa14c1"></a><!-- doxytag: member="interface_gripper::PLAYER_GRIPPER_STATE_CLOSED" ref="ga39491a0f4217803a268824c260fa14c1" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#ga39491a0f4217803a268824c260fa14c1">PLAYER_GRIPPER_STATE_CLOSED</a> 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gripper state: closed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae7e13ceaed09cb4143c74705a9bcbec4"></a><!-- doxytag: member="interface_gripper::PLAYER_GRIPPER_STATE_MOVING" ref="gae7e13ceaed09cb4143c74705a9bcbec4" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#gae7e13ceaed09cb4143c74705a9bcbec4">PLAYER_GRIPPER_STATE_MOVING</a> 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gripper state: moving. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga451425654d635db95131df278706c2d2"></a><!-- doxytag: member="interface_gripper::PLAYER_GRIPPER_STATE_ERROR" ref="ga451425654d635db95131df278706c2d2" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#ga451425654d635db95131df278706c2d2">PLAYER_GRIPPER_STATE_ERROR</a> 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gripper state: error. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__gripper__data.html">player_gripper_data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#ga120718886f862c4ad75ccc5634dea343">player_gripper_data_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data: state (<a class="el" href="group__interface__gripper.html#ga027449a37ce518c8d5cc23ba5443c72f">PLAYER_GRIPPER_DATA_STATE</a>). <a href="#ga120718886f862c4ad75ccc5634dea343"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__gripper__geom.html">player_gripper_geom</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__gripper.html#gab70c82572f28cea372c06314b5ca8ade">player_gripper_geom_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: get geometry. <a href="#gab70c82572f28cea372c06314b5ca8ade"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Gripper interface. </p>
<p>The <code>gripper</code> interface provides access to a robotic gripper. A gripper is a device capable of closing around and carrying an object of suitable size and shape. On a mobile robot, a gripper is typically mounted near the floor on the front, or on the end of a robotic limb. Grippers typically have two "fingers" that close around an object. Some grippers can detect whether an objcet is within the gripper (using, for example, light beams). Some grippers also have the ability to move the a carried object into a storage system, freeing the gripper to pick up a new object, and move objects from the storage system back into the gripper. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gac043e19a527151d851fe227df5c5297c"></a><!-- doxytag: member="player_interfaces.h::PLAYER_GRIPPER_CMD_CLOSE" ref="gac043e19a527151d851fe227df5c5297c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_GRIPPER_CMD_CLOSE 2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command: Close (<a class="el" href="group__interface__gripper.html#gac043e19a527151d851fe227df5c5297c">PLAYER_GRIPPER_CMD_CLOSE</a>). </p>
<p>Tells the gripper to close. </p>
<p>Referenced by <a class="el" href="classP2OS.html#a91bda6c36ac50b99c6cf4a3f9258cb8c">P2OS::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="gac77f5a5c66b1342c31f5fbf38a9cd80d"></a><!-- doxytag: member="player_interfaces.h::PLAYER_GRIPPER_CMD_OPEN" ref="gac77f5a5c66b1342c31f5fbf38a9cd80d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_GRIPPER_CMD_OPEN 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command: Open (<a class="el" href="group__interface__gripper.html#gac77f5a5c66b1342c31f5fbf38a9cd80d">PLAYER_GRIPPER_CMD_OPEN</a>). </p>
<p>Tells the gripper to open. </p>
<p>Referenced by <a class="el" href="classP2OS.html#a91bda6c36ac50b99c6cf4a3f9258cb8c">P2OS::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="ga5850a4271404b3a9063305b8dd38673c"></a><!-- doxytag: member="player_interfaces.h::PLAYER_GRIPPER_CMD_RETRIEVE" ref="ga5850a4271404b3a9063305b8dd38673c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_GRIPPER_CMD_RETRIEVE 5</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command: Retrieve (<a class="el" href="group__interface__gripper.html#ga5850a4271404b3a9063305b8dd38673c">PLAYER_GRIPPER_CMD_RETRIEVE</a>). </p>
<p>Tells the gripper to retrieve a stored object (so that it can be put back into the world). The opposite of store. </p>
</div>
</div>
<a class="anchor" id="gaf84fd214b8a463a35bda6a66bef67c5d"></a><!-- doxytag: member="player_interfaces.h::PLAYER_GRIPPER_CMD_STOP" ref="gaf84fd214b8a463a35bda6a66bef67c5d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_GRIPPER_CMD_STOP 3</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command: Stop (<a class="el" href="group__interface__gripper.html#gaf84fd214b8a463a35bda6a66bef67c5d">PLAYER_GRIPPER_CMD_STOP</a>). </p>
<p>Tells the gripper to stop. </p>
<p>Referenced by <a class="el" href="classP2OS.html#a91bda6c36ac50b99c6cf4a3f9258cb8c">P2OS::ProcessMessage()</a>.</p>
</div>
</div>
<a class="anchor" id="ga53f66d15dc3a313eec49b1f8021116d0"></a><!-- doxytag: member="player_interfaces.h::PLAYER_GRIPPER_CMD_STORE" ref="ga53f66d15dc3a313eec49b1f8021116d0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PLAYER_GRIPPER_CMD_STORE 4</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command: Store (<a class="el" href="group__interface__gripper.html#ga53f66d15dc3a313eec49b1f8021116d0">PLAYER_GRIPPER_CMD_STORE</a>). </p>
<p>Tells the gripper to store whatever it is holding. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga120718886f862c4ad75ccc5634dea343"></a><!-- doxytag: member="player_interfaces.h::player_gripper_data_t" ref="ga120718886f862c4ad75ccc5634dea343" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__gripper__data.html">player_gripper_data</a> <a class="el" href="structplayer__gripper__data.html">player_gripper_data_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data: state (<a class="el" href="group__interface__gripper.html#ga027449a37ce518c8d5cc23ba5443c72f">PLAYER_GRIPPER_DATA_STATE</a>). </p>
<p>The <code>gripper</code> interface returns the current state of the gripper and information on a potential object in the gripper. state may be <a class="el" href="group__interface__gripper.html#gafd937de20b8846b80c8ebab9d70550fb">PLAYER_GRIPPER_STATE_OPEN</a>, <a class="el" href="group__interface__gripper.html#ga39491a0f4217803a268824c260fa14c1">PLAYER_GRIPPER_STATE_CLOSED</a>, PLAYER_GRIPPER_STAGE_MOVING or <a class="el" href="group__interface__gripper.html#ga451425654d635db95131df278706c2d2">PLAYER_GRIPPER_STATE_ERROR</a>. beams provides information on how far into the gripper an object is. For most grippers, this will be a bit mask, with each bit representing whether a beam has been interrupted or not. </p>
</div>
</div>
<a class="anchor" id="gab70c82572f28cea372c06314b5ca8ade"></a><!-- doxytag: member="player_interfaces.h::player_gripper_geom_t" ref="gab70c82572f28cea372c06314b5ca8ade" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__gripper__geom.html">player_gripper_geom</a> <a class="el" href="structplayer__gripper__geom.html">player_gripper_geom_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request/reply: get geometry. </p>
<p>The geometry (pose, outer size and inner size) of the gripper device can be queried by sending a null <a class="el" href="group__interface__gripper.html#ga40aca4010c039aef83f109dec1c53c49">PLAYER_GRIPPER_REQ_GET_GEOM</a> request. </p>
</div>
</div>
</div>
<!-- render the modification time of the source file -->
<div class="timestamp">
<hr>
<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
src="http://www.w3.org/Icons/valid-html401"
alt="Valid HTML 4.01!"></a>
<a href="http://jigsaw.w3.org/css-validator/">
<img style="vertical-align:middle;border:0;width:88px;height:31px"
src="http://jigsaw.w3.org/css-validator/images/vcss"
alt="Valid CSS!">
</a>
-->
</tr>
</table>
</div>
</tr>
</table>
</BODY>
</HTML>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
692
