<!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_1PowerProxy.html">PlayerCc::PowerProxy</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::PowerProxy 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::PowerProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" --> <p>The <code><a class="el" href="classPlayerCc_1_1PowerProxy.html" title="The PowerProxy class controls a power device.">PowerProxy</a></code> class controls a <a class="el" href="group__interface__power.html">power</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::PowerProxy:</div> <div class="dyncontent"> <div class="center"> <img src="classPlayerCc_1_1PowerProxy.png" usemap="#PlayerCc::PowerProxy_map" alt=""/> <map id="PlayerCc::PowerProxy_map" name="PlayerCc::PowerProxy_map"> <area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,140,24"/> </map> </div> <p><a href="classPlayerCc_1_1PowerProxy-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="a30577acd0b5d19a9351346a6964945af"></a><!-- doxytag: member="PlayerCc::PowerProxy::PowerProxy" ref="a30577acd0b5d19a9351346a6964945af" args="(PlayerClient *aPc, uint32_t aIndex=0)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PowerProxy.html#a30577acd0b5d19a9351346a6964945af">PowerProxy</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="acac03199a117fdd79f74298f949b3e03"></a><!-- doxytag: member="PlayerCc::PowerProxy::~PowerProxy" ref="acac03199a117fdd79f74298f949b3e03" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PowerProxy.html#acac03199a117fdd79f74298f949b3e03">~PowerProxy</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="a81121758c8d17867e19d6fbfc22c5c3c"></a><!-- doxytag: member="PlayerCc::PowerProxy::GetCharge" ref="a81121758c8d17867e19d6fbfc22c5c3c" args="() const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PowerProxy.html#a81121758c8d17867e19d6fbfc22c5c3c">GetCharge</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current charge. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06bfc6650fcbc96922ce41d2e75f4a7c"></a><!-- doxytag: member="PlayerCc::PowerProxy::GetPercent" ref="a06bfc6650fcbc96922ce41d2e75f4a7c" args="() const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PowerProxy.html#a06bfc6650fcbc96922ce41d2e75f4a7c">GetPercent</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the percent of power. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82716407ee343dfe480cf2538a7c7d06"></a><!-- doxytag: member="PlayerCc::PowerProxy::GetJoules" ref="a82716407ee343dfe480cf2538a7c7d06" args="() const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PowerProxy.html#a82716407ee343dfe480cf2538a7c7d06">GetJoules</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the joules. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70afb0325e000e09971168c3d1fb0a38"></a><!-- doxytag: member="PlayerCc::PowerProxy::GetWatts" ref="a70afb0325e000e09971168c3d1fb0a38" args="() const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PowerProxy.html#a70afb0325e000e09971168c3d1fb0a38">GetWatts</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the watts. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8bec1422bfca921e51a18aac20cd3846"></a><!-- doxytag: member="PlayerCc::PowerProxy::GetCharging" ref="a8bec1422bfca921e51a18aac20cd3846" args="() const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PowerProxy.html#a8bec1422bfca921e51a18aac20cd3846">GetCharging</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether charging is taking place. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a152a8be6fd5b157c9c4c58f7161efada"></a><!-- doxytag: member="PlayerCc::PowerProxy::IsValid" ref="a152a8be6fd5b157c9c4c58f7161efada" args="() const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PowerProxy.html#a152a8be6fd5b157c9c4c58f7161efada">IsValid</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if we have received any data from the device. <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="a73eb307339e75b2f82f22bddd14aa0a7"></a><!-- doxytag: member="PlayerCc::PowerProxy::Subscribe" ref="a73eb307339e75b2f82f22bddd14aa0a7" 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="ac537cc6b0492c681dc01e34fa03f7bf7"></a><!-- doxytag: member="PlayerCc::PowerProxy::Unsubscribe" ref="ac537cc6b0492c681dc01e34fa03f7bf7" 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="ac55b69ce377d4b281d096487ba16c2ba"></a><!-- doxytag: member="PlayerCc::PowerProxy::mDevice" ref="ac55b69ce377d4b281d096487ba16c2ba" args="" --> <a class="el" href="structplayerc__power__t.html">playerc_power_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_1PowerProxy.html" title="The PowerProxy class controls a power device.">PowerProxy</a></code> class controls a <a class="el" href="group__interface__power.html">power</a> device. </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>