<!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="navpath">
<ul>
<li><b>PlayerCc</b> </li>
<li><a class="el" href="classPlayerCc_1_1GripperProxy.html">PlayerCc::GripperProxy</a> </li>
</ul>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>PlayerCc::GripperProxy Class Reference<br/>
<small>
[<a class="el" href="group__player__clientlib__cplusplus__proxies.html">Proxies</a>]</small>
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="PlayerCc::GripperProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" -->
<p>The <code><a class="el" href="classPlayerCc_1_1GripperProxy.html" title="The GripperProxy class is used to control a gripper device.">GripperProxy</a></code> class is used to control a <a class="el" href="group__interface__gripper.html">gripper</a> device.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PlayerCc::GripperProxy:</div>
<div class="dyncontent">
<div class="center">
<img src="classPlayerCc_1_1GripperProxy.png" usemap="#PlayerCc::GripperProxy_map" alt=""/>
<map id="PlayerCc::GripperProxy_map" name="PlayerCc::GripperProxy_map">
<area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,147,24"/>
</map>
</div>
<p><a href="classPlayerCc_1_1GripperProxy-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59c6015df2ca036df66062a92f0a6188"></a><!-- doxytag: member="PlayerCc::GripperProxy::GripperProxy" ref="a59c6015df2ca036df66062a92f0a6188" args="(PlayerClient *aPc, uint32_t aIndex=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a59c6015df2ca036df66062a92f0a6188">GripperProxy</a> (<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> *aPc, uint32_t aIndex=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c9fc9f6e9338521d08eb998d15bc960"></a><!-- doxytag: member="PlayerCc::GripperProxy::~GripperProxy" ref="a5c9fc9f6e9338521d08eb998d15bc960" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a5c9fc9f6e9338521d08eb998d15bc960">~GripperProxy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22c3d1a9a987e5b0a49ac15d7a20000a"></a><!-- doxytag: member="PlayerCc::GripperProxy::RequestGeometry" ref="a22c3d1a9a987e5b0a49ac15d7a20000a" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a22c3d1a9a987e5b0a49ac15d7a20000a">RequestGeometry</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Geometry request - call before getting the geometry of the gripper through an accessor method. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa47609445cdecc16f0ba92acbe6e7c1"></a><!-- doxytag: member="PlayerCc::GripperProxy::GetState" ref="afa47609445cdecc16f0ba92acbe6e7c1" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#afa47609445cdecc16f0ba92acbe6e7c1">GetState</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the gripper state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2e6225a54989c57675e36e91b4964f7"></a><!-- doxytag: member="PlayerCc::GripperProxy::GetBeams" ref="ac2e6225a54989c57675e36e91b4964f7" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#ac2e6225a54989c57675e36e91b4964f7">GetBeams</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the gripper break beam info. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff2063b849dece588b78f2430880fe52"></a><!-- doxytag: member="PlayerCc::GripperProxy::GetPose" ref="aff2063b849dece588b78f2430880fe52" args="() const " -->
<a class="el" href="structplayer__pose3d.html">player_pose3d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#aff2063b849dece588b78f2430880fe52">GetPose</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pose of the gripper. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a295fa68e39b7cb19616e814fb83bb3"></a><!-- doxytag: member="PlayerCc::GripperProxy::GetOuterSize" ref="a9a295fa68e39b7cb19616e814fb83bb3" args="() const " -->
<a class="el" href="structplayer__bbox3d.html">player_bbox3d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a9a295fa68e39b7cb19616e814fb83bb3">GetOuterSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outer size of the gripper. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64b1815c23e97ca73dc438e79a4fa6e0"></a><!-- doxytag: member="PlayerCc::GripperProxy::GetInnerSize" ref="a64b1815c23e97ca73dc438e79a4fa6e0" args="() const " -->
<a class="el" href="structplayer__bbox3d.html">player_bbox3d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a64b1815c23e97ca73dc438e79a4fa6e0">GetInnerSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the inner size of the gripper. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71d30361f209e3037e59485178d560f4"></a><!-- doxytag: member="PlayerCc::GripperProxy::GetNumBeams" ref="a71d30361f209e3037e59485178d560f4" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a71d30361f209e3037e59485178d560f4">GetNumBeams</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of breakbeams in the gripper. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c464cd7e46d3122ce05ce51058aca35"></a><!-- doxytag: member="PlayerCc::GripperProxy::GetCapacity" ref="a3c464cd7e46d3122ce05ce51058aca35" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a3c464cd7e46d3122ce05ce51058aca35">GetCapacity</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the capacity of the gripper's storage. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40cb7eec023d0bdca11425af529a6ef4"></a><!-- doxytag: member="PlayerCc::GripperProxy::GetStored" ref="a40cb7eec023d0bdca11425af529a6ef4" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a40cb7eec023d0bdca11425af529a6ef4">GetStored</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of currently-stored objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d9a937a141667360f60da5af8e97ec9"></a><!-- doxytag: member="PlayerCc::GripperProxy::Open" ref="a2d9a937a141667360f60da5af8e97ec9" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a2d9a937a141667360f60da5af8e97ec9">Open</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command the gripper to open. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a305b70b96244c093b0c0814a979d5403"></a><!-- doxytag: member="PlayerCc::GripperProxy::Close" ref="a305b70b96244c093b0c0814a979d5403" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a305b70b96244c093b0c0814a979d5403">Close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command the gripper to close. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9767d8814297da811d30c9b0e2977d8a"></a><!-- doxytag: member="PlayerCc::GripperProxy::Stop" ref="a9767d8814297da811d30c9b0e2977d8a" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a9767d8814297da811d30c9b0e2977d8a">Stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command the gripper to stop. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a966b942e5e1749fdff6175bb9a8770b7"></a><!-- doxytag: member="PlayerCc::GripperProxy::Store" ref="a966b942e5e1749fdff6175bb9a8770b7" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a966b942e5e1749fdff6175bb9a8770b7">Store</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command the gripper to store. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c27c310cbf8612a93b5b4fbe655040b"></a><!-- doxytag: member="PlayerCc::GripperProxy::Retrieve" ref="a3c27c310cbf8612a93b5b4fbe655040b" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1GripperProxy.html#a3c27c310cbf8612a93b5b4fbe655040b">Retrieve</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command the gripper to retrieve. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c1ffa56d8d4dbaa7c62b55c7cc5fe83"></a><!-- doxytag: member="PlayerCc::GripperProxy::Subscribe" ref="a8c1ffa56d8d4dbaa7c62b55c7cc5fe83" args="(uint32_t aIndex)" -->
void </td><td class="memItemRight" valign="bottom"><b>Subscribe</b> (uint32_t aIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37bec442fcc3c4df0eaff8cac6352aa9"></a><!-- doxytag: member="PlayerCc::GripperProxy::Unsubscribe" ref="a37bec442fcc3c4df0eaff8cac6352aa9" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>Unsubscribe</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8761af357ec5b638331bbcc1ce4e477"></a><!-- doxytag: member="PlayerCc::GripperProxy::mDevice" ref="af8761af357ec5b638331bbcc1ce4e477" args="" -->
<a class="el" href="structplayerc__gripper__t.html">playerc_gripper_t</a> * </td><td class="memItemRight" valign="bottom"><b>mDevice</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <code><a class="el" href="classPlayerCc_1_1GripperProxy.html" title="The GripperProxy class is used to control a gripper device.">GripperProxy</a></code> class is used to control a <a class="el" href="group__interface__gripper.html">gripper</a> device. </p>
<p>The latest gripper data is held in a handful of class attributes. </p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a></li>
</ul>
</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
>
242
