<!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="summary">
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<h1>player_actarray_actuatorgeom Struct Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="player_actarray_actuatorgeom" -->
<p>Actuator geometry.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="player__interfaces_8h_source.html">player_interfaces.h</a>></code></p>
<p><a href="structplayer__actarray__actuatorgeom-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a49e3eb8767fce8b32edc8165458946ce">type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The type of the actuator - linear or rotary. <a href="#a49e3eb8767fce8b32edc8165458946ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#aff4df21474086cee33c0a09f74f1783a">length</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The length of this actuator's link to the next actuator. <a href="#aff4df21474086cee33c0a09f74f1783a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structplayer__orientation__3d.html">player_orientation_3d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a9249d3d829bd065ac9cbbc60095a5e04">orientation</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The orientation of this actuator when it is in its rest position. <a href="#a9249d3d829bd065ac9cbbc60095a5e04"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structplayer__point__3d.html">player_point_3d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a9a03688872aea0a9a91c67a497429d3f">axis</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The axis of rotation for this actuator if it is rotary, or axis along which it moves if it is linear. <a href="#a9a03688872aea0a9a91c67a497429d3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a11e8cc5a52ce6d9866594735809e9b02">min</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The range of motion of the actuator, in m or rad depending on the type. <a href="#a11e8cc5a52ce6d9866594735809e9b02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a689425acd15cef89f768a78dea43b285">centre</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The range of motion of the actuator, in m or rad depending on the type. <a href="#a689425acd15cef89f768a78dea43b285"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a19c5da1bb5a0f854e61961c5dced1ae1">max</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The range of motion of the actuator, in m or rad depending on the type. <a href="#a19c5da1bb5a0f854e61961c5dced1ae1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a727c92d307767381951031c4e8d2a134">home</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The range of motion of the actuator, in m or rad depending on the type. <a href="#a727c92d307767381951031c4e8d2a134"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a1cfe261f41ecfd84e33b5e93bd607c68">config_speed</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The configured speed setting of the actuator - different from current speed. <a href="#a1cfe261f41ecfd84e33b5e93bd607c68"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__actarray__actuatorgeom.html#a65f4b4e893961123185a3532ee6354a3">hasbrakes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the actuator has brakes or not. <a href="#a65f4b4e893961123185a3532ee6354a3"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Actuator geometry. </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9a03688872aea0a9a91c67a497429d3f"></a><!-- doxytag: member="player_actarray_actuatorgeom::axis" ref="a9a03688872aea0a9a91c67a497429d3f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structplayer__point__3d.html">player_point_3d_t</a> <a class="el" href="structplayer__actarray__actuatorgeom.html#a9a03688872aea0a9a91c67a497429d3f">player_actarray_actuatorgeom::axis</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The axis of rotation for this actuator if it is rotary, or axis along which it moves if it is linear. </p>
<p>In both cases, it is a vector. </p>
</div>
</div>
<a class="anchor" id="a689425acd15cef89f768a78dea43b285"></a><!-- doxytag: member="player_actarray_actuatorgeom::centre" ref="a689425acd15cef89f768a78dea43b285" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="structplayer__actarray__actuatorgeom.html#a689425acd15cef89f768a78dea43b285">player_actarray_actuatorgeom::centre</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The range of motion of the actuator, in m or rad depending on the type. </p>
</div>
</div>
<a class="anchor" id="a1cfe261f41ecfd84e33b5e93bd607c68"></a><!-- doxytag: member="player_actarray_actuatorgeom::config_speed" ref="a1cfe261f41ecfd84e33b5e93bd607c68" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="structplayer__actarray__actuatorgeom.html#a1cfe261f41ecfd84e33b5e93bd607c68">player_actarray_actuatorgeom::config_speed</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The configured speed setting of the actuator - different from current speed. </p>
</div>
</div>
<a class="anchor" id="a65f4b4e893961123185a3532ee6354a3"></a><!-- doxytag: member="player_actarray_actuatorgeom::hasbrakes" ref="a65f4b4e893961123185a3532ee6354a3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="structplayer__actarray__actuatorgeom.html#a65f4b4e893961123185a3532ee6354a3">player_actarray_actuatorgeom::hasbrakes</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the actuator has brakes or not. </p>
</div>
</div>
<a class="anchor" id="a727c92d307767381951031c4e8d2a134"></a><!-- doxytag: member="player_actarray_actuatorgeom::home" ref="a727c92d307767381951031c4e8d2a134" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="structplayer__actarray__actuatorgeom.html#a727c92d307767381951031c4e8d2a134">player_actarray_actuatorgeom::home</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The range of motion of the actuator, in m or rad depending on the type. </p>
</div>
</div>
<a class="anchor" id="aff4df21474086cee33c0a09f74f1783a"></a><!-- doxytag: member="player_actarray_actuatorgeom::length" ref="aff4df21474086cee33c0a09f74f1783a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="structplayer__actarray__actuatorgeom.html#aff4df21474086cee33c0a09f74f1783a">player_actarray_actuatorgeom::length</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The length of this actuator's link to the next actuator. </p>
<p>For linear actuators, this should be its length when at 0 position. </p>
</div>
</div>
<a class="anchor" id="a19c5da1bb5a0f854e61961c5dced1ae1"></a><!-- doxytag: member="player_actarray_actuatorgeom::max" ref="a19c5da1bb5a0f854e61961c5dced1ae1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="structplayer__actarray__actuatorgeom.html#a19c5da1bb5a0f854e61961c5dced1ae1">player_actarray_actuatorgeom::max</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The range of motion of the actuator, in m or rad depending on the type. </p>
</div>
</div>
<a class="anchor" id="a11e8cc5a52ce6d9866594735809e9b02"></a><!-- doxytag: member="player_actarray_actuatorgeom::min" ref="a11e8cc5a52ce6d9866594735809e9b02" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="structplayer__actarray__actuatorgeom.html#a11e8cc5a52ce6d9866594735809e9b02">player_actarray_actuatorgeom::min</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The range of motion of the actuator, in m or rad depending on the type. </p>
</div>
</div>
<a class="anchor" id="a9249d3d829bd065ac9cbbc60095a5e04"></a><!-- doxytag: member="player_actarray_actuatorgeom::orientation" ref="a9249d3d829bd065ac9cbbc60095a5e04" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structplayer__orientation__3d.html">player_orientation_3d_t</a> <a class="el" href="structplayer__actarray__actuatorgeom.html#a9249d3d829bd065ac9cbbc60095a5e04">player_actarray_actuatorgeom::orientation</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The orientation of this actuator when it is in its rest position. </p>
<p>When combined with the length of the actuator's link, this will give the position in space of the next actuator in the array in the coordinate space of this actuator (i.e., it is the direction to the next actuator). </p>
</div>
</div>
<a class="anchor" id="a49e3eb8767fce8b32edc8165458946ce"></a><!-- doxytag: member="player_actarray_actuatorgeom::type" ref="a49e3eb8767fce8b32edc8165458946ce" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="structplayer__actarray__actuatorgeom.html#a49e3eb8767fce8b32edc8165458946ce">player_actarray_actuatorgeom::type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The type of the actuator - linear or rotary. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="player__interfaces_8h_source.html">player_interfaces.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>
