Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 88959ca903fe50462ea99715ead18944 > files > 95

raul-devel-0.7.0-1.fc14.1.x86_64.rpm

<!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::Atom 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><b>Raul</b>      </li>
      <li><a class="el" href="classRaul_1_1Atom.html">Raul::Atom</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<h1>Raul::Atom Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::Atom" -->
<p>A piece of data with some type.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="Atom_8hpp_source.html">Atom.hpp</a>&gt;</code></p>

<p><a href="classRaul_1_1Atom-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">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>Type</b> { <br/>
&nbsp;&nbsp;<b>NIL</b>, 
<b>INT</b>, 
<b>FLOAT</b>, 
<b>BOOL</b>, 
<br/>
&nbsp;&nbsp;<b>URI</b>, 
<b>STRING</b>, 
<b>BLOB</b>, 
<b>DICT</b>
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88de1f9cf7559c45cbed6adda1e28fe5"></a><!-- doxytag: member="Raul::Atom::DictValue" ref="a88de1f9cf7559c45cbed6adda1e28fe5" args="" -->
typedef std::map&lt; <a class="el" href="classRaul_1_1Atom.html">Raul::Atom</a>, <br class="typebreak"/>
<a class="el" href="classRaul_1_1Atom.html">Raul::Atom</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>DictValue</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="a8c1f3f747c47e8a664c170f1bd0fa74b"></a><!-- doxytag: member="Raul::Atom::Atom" ref="a8c1f3f747c47e8a664c170f1bd0fa74b" args="(int32_t val)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Atom</b> (int32_t val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5e54cc58e0dc8fc0c0391fcc2d9db1b"></a><!-- doxytag: member="Raul::Atom::Atom" ref="ac5e54cc58e0dc8fc0c0391fcc2d9db1b" args="(float val)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Atom</b> (float val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab32022c1a1c457aa6d1c877f52261e06"></a><!-- doxytag: member="Raul::Atom::Atom" ref="ab32022c1a1c457aa6d1c877f52261e06" args="(bool val)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Atom</b> (bool val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2ce1d6d8899639ab7b02405c37c235f"></a><!-- doxytag: member="Raul::Atom::Atom" ref="af2ce1d6d8899639ab7b02405c37c235f" args="(const char *val)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Atom</b> (const char *val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a367199643f44a63d7ab651dcd653d9"></a><!-- doxytag: member="Raul::Atom::Atom" ref="a6a367199643f44a63d7ab651dcd653d9" args="(const std::string &amp;val)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Atom</b> (const std::string &amp;val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4511058ddd3abeef6a56835abd04e0f"></a><!-- doxytag: member="Raul::Atom::Atom" ref="ab4511058ddd3abeef6a56835abd04e0f" args="(Type t, const std::string &amp;val)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Atom.html#ab4511058ddd3abeef6a56835abd04e0f">Atom</a> (Type t, const std::string &amp;val)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a> constructor (<em>t</em> must be <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a>). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6fc01e6873d4c848afac5ef1a89341b"></a><!-- doxytag: member="Raul::Atom::Atom" ref="aa6fc01e6873d4c848afac5ef1a89341b" args="(const char *type_uri, size_t size, void *val)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Atom</b> (const char *type_uri, size_t size, void *val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a681f58844a7cd4663f515b5e4e7bdc43"></a><!-- doxytag: member="Raul::Atom::Atom" ref="a681f58844a7cd4663f515b5e4e7bdc43" args="(const DictValue &amp;dict)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Atom</b> (const DictValue &amp;dict)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac22d75a87533aa1f6700618799ae38fe"></a><!-- doxytag: member="Raul::Atom::Atom" ref="ac22d75a87533aa1f6700618799ae38fe" args="(const Atom &amp;copy)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Atom</b> (const <a class="el" href="classRaul_1_1Atom.html">Atom</a> &amp;copy)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80ea4dabad39b4b9af820c9cea4a9aba"></a><!-- doxytag: member="Raul::Atom::operator=" ref="a80ea4dabad39b4b9af820c9cea4a9aba" args="(const Atom &amp;other)" -->
<a class="el" href="classRaul_1_1Atom.html">Atom</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classRaul_1_1Atom.html">Atom</a> &amp;other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6492b83b28e36943d3aa70e2beb42370"></a><!-- doxytag: member="Raul::Atom::operator==" ref="a6492b83b28e36943d3aa70e2beb42370" args="(const Atom &amp;other) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classRaul_1_1Atom.html">Atom</a> &amp;other) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbec0bb99122c13b9123664eeba84ce5"></a><!-- doxytag: member="Raul::Atom::operator!=" ref="adbec0bb99122c13b9123664eeba84ce5" args="(const Atom &amp;other) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classRaul_1_1Atom.html">Atom</a> &amp;other) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b522b2313afc1f9735bc09cb121e6e9"></a><!-- doxytag: member="Raul::Atom::operator&lt;" ref="a6b522b2313afc1f9735bc09cb121e6e9" args="(const Atom &amp;other) const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (const <a class="el" href="classRaul_1_1Atom.html">Atom</a> &amp;other) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1701ca997aed7a9db652a12dc3fa0d6a"></a><!-- doxytag: member="Raul::Atom::data_size" ref="a1701ca997aed7a9db652a12dc3fa0d6a" args="() const " -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>data_size</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae22db18bb56ab5375ac5971302b104fa"></a><!-- doxytag: member="Raul::Atom::is_valid" ref="ae22db18bb56ab5375ac5971302b104fa" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_valid</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Type&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Atom.html#a9221752e4e19d52178388d811815c33c">type</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of this atom.  <a href="#a9221752e4e19d52178388d811815c33c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6f5faab435a276c2a73657b34b5e456"></a><!-- doxytag: member="Raul::Atom::get_int32" ref="ac6f5faab435a276c2a73657b34b5e456" args="() const " -->
int32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_int32</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8c4f0aeac99b849dbe932731d2ebd64"></a><!-- doxytag: member="Raul::Atom::get_float" ref="ac8c4f0aeac99b849dbe932731d2ebd64" args="() const " -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_float</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e464f014177eb61510400be5eceec21"></a><!-- doxytag: member="Raul::Atom::get_bool" ref="a0e464f014177eb61510400be5eceec21" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_bool</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48dfb45f5c8daf013bcf1f154285c6b7"></a><!-- doxytag: member="Raul::Atom::get_string" ref="a48dfb45f5c8daf013bcf1f154285c6b7" args="() const " -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_string</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec895bbe9fd591ee735fbb4e47e5a20e"></a><!-- doxytag: member="Raul::Atom::get_uri" ref="aec895bbe9fd591ee735fbb4e47e5a20e" args="() const " -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_uri</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8dbd68ee5e887820fe5b4de6dfd9ae3f"></a><!-- doxytag: member="Raul::Atom::get_blob_type" ref="a8dbd68ee5e887820fe5b4de6dfd9ae3f" args="() const " -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_blob_type</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ac12a67249b1c842e08c6bee2ba2d7a"></a><!-- doxytag: member="Raul::Atom::get_blob" ref="a6ac12a67249b1c842e08c6bee2ba2d7a" args="() const " -->
const void *&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_blob</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cfd3d6b89bb6af25585690b8fcedb65"></a><!-- doxytag: member="Raul::Atom::get_dict" ref="a2cfd3d6b89bb6af25585690b8fcedb65" args="() const " -->
const DictValue &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_dict</b> () const </td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02d00789c9002d140fcf20caa86f65cd"></a><!-- doxytag: member="Raul::Atom::Raul::URI" ref="a02d00789c9002d140fcf20caa86f65cd" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Atom.html#a02d00789c9002d140fcf20caa86f65cd">Raul::URI</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A piece of data with some type. </p>
<p>Atoms can be of various primitive types (integer, float, etc) as well as a string or primitive. The primitive types are entirely contained within the <a class="el" href="classRaul_1_1Atom.html" title="A piece of data with some type.">Atom</a>, i.e. the <a class="el" href="classRaul_1_1Atom.html" title="A piece of data with some type.">Atom</a> is POD. String, <a class="el" href="classRaul_1_1URI.html" title="Simple wrapper around standard string with useful URI-specific methods.">URI</a>, and blob atoms are not POD. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9221752e4e19d52178388d811815c33c"></a><!-- doxytag: member="Raul::Atom::type" ref="a9221752e4e19d52178388d811815c33c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Type Raul::Atom::type </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Type of this atom. </p>
<p>Always check this before attempting to get the value - attempting to get the incorrectly typed value is a fatal error. </p>

<p>Referenced by <a class="el" href="classRaul_1_1Configuration.html#a9508a88d36f6a7ef2353f1a01b88942d">Raul::Configuration::add()</a>, <a class="el" href="namespaceRaul_1_1AtomRDF.html#a0374df42714ef17364bbbc7e2bcd0a1b">Raul::AtomRDF::atom_to_node()</a>, and <a class="el" href="namespaceRaul_1_1AtomLiblo.html#ae6f004808bc96d7e3536e1d5a249545d">Raul::AtomLiblo::lo_message_add_atom()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Atom_8hpp_source.html">Atom.hpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>