<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>edelib: EdbusObjectPath Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">edelib
 <span id="projectnumber">2.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceedelib.html">edelib</a> </li>
<li class="navelem"><a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">EdbusObjectPath Class Reference<div class="ingroups"><a class="el" href="group__dbus.html">D-Bus classes and functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="edelib::EdbusObjectPath" -->
<p>Represents D-Bus object path.
<a href="classedelib_1_1EdbusObjectPath.html#details">More...</a></p>
<p><code>#include <<a class="el" href="EdbusObjectPath_8h_source.html">edelib/EdbusObjectPath.h</a>></code></p>
<p><a href="classedelib_1_1EdbusObjectPath-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a20d765b9c6b855064a8cbc8b72aaec79">EdbusObjectPath</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#adcf8a56743c57943a569c590d4b30ff4">EdbusObjectPath</a> (const char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a64dcdc8d526f73c47d7aa50de68aef8e">EdbusObjectPath</a> (const <a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a8a0f63f6c6fa2a1cc2ed5c661cfcf6aa">~EdbusObjectPath</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a1901e642ccf2ba24a81a749d6c464896">append</a> (const char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#ae683fe63c33c388e9ba1c6392dd477eb">clear</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a473d8c06e5fa3bee06340b63cc236000">path</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a9214b4292490e5558658119eda2a95dd">operator==</a> (const <a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> &other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a74ad949e932fae4325d83579affd2a58">operator!=</a> (const <a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> &other)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#aacd0a15192eed93f313405f002055a91">valid_element</a> (const char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a1cb38a05a785224d8c9ae43432712f79">valid_path</a> (const char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1EdbusObjectPath.html#a88ba5d4e61e7122c9efb44948f036352">valid_path</a> (const <a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> &<a class="el" href="classedelib_1_1EdbusObjectPath.html#a473d8c06e5fa3bee06340b63cc236000">path</a>)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Represents D-Bus object path. </p>
<p>This data type is necessary to correctly represents D-Bus object path since D-Bus protocol limits character range that should be in object path name. Also, D-Bus have different signature for object paths than for ordinary strings.</p>
<p>Valid path is that string that contains elements with <em>[A-Z][a-z][0-9]_</em> characters, separated by <em>//</em> character. The path must begin with <em>//</em>, and must not ends with it (except path contains only root). E.g. </p>
<div class="fragment"><pre class="fragment"> Valid paths:
/
/org/foo/baz
Invalid paths:
<span class="comment">//</span>
/org/foo/baz/
/org<span class="comment">//foo/baz</span>
...
</pre></div><p>This class will always construct valid path, so if parameter with invalid character range is given, it will ignore it.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000013">Todo:</a></b></dt><dd>Make this class implicitly shared </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a20d765b9c6b855064a8cbc8b72aaec79"></a><!-- doxytag: member="edelib::EdbusObjectPath::EdbusObjectPath" ref="a20d765b9c6b855064a8cbc8b72aaec79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct root-ed path(<em>//</em>) </p>
</div>
</div>
<a class="anchor" id="adcf8a56743c57943a569c590d4b30ff4"></a><!-- doxytag: member="edelib::EdbusObjectPath::EdbusObjectPath" ref="adcf8a56743c57943a569c590d4b30ff4" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use str as path. If str is not valid path, <a class="el" href="classedelib_1_1EdbusObjectPath.html" title="Represents D-Bus object path.">EdbusObjectPath</a> will ignore it, constructing only root-ed path</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>is string that should be valid path </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a64dcdc8d526f73c47d7aa50de68aef8e"></a><!-- doxytag: member="edelib::EdbusObjectPath::EdbusObjectPath" ref="a64dcdc8d526f73c47d7aa50de68aef8e" args="(const EdbusObjectPath &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy path from other <a class="el" href="classedelib_1_1EdbusObjectPath.html" title="Represents D-Bus object path.">EdbusObjectPath</a> object </p>
</div>
</div>
<a class="anchor" id="a8a0f63f6c6fa2a1cc2ed5c661cfcf6aa"></a><!-- doxytag: member="edelib::EdbusObjectPath::~EdbusObjectPath" ref="a8a0f63f6c6fa2a1cc2ed5c661cfcf6aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears data </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1901e642ccf2ba24a81a749d6c464896"></a><!-- doxytag: member="edelib::EdbusObjectPath::append" ref="a1901e642ccf2ba24a81a749d6c464896" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1EdbusObjectPath.html#a1901e642ccf2ba24a81a749d6c464896">append</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Appends str to the path. str should be path element (allowed characters without <em>//</em> character. If str is not valid element (you can validate it with <a class="el" href="classedelib_1_1EdbusObjectPath.html#aacd0a15192eed93f313405f002055a91">valid_element()</a> function, this function will ignore it).</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000014">Todo:</a></b></dt><dd>this should probably trigger assert if element is not valid </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>is path element </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="group__dbus.html#ga17bdb720457fba3d77b79058ed27970b">edelib::operator<<()</a>.</p>
</div>
</div>
<a class="anchor" id="ae683fe63c33c388e9ba1c6392dd477eb"></a><!-- doxytag: member="edelib::EdbusObjectPath::clear" ref="ae683fe63c33c388e9ba1c6392dd477eb" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1EdbusObjectPath.html#ae683fe63c33c388e9ba1c6392dd477eb">clear</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears data and construct root-ed path. </p>
</div>
</div>
<a class="anchor" id="a74ad949e932fae4325d83579affd2a58"></a><!-- doxytag: member="edelib::EdbusObjectPath::operator!=" ref="a74ad949e932fae4325d83579affd2a58" args="(const EdbusObjectPath &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Validate if two paths are not equal</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if they are not </dd></dl>
</div>
</div>
<a class="anchor" id="a9214b4292490e5558658119eda2a95dd"></a><!-- doxytag: member="edelib::EdbusObjectPath::operator==" ref="a9214b4292490e5558658119eda2a95dd" args="(const EdbusObjectPath &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Validate if two paths are equal</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if does </dd></dl>
</div>
</div>
<a class="anchor" id="a473d8c06e5fa3bee06340b63cc236000"></a><!-- doxytag: member="edelib::EdbusObjectPath::path" ref="a473d8c06e5fa3bee06340b63cc236000" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="classedelib_1_1EdbusObjectPath.html#a473d8c06e5fa3bee06340b63cc236000">path</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns object path </p>
<p>Referenced by <a class="el" href="classedelib_1_1EdbusObjectPath.html#a88ba5d4e61e7122c9efb44948f036352">EdbusObjectPath::valid_path()</a>.</p>
</div>
</div>
<a class="anchor" id="aacd0a15192eed93f313405f002055a91"></a><!-- doxytag: member="edelib::EdbusObjectPath::valid_element" ref="aacd0a15192eed93f313405f002055a91" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classedelib_1_1EdbusObjectPath.html#aacd0a15192eed93f313405f002055a91">valid_element</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if element is valid and can be used in path construction</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if is valid </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>is path element </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1cb38a05a785224d8c9ae43432712f79"></a><!-- doxytag: member="edelib::EdbusObjectPath::valid_path" ref="a1cb38a05a785224d8c9ae43432712f79" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classedelib_1_1EdbusObjectPath.html#a1cb38a05a785224d8c9ae43432712f79">valid_path</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if str is valid path</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if is valid </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>is full object path </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a88ba5d4e61e7122c9efb44948f036352"></a><!-- doxytag: member="edelib::EdbusObjectPath::valid_path" ref="a88ba5d4e61e7122c9efb44948f036352" args="(const EdbusObjectPath &path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classedelib_1_1EdbusObjectPath.html#a1cb38a05a785224d8c9ae43432712f79">valid_path</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classedelib_1_1EdbusObjectPath.html">EdbusObjectPath</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if <a class="el" href="classedelib_1_1EdbusObjectPath.html" title="Represents D-Bus object path.">EdbusObjectPath</a> object contains valid path. This function should always return true on fully constructed object.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if is valid </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>is <a class="el" href="classedelib_1_1EdbusObjectPath.html" title="Represents D-Bus object path.">EdbusObjectPath</a> object </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="classedelib_1_1EdbusObjectPath.html#a473d8c06e5fa3bee06340b63cc236000">EdbusObjectPath::path()</a>, and <a class="el" href="classedelib_1_1EdbusObjectPath.html#a88ba5d4e61e7122c9efb44948f036352">EdbusObjectPath::valid_path()</a>.</p>
<p>Referenced by <a class="el" href="classedelib_1_1EdbusObjectPath.html#a88ba5d4e61e7122c9efb44948f036352">EdbusObjectPath::valid_path()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>edelib/<a class="el" href="EdbusObjectPath_8h_source.html">EdbusObjectPath.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 5 2012 17:49:02 for edelib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
