<!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"/>
<title>RAUL: Raul::Symbol Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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 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 class="navpath">
<ul>
<li><b>Raul</b> </li>
<li><a class="el" href="classRaul_1_1Symbol.html">Raul::Symbol</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">
<h1>Raul::Symbol Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::Symbol" -->
<p>A restricted string (C identifier, which is a component of a <a class="el" href="classRaul_1_1Path.html" title="A URI which is a path (for example a filesystem or OSC path).">Path</a>).
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Symbol_8hpp_source.html">Symbol.hpp</a>></code></p>
<p><a href="classRaul_1_1Symbol-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="classRaul_1_1Symbol.html#a8dde80166fbf1146fb0960219f308dc1">Symbol</a> (const std::basic_string< char > &symbol)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classRaul_1_1Symbol.html" title="A restricted string (C identifier, which is a component of a Path).">Symbol</a> from an std::string. <a href="#a8dde80166fbf1146fb0960219f308dc1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Symbol.html#af37ad9d445562f9463f5d03f5a339e56">Symbol</a> (const char *csymbol)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classRaul_1_1Symbol.html" title="A restricted string (C identifier, which is a component of a Path).">Symbol</a> from a C string. <a href="#af37ad9d445562f9463f5d03f5a339e56"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad913775b516f58bea16d1e95899d0dd5"></a><!-- doxytag: member="Raul::Symbol::c_str" ref="ad913775b516f58bea16d1e95899d0dd5" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><b>c_str</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff901681063aae2a9ff3792e1531a3cc"></a><!-- doxytag: member="Raul::Symbol::operator==" ref="aff901681063aae2a9ff3792e1531a3cc" args="(const Symbol &other) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classRaul_1_1Symbol.html">Symbol</a> &other) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf3b71c499cb04f0d12ac4162fe5feb5"></a><!-- doxytag: member="Raul::Symbol::operator!=" ref="aaf3b71c499cb04f0d12ac4162fe5feb5" args="(const Symbol &other) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classRaul_1_1Symbol.html">Symbol</a> &other) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada0d53dbfa0b88337dd22a193a38a03d"></a><!-- doxytag: member="Raul::Symbol::operator<" ref="ada0d53dbfa0b88337dd22a193a38a03d" args="(const Symbol &other) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>operator<</b> (const <a class="el" href="classRaul_1_1Symbol.html">Symbol</a> &other) const </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"><a class="anchor" id="a0e053e49da36135232af669c1921b652"></a><!-- doxytag: member="Raul::Symbol::is_valid" ref="a0e053e49da36135232af669c1921b652" args="(const std::basic_string< char > &symbol)" -->
static bool </td><td class="memItemRight" valign="bottom"><b>is_valid</b> (const std::basic_string< char > &symbol)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Symbol.html#a67523331e120cdfd75c359461a99f311">symbolify</a> (const std::basic_string< char > &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a string to a valid symbol. <a href="#a67523331e120cdfd75c359461a99f311"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A restricted string (C identifier, which is a component of a <a class="el" href="classRaul_1_1Path.html" title="A URI which is a path (for example a filesystem or OSC path).">Path</a>). </p>
<p>A <a class="el" href="classRaul_1_1Symbol.html" title="A restricted string (C identifier, which is a component of a Path).">Symbol</a> is a very restricted string suitable for use as an identifier. It is a valid LV2 symbol, <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> fragment, filename, OSC path fragment, and identifier for most programming languages (including C).</p>
<p>Valid characters are _, a-z, A-Z, 0-9, except the first character which must not be 0-9. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8dde80166fbf1146fb0960219f308dc1"></a><!-- doxytag: member="Raul::Symbol::Symbol" ref="a8dde80166fbf1146fb0960219f308dc1" args="(const std::basic_string< char > &symbol)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Raul::Symbol::Symbol </td>
<td>(</td>
<td class="paramtype">const std::basic_string< char > & </td>
<td class="paramname"> <em>symbol</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classRaul_1_1Symbol.html" title="A restricted string (C identifier, which is a component of a Path).">Symbol</a> from an std::string. </p>
<p>It is a fatal error to construct a <a class="el" href="classRaul_1_1Symbol.html" title="A restricted string (C identifier, which is a component of a Path).">Symbol</a> from an invalid string, use is_valid first to check. </p>
</div>
</div>
<a class="anchor" id="af37ad9d445562f9463f5d03f5a339e56"></a><!-- doxytag: member="Raul::Symbol::Symbol" ref="af37ad9d445562f9463f5d03f5a339e56" args="(const char *csymbol)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Raul::Symbol::Symbol </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>csymbol</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classRaul_1_1Symbol.html" title="A restricted string (C identifier, which is a component of a Path).">Symbol</a> from a C string. </p>
<p>It is a fatal error to construct a <a class="el" href="classRaul_1_1Symbol.html" title="A restricted string (C identifier, which is a component of a Path).">Symbol</a> from an invalid string, use is_valid first to check. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a67523331e120cdfd75c359461a99f311"></a><!-- doxytag: member="Raul::Symbol::symbolify" ref="a67523331e120cdfd75c359461a99f311" args="(const std::basic_string< char > &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Raul::Symbol::symbolify </td>
<td>(</td>
<td class="paramtype">const std::basic_string< char > & </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a string to a valid symbol. </p>
<p>This will make a best effort at turning <em>str</em> into a complete, valid <a class="el" href="classRaul_1_1Symbol.html" title="A restricted string (C identifier, which is a component of a Path).">Symbol</a>, and will always return one. </p>
<p>References <a class="el" href="classRaul_1_1Path.html#ad1ffe394b2a4cb2c065a4cd50d55f63b">Raul::Path::replace_invalid_chars()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Symbol_8hpp_source.html">Symbol.hpp</a></li>
<li>Symbol.cpp</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
170
