Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 266

player-doc-3.0.2-5.fc14.noarch.rpm

<!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&nbsp;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&nbsp;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_1LogProxy.html">PlayerCc::LogProxy</a>      </li>
    </ul>
  </div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>PlayerCc::LogProxy 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::LogProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" -->
<p>The <code><a class="el" href="classPlayerCc_1_1LogProxy.html" title="The LogProxy proxy provides access to a log device.">LogProxy</a></code> proxy provides access to a <a class="el" href="group__interface__log.html">log</a> device.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PlayerCc::LogProxy:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classPlayerCc_1_1LogProxy.png" usemap="#PlayerCc::LogProxy_map" alt=""/>
  <map id="PlayerCc::LogProxy_map" name="PlayerCc::LogProxy_map">
<area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,136,24"/>
</map>
</div>

<p><a href="classPlayerCc_1_1LogProxy-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="a4a7b75eeb90f4687b762079eb9425a3e"></a><!-- doxytag: member="PlayerCc::LogProxy::LogProxy" ref="a4a7b75eeb90f4687b762079eb9425a3e" args="(PlayerClient *aPc, uint32_t aIndex=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#a4a7b75eeb90f4687b762079eb9425a3e">LogProxy</a> (<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> *aPc, uint32_t aIndex=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61431811356f3ec62d060a091b13675c"></a><!-- doxytag: member="PlayerCc::LogProxy::~LogProxy" ref="a61431811356f3ec62d060a091b13675c" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#a61431811356f3ec62d060a091b13675c">~LogProxy</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#ae1c2453707816e9c6d1c74b61ab45102">GetType</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">What kind of log device is this? Either PLAYER_LOG_TYPE_READ or PLAYER_LOG_TYPE_WRITE.  <a href="#ae1c2453707816e9c6d1c74b61ab45102"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5517f306e3ed66312c4f0a092f8c8f0"></a><!-- doxytag: member="PlayerCc::LogProxy::GetState" ref="ae5517f306e3ed66312c4f0a092f8c8f0" args="() const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#ae5517f306e3ed66312c4f0a092f8c8f0">GetState</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is logging/playback enabled? Call <a class="el" href="classPlayerCc_1_1LogProxy.html#a39fc154ba1f07da6897d3579efd48732" title="Query the server for type and state info.">QueryState()</a> to fill it. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39fc154ba1f07da6897d3579efd48732"></a><!-- doxytag: member="PlayerCc::LogProxy::QueryState" ref="a39fc154ba1f07da6897d3579efd48732" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#a39fc154ba1f07da6897d3579efd48732">QueryState</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query the server for type and state info. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#ae3a57a00d607c998e8d517b7577e1452">SetState</a> (int aState)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start/stop (1/0) reading from or writing to the log file.  <a href="#ae3a57a00d607c998e8d517b7577e1452"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94a8ab2605ca6e78a34d44ad2abe646e"></a><!-- doxytag: member="PlayerCc::LogProxy::SetWriteState" ref="a94a8ab2605ca6e78a34d44ad2abe646e" args="(int aState)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#a94a8ab2605ca6e78a34d44ad2abe646e">SetWriteState</a> (int aState)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start/stop (1/0) writing to the log file. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfb4e101fafec9de32e1aea2ed562d73"></a><!-- doxytag: member="PlayerCc::LogProxy::SetReadState" ref="adfb4e101fafec9de32e1aea2ed562d73" args="(int aState)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#adfb4e101fafec9de32e1aea2ed562d73">SetReadState</a> (int aState)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start/stop (1/0) reading from the log file. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57647f5ff6f46b51ef5c480345883655"></a><!-- doxytag: member="PlayerCc::LogProxy::Rewind" ref="a57647f5ff6f46b51ef5c480345883655" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#a57647f5ff6f46b51ef5c480345883655">Rewind</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rewind the log file. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a2f7212ed2eb62256111f7f53a1931b"></a><!-- doxytag: member="PlayerCc::LogProxy::SetFilename" ref="a0a2f7212ed2eb62256111f7f53a1931b" args="(const std::string aFilename)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LogProxy.html#a0a2f7212ed2eb62256111f7f53a1931b">SetFilename</a> (const std::string aFilename)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the name of the logfile to write to. <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="a3f41ba8f223c8a8a149b7f73452fc731"></a><!-- doxytag: member="PlayerCc::LogProxy::Subscribe" ref="a3f41ba8f223c8a8a149b7f73452fc731" args="(uint32_t aIndex)" -->
void&nbsp;</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="a30a4b54fd1da2d65f04e326a4e4860a3"></a><!-- doxytag: member="PlayerCc::LogProxy::Unsubscribe" ref="a30a4b54fd1da2d65f04e326a4e4860a3" args="()" -->
void&nbsp;</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="a054343b8c0f97e555b0f7dcbf5b3e270"></a><!-- doxytag: member="PlayerCc::LogProxy::mDevice" ref="a054343b8c0f97e555b0f7dcbf5b3e270" args="" -->
<a class="el" href="structplayerc__log__t.html">playerc_log_t</a> *&nbsp;</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_1LogProxy.html" title="The LogProxy proxy provides access to a log device.">LogProxy</a></code> proxy provides access to a <a class="el" href="group__interface__log.html">log</a> device. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae1c2453707816e9c6d1c74b61ab45102"></a><!-- doxytag: member="PlayerCc::LogProxy::GetType" ref="ae1c2453707816e9c6d1c74b61ab45102" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PlayerCc::LogProxy::GetType </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>What kind of log device is this? Either PLAYER_LOG_TYPE_READ or PLAYER_LOG_TYPE_WRITE. </p>
<p>Call <a class="el" href="classPlayerCc_1_1LogProxy.html#a39fc154ba1f07da6897d3579efd48732" title="Query the server for type and state info.">QueryState()</a> to fill it. </p>

</div>
</div>
<a class="anchor" id="ae3a57a00d607c998e8d517b7577e1452"></a><!-- doxytag: member="PlayerCc::LogProxy::SetState" ref="ae3a57a00d607c998e8d517b7577e1452" args="(int aState)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::LogProxy::SetState </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>aState</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Start/stop (1/0) reading from or writing to the log file. </p>
<p>If the type of interface (reader/writer) is unknown, a query package is sent first. </p>

</div>
</div>
<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional