<!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_1ClientProxy.html">PlayerCc::ClientProxy</a> </li>
</ul>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>PlayerCc::ClientProxy Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="PlayerCc::ClientProxy" -->
<p>The client proxy base class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="clientproxy_8h_source.html">clientproxy.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PlayerCc::ClientProxy:</div>
<div class="dyncontent">
<div class="center">
<img src="classPlayerCc_1_1ClientProxy.png" usemap="#PlayerCc::ClientProxy_map" alt=""/>
<map id="PlayerCc::ClientProxy_map" name="PlayerCc::ClientProxy_map">
<area href="classPlayerCc_1_1ActArrayProxy.html" alt="PlayerCc::ActArrayProxy" shape="rect" coords="223,56,436,80"/>
<area href="classPlayerCc_1_1AioProxy.html" alt="PlayerCc::AioProxy" shape="rect" coords="223,112,436,136"/>
<area href="classPlayerCc_1_1AudioProxy.html" alt="PlayerCc::AudioProxy" shape="rect" coords="223,168,436,192"/>
<area href="classPlayerCc_1_1BlackBoardProxy.html" alt="PlayerCc::BlackBoardProxy" shape="rect" coords="223,224,436,248"/>
<area href="classPlayerCc_1_1BlobfinderProxy.html" alt="PlayerCc::BlobfinderProxy" shape="rect" coords="223,280,436,304"/>
<area href="classPlayerCc_1_1BumperProxy.html" alt="PlayerCc::BumperProxy" shape="rect" coords="223,336,436,360"/>
<area href="classPlayerCc_1_1CameraProxy.html" alt="PlayerCc::CameraProxy" shape="rect" coords="223,392,436,416"/>
<area href="classPlayerCc_1_1DioProxy.html" alt="PlayerCc::DioProxy" shape="rect" coords="223,448,436,472"/>
<area href="classPlayerCc_1_1FiducialProxy.html" alt="PlayerCc::FiducialProxy" shape="rect" coords="223,504,436,528"/>
<area href="classPlayerCc_1_1GpsProxy.html" alt="PlayerCc::GpsProxy" shape="rect" coords="223,560,436,584"/>
<area href="classPlayerCc_1_1Graphics2dProxy.html" alt="PlayerCc::Graphics2dProxy" shape="rect" coords="223,616,436,640"/>
<area href="classPlayerCc_1_1Graphics3dProxy.html" alt="PlayerCc::Graphics3dProxy" shape="rect" coords="223,672,436,696"/>
<area href="classPlayerCc_1_1GripperProxy.html" alt="PlayerCc::GripperProxy" shape="rect" coords="223,728,436,752"/>
<area href="classPlayerCc_1_1HealthProxy.html" alt="PlayerCc::HealthProxy" shape="rect" coords="223,784,436,808"/>
<area href="classPlayerCc_1_1ImuProxy.html" alt="PlayerCc::ImuProxy" shape="rect" coords="223,840,436,864"/>
<area href="classPlayerCc_1_1IrProxy.html" alt="PlayerCc::IrProxy" shape="rect" coords="223,896,436,920"/>
<area href="classPlayerCc_1_1LaserProxy.html" alt="PlayerCc::LaserProxy" shape="rect" coords="223,952,436,976"/>
<area href="classPlayerCc_1_1LimbProxy.html" alt="PlayerCc::LimbProxy" shape="rect" coords="223,1008,436,1032"/>
<area href="classPlayerCc_1_1LinuxjoystickProxy.html" alt="PlayerCc::LinuxjoystickProxy" shape="rect" coords="223,1064,436,1088"/>
<area href="classPlayerCc_1_1LocalizeProxy.html" alt="PlayerCc::LocalizeProxy" shape="rect" coords="223,1120,436,1144"/>
<area href="classPlayerCc_1_1LogProxy.html" alt="PlayerCc::LogProxy" shape="rect" coords="223,1176,436,1200"/>
<area href="classPlayerCc_1_1MapProxy.html" alt="PlayerCc::MapProxy" shape="rect" coords="223,1232,436,1256"/>
<area href="classPlayerCc_1_1OpaqueProxy.html" alt="PlayerCc::OpaqueProxy" shape="rect" coords="223,1288,436,1312"/>
<area href="classPlayerCc_1_1PlannerProxy.html" alt="PlayerCc::PlannerProxy" shape="rect" coords="223,1344,436,1368"/>
<area href="classPlayerCc_1_1Pointcloud3dProxy.html" alt="PlayerCc::Pointcloud3dProxy" shape="rect" coords="223,1400,436,1424"/>
<area href="classPlayerCc_1_1Position1dProxy.html" alt="PlayerCc::Position1dProxy" shape="rect" coords="223,1456,436,1480"/>
<area href="classPlayerCc_1_1Position2dProxy.html" alt="PlayerCc::Position2dProxy" shape="rect" coords="223,1512,436,1536"/>
<area href="classPlayerCc_1_1Position3dProxy.html" alt="PlayerCc::Position3dProxy" shape="rect" coords="223,1568,436,1592"/>
<area href="classPlayerCc_1_1PowerProxy.html" alt="PlayerCc::PowerProxy" shape="rect" coords="223,1624,436,1648"/>
<area href="classPlayerCc_1_1PtzProxy.html" alt="PlayerCc::PtzProxy" shape="rect" coords="223,1680,436,1704"/>
<area href="classPlayerCc_1_1RangerProxy.html" alt="PlayerCc::RangerProxy" shape="rect" coords="223,1736,436,1760"/>
<area href="classPlayerCc_1_1RFIDProxy.html" alt="PlayerCc::RFIDProxy" shape="rect" coords="223,1792,436,1816"/>
<area href="classPlayerCc_1_1SimulationProxy.html" alt="PlayerCc::SimulationProxy" shape="rect" coords="223,1848,436,1872"/>
<area href="classPlayerCc_1_1SonarProxy.html" alt="PlayerCc::SonarProxy" shape="rect" coords="223,1904,436,1928"/>
<area href="classPlayerCc_1_1SpeechProxy.html" alt="PlayerCc::SpeechProxy" shape="rect" coords="223,1960,436,1984"/>
<area href="classPlayerCc_1_1SpeechRecognitionProxy.html" alt="PlayerCc::SpeechRecognitionProxy" shape="rect" coords="223,2016,436,2040"/>
<area href="classPlayerCc_1_1VectorMapProxy.html" alt="PlayerCc::VectorMapProxy" shape="rect" coords="223,2072,436,2096"/>
<area href="classPlayerCc_1_1WiFiProxy.html" alt="PlayerCc::WiFiProxy" shape="rect" coords="223,2128,436,2152"/>
<area href="classPlayerCc_1_1WSNProxy.html" alt="PlayerCc::WSNProxy" shape="rect" coords="223,2184,436,2208"/>
</map>
</div>
<p><a href="classPlayerCc_1_1ClientProxy-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a346a6d6d100f47cebfd0829d604fa109"></a><!-- doxytag: member="PlayerCc::ClientProxy::connection_t" ref="a346a6d6d100f47cebfd0829d604fa109" args="" -->
typedef int </td><td class="memItemRight" valign="bottom"><b>connection_t</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76437a0c42747630f61dfd3d1ee07951"></a><!-- doxytag: member="PlayerCc::ClientProxy::scoped_lock_t" ref="a76437a0c42747630f61dfd3d1ee07951" args="" -->
typedef <a class="el" href="classboost_1_1mutex_1_1scoped__lock.html">boost::mutex::scoped_lock</a> </td><td class="memItemRight" valign="bottom"><b>scoped_lock_t</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b6d9e5f66cc35a72965ffbc1fa762d5"></a><!-- doxytag: member="PlayerCc::ClientProxy::read_signal_t" ref="a0b6d9e5f66cc35a72965ffbc1fa762d5" args="" -->
typedef int </td><td class="memItemRight" valign="bottom"><b>read_signal_t</b></td></tr>
<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="a8edcdebde9527ca71d11890ccfe30e2c"></a><!-- doxytag: member="PlayerCc::ClientProxy::IsValid" ref="a8edcdebde9527ca71d11890ccfe30e2c" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a8edcdebde9527ca71d11890ccfe30e2c">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 class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a8e4cc50741acf3dcb435a45c56173821">IsFresh</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fresh is set to true on each new read. <a href="#a8e4cc50741acf3dcb435a45c56173821"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69917f6ff5aed875abc9058aab95e858"></a><!-- doxytag: member="PlayerCc::ClientProxy::NotFresh" ref="a69917f6ff5aed875abc9058aab95e858" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a69917f6ff5aed875abc9058aab95e858">NotFresh</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This states that the data in a client is currently not Fresh. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a4057929568e8d25843119f76b01ab48d">GetDriverName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the driver name. <a href="#a4057929568e8d25843119f76b01ab48d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5fc04494560ddc7b14678d1d79916b5"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetDataTime" ref="ae5fc04494560ddc7b14678d1d79916b5" args="() const " -->
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#ae5fc04494560ddc7b14678d1d79916b5">GetDataTime</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the received timestamp [s]. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79312c4542f58611fb7725d84b20c737"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetElapsedTime" ref="a79312c4542f58611fb7725d84b20c737" args="() const " -->
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a79312c4542f58611fb7725d84b20c737">GetElapsedTime</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the received timestamp [s]. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae45a48e238dad87609b141bb97789b68"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetPlayerClient" ref="ae45a48e238dad87609b141bb97789b68" args="() const " -->
<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#ae45a48e238dad87609b141bb97789b68">GetPlayerClient</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the Player Client. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac00ee4a1087c568c5f99ebb8e148f451"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetIndex" ref="ac00ee4a1087c568c5f99ebb8e148f451" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#ac00ee4a1087c568c5f99ebb8e148f451">GetIndex</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns device index. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2992e2d8b7a5572b8ce33a59942307ad"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetInterface" ref="a2992e2d8b7a5572b8ce33a59942307ad" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a2992e2d8b7a5572b8ce33a59942307ad">GetInterface</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns device interface. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ad4831f9aa452bf04507d807f365730"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetInterfaceStr" ref="a5ad4831f9aa452bf04507d807f365730" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a5ad4831f9aa452bf04507d807f365730">GetInterfaceStr</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns device interface. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a58d315e428437eb8eebdbd93f1f0e78d">SetReplaceRule</a> (bool aReplace, int aType=-1, int aSubtype=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a replace rule for this proxy on the server. <a href="#a58d315e428437eb8eebdbd93f1f0e78d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a32fcd92bb17e559cd69deea76a0b0f3d">HasCapability</a> (uint32_t aType, uint32_t aSubtype)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request capabilities of device. <a href="#a32fcd92bb17e559cd69deea76a0b0f3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad36686b254e0f5ec6d0aef3d31e8b084"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetBoolProp" ref="ad36686b254e0f5ec6d0aef3d31e8b084" args="(char *aProperty, bool *aValue)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#ad36686b254e0f5ec6d0aef3d31e8b084">GetBoolProp</a> (char *aProperty, bool *aValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a boolean property. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecd5f0bf35c0a1fc9d77371e35976395"></a><!-- doxytag: member="PlayerCc::ClientProxy::SetBoolProp" ref="aecd5f0bf35c0a1fc9d77371e35976395" args="(char *aProperty, bool aValue)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#aecd5f0bf35c0a1fc9d77371e35976395">SetBoolProp</a> (char *aProperty, bool aValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a boolean property. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee7f94929d15042ddf2ced658e94401d"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetIntProp" ref="aee7f94929d15042ddf2ced658e94401d" args="(char *aProperty, int32_t *aValue)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#aee7f94929d15042ddf2ced658e94401d">GetIntProp</a> (char *aProperty, int32_t *aValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request an integer property. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6484d99d0a51f9f10640b38491e6d16"></a><!-- doxytag: member="PlayerCc::ClientProxy::SetIntProp" ref="af6484d99d0a51f9f10640b38491e6d16" args="(char *aProperty, int32_t aValue)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#af6484d99d0a51f9f10640b38491e6d16">SetIntProp</a> (char *aProperty, int32_t aValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an integer property. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfe215d6c71e4a6af6197c486cc6eb31"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetDblProp" ref="abfe215d6c71e4a6af6197c486cc6eb31" args="(char *aProperty, double *aValue)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#abfe215d6c71e4a6af6197c486cc6eb31">GetDblProp</a> (char *aProperty, double *aValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a double property. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ffc6004dd3f4c198fdb0e1045be382a"></a><!-- doxytag: member="PlayerCc::ClientProxy::SetDblProp" ref="a6ffc6004dd3f4c198fdb0e1045be382a" args="(char *aProperty, double aValue)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a6ffc6004dd3f4c198fdb0e1045be382a">SetDblProp</a> (char *aProperty, double aValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a double property. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75ef050aedb96210ca05dbcc9f1c060d"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetStrProp" ref="a75ef050aedb96210ca05dbcc9f1c060d" args="(char *aProperty, char **aValue)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a75ef050aedb96210ca05dbcc9f1c060d">GetStrProp</a> (char *aProperty, char **aValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a string property. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefc48d99ceb7234b48d78471ae5b9df1"></a><!-- doxytag: member="PlayerCc::ClientProxy::SetStrProp" ref="aefc48d99ceb7234b48d78471ae5b9df1" args="(char *aProperty, char *aValue)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#aefc48d99ceb7234b48d78471ae5b9df1">SetStrProp</a> (char *aProperty, char *aValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string property. <br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a8d2a82e31f62e3ca94cad558bd7ebcdd"></a><!-- doxytag: member="PlayerCc::ClientProxy::ConnectReadSignal" ref="a8d2a82e31f62e3ca94cad558bd7ebcdd" args="(T aSubscriber)" -->
template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">connection_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a8d2a82e31f62e3ca94cad558bd7ebcdd">ConnectReadSignal</a> (T aSubscriber)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a signal to this proxy For more information check out <a class="el" href="group__player__clientlib__multi.html">Signals & multithreading</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c7c63c32ae3c69f3469f71746580e7f"></a><!-- doxytag: member="PlayerCc::ClientProxy::DisconnectReadSignal" ref="a8c7c63c32ae3c69f3469f71746580e7f" args="(connection_t aSubscriber)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1ClientProxy.html#a8c7c63c32ae3c69f3469f71746580e7f">DisconnectReadSignal</a> (connection_t aSubscriber)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect a signal to this proxy. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a182f6b452f4592eb7cb6f85d82a168f1"></a><!-- doxytag: member="PlayerCc::ClientProxy::ClientProxy" ref="a182f6b452f4592eb7cb6f85d82a168f1" args="(PlayerClient *aPc, uint32_t aIndex)" -->
</td><td class="memItemRight" valign="bottom"><b>ClientProxy</b> (<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> *aPc, uint32_t aIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bc8f68fbbafbe74c152da31109ebbf4"></a><!-- doxytag: member="PlayerCc::ClientProxy::Subscribe" ref="a0bc8f68fbbafbe74c152da31109ebbf4" args="(uint32_t)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>Subscribe</b> (uint32_t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58743fafdbae31f389ecd2578ad30c6d"></a><!-- doxytag: member="PlayerCc::ClientProxy::Unsubscribe" ref="a58743fafdbae31f389ecd2578ad30c6d" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>Unsubscribe</b> ()</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ab8ca9366d668870d1d4c84ebfbb3ecf0"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetVar" ref="ab8ca9366d668870d1d4c84ebfbb3ecf0" args="(const T &aV) const " -->
template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><b>GetVar</b> (const T &aV) const </td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a88b971ef7c71789065c805d1e94a956f"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetVarByRef" ref="a88b971ef7c71789065c805d1e94a956f" args="(const T aBegin, const T aEnd, T aDest) const " -->
template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>GetVarByRef</b> (const T aBegin, const T aEnd, T aDest) const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c35cce4955091822fe345dfc8ecd342"></a><!-- doxytag: member="PlayerCc::ClientProxy::mPc" ref="a3c35cce4955091822fe345dfc8ecd342" args="" -->
<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> * </td><td class="memItemRight" valign="bottom"><b>mPc</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebc38d4c6a3e7bd6027bcabe2d78d30c"></a><!-- doxytag: member="PlayerCc::ClientProxy::mClient" ref="aebc38d4c6a3e7bd6027bcabe2d78d30c" args="" -->
<a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> * </td><td class="memItemRight" valign="bottom"><b>mClient</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0d6da077569c16fa6a990576a20b197"></a><!-- doxytag: member="PlayerCc::ClientProxy::mInfo" ref="ad0d6da077569c16fa6a990576a20b197" args="" -->
<a class="el" href="struct__playerc__device__t.html">playerc_device_t</a> * </td><td class="memItemRight" valign="bottom"><b>mInfo</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6173fd75f60027825988c57a8ccdffe8"></a><!-- doxytag: member="PlayerCc::ClientProxy::mFresh" ref="a6173fd75f60027825988c57a8ccdffe8" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>mFresh</b></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="adc5c45876b159e5899d997cb82ab6373"></a><!-- doxytag: member="PlayerCc::ClientProxy::ReadSignal" ref="adc5c45876b159e5899d997cb82ab6373" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>ReadSignal</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="acfac50d9b2c23d8b21022a3d0b33e311"></a><!-- doxytag: member="PlayerCc::ClientProxy::mLastTime" ref="acfac50d9b2c23d8b21022a3d0b33e311" args="" -->
double </td><td class="memItemRight" valign="bottom"><b>mLastTime</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf192360ed5d4bcf6cec19b2b8f8b43a"></a><!-- doxytag: member="PlayerCc::ClientProxy::mReadSignal" ref="acf192360ed5d4bcf6cec19b2b8f8b43a" args="" -->
read_signal_t </td><td class="memItemRight" valign="bottom"><b>mReadSignal</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The client proxy base class. </p>
<p>Base class for all proxy devices. Access to a device is provided by a device-specific proxy class. These classes all inherit from the <code><a class="el" href="classPlayerCc_1_1ClientProxy.html" title="The client proxy base class.">ClientProxy</a></code> class which defines an interface for device proxies. As such, a few methods are common to all devices and we explain them here.</p>
<p>Since the <a class="el" href="classPlayerCc_1_1ClientProxy.html#a8d2a82e31f62e3ca94cad558bd7ebcdd" title="Connect a signal to this proxy For more information check out Signals & multithreading.">ConnectReadSignal()</a> and <a class="el" href="classPlayerCc_1_1ClientProxy.html#a8c7c63c32ae3c69f3469f71746580e7f" title="Disconnect a signal to this proxy.">DisconnectReadSignal()</a> member functions are based on the Boost signals library, they are conditionally available depending on Boost's presence in the system. See the <em>configure</em> script for more information. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4057929568e8d25843119f76b01ab48d"></a><!-- doxytag: member="PlayerCc::ClientProxy::GetDriverName" ref="a4057929568e8d25843119f76b01ab48d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string PlayerCc::ClientProxy::GetDriverName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the driver name. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000053">Todo:</a></b></dt><dd>GetDriverName isn't guarded by locks yet </dd></dl>
</div>
</div>
<a class="anchor" id="a32fcd92bb17e559cd69deea76a0b0f3d"></a><!-- doxytag: member="PlayerCc::ClientProxy::HasCapability" ref="a32fcd92bb17e559cd69deea76a0b0f3d" args="(uint32_t aType, uint32_t aSubtype)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PlayerCc::ClientProxy::HasCapability </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>aType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>aSubtype</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request capabilities of device. </p>
<p>Send a message asking if the device supports the given message type and subtype. If it does, the return value will be 1, and 0 otherwise. </p>
</div>
</div>
<a class="anchor" id="a8e4cc50741acf3dcb435a45c56173821"></a><!-- doxytag: member="PlayerCc::ClientProxy::IsFresh" ref="a8e4cc50741acf3dcb435a45c56173821" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PlayerCc::ClientProxy::IsFresh </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fresh is set to true on each new read. </p>
<p>It is up to the user to set it to false if the data has already been read. This is most useful when used in conjunction with the PlayerMultiClient </p>
</div>
</div>
<a class="anchor" id="a58d315e428437eb8eebdbd93f1f0e78d"></a><!-- doxytag: member="PlayerCc::ClientProxy::SetReplaceRule" ref="a58d315e428437eb8eebdbd93f1f0e78d" args="(bool aReplace, int aType=-1, int aSubtype=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PlayerCc::ClientProxy::SetReplaceRule </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>aReplace</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>aType</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>aSubtype</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a replace rule for this proxy on the server. </p>
<p>If a rule with the same pattern already exists, it will be replaced with the new rule (i.e., its setting to replace will be updated). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aReplace</em> </td><td>Should we replace these messages </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aType</em> </td><td>The type to set replace rule for (-1 for wildcard), see <a class="el" href="group__message__types.html">Message types</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aSubtype</em> </td><td><a class="el" href="classMessage.html" title="Reference-counted message objects.">Message</a> subtype to set replace rule for (-1 for wildcard). This is dependent on the <a class="el" href="group__interfaces.html">Interface specifications</a>.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>throws</em> </td><td><a class="el" href="classPlayerCc_1_1PlayerError.html" title="The C++ exception class.">PlayerError</a> if unsuccessfull</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classPlayerCc_1_1PlayerClient.html#a496845414a96f05d3abb16a3a267b7e2" title="Set a replace rule for the clients queue on the server.">PlayerClient::SetReplaceRule</a>, <a class="el" href="classPlayerCc_1_1PlayerClient.html#a55a44a2fe0813776a9f2b011f624dfc0" title="Set whether the client operates in Push/Pull modes.">PlayerClient::SetDataMode</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="clientproxy_8h_source.html">clientproxy.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
>
224
