Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 14971

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>mrpt::utils::TEnumType Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> &gt; <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
          <div class="left">
            <form id="FSearchBox" action="search.php" method="get">
              <img id="MSearchSelect" src="search/mag.png" alt=""/>
              <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" 
                     onfocus="searchBox.OnSearchFieldFocus(true)" 
                     onblur="searchBox.OnSearchFieldFocus(false)"/>
            </form>
          </div><div class="right"></div>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a>      </li>
      <li class="navelem"><a class="el" href="namespacemrpt_1_1utils.html">utils</a>      </li>
      <li class="navelem"><a class="el" href="structmrpt_1_1utils_1_1_t_enum_type.html">TEnumType</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">mrpt::utils::TEnumType Struct Reference<div class="ingroups"><a class="el" href="group__mrpt__base__grp.html">[mrpt-base]</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::utils::TEnumType" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A helper class that can convert an enum value into its textual representation, and viceversa. </p>
</div>
<p><code>#include &lt;<a class="el" href="_t_enum_type_8h_source.html">mrpt/utils/TEnumType.h</a>&gt;</code></p>

<p><a href="structmrpt_1_1utils_1_1_t_enum_type-members.html">List of all members.</a></p>
<table class="memberdecls">
<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 ENUMTYPE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_enum_type.html#a17c74be362636780836d70c0ed5857e4">name2value</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gives the numerical name for a given enum text name </p>
<dl><dt><b>Exceptions:</b></dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classstd_1_1exception.html" title="STL class.">std::exception</a></td><td>on unknown enum name. </td></tr>
  </table>
  </dd>
</dl>
 <a href="#a17c74be362636780836d70c0ed5857e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classstd_1_1string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_enum_type.html#a60b778bf271cdcd4180d31e3376df6a0">value2name</a> (const ENUMTYPE val)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gives the textual name for a given enum value </p>
<dl><dt><b>Exceptions:</b></dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classstd_1_1exception.html" title="STL class.">std::exception</a></td><td>on unknown enum value name. </td></tr>
  </table>
  </dd>
</dl>
 <a href="#a60b778bf271cdcd4180d31e3376df6a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmrpt_1_1utils_1_1bimap.html">bimap</a>&lt; ENUMTYPE, <br class="typebreak"/>
<a class="el" href="classstd_1_1string.html">std::string</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_enum_type.html#a4b186782fbda510eeb63ca0920025861">getBimap</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Singleton access.  <a href="#a4b186782fbda510eeb63ca0920025861"></a><br/></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4b186782fbda510eeb63ca0920025861"></a><!-- doxytag: member="mrpt::utils::TEnumType::getBimap" ref="a4b186782fbda510eeb63ca0920025861" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classmrpt_1_1utils_1_1bimap.html">bimap</a>&lt;ENUMTYPE,<a class="el" href="classstd_1_1string.html">std::string</a>&gt;&amp; mrpt::utils::TEnumType::getBimap </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Singleton access. </p>

<p>Definition at line <a class="el" href="_t_enum_type_8h_source.html#l00068">68</a> of file <a class="el" href="_t_enum_type_8h_source.html">TEnumType.h</a>.</p>

<p>Referenced by <a class="el" href="_t_enum_type_8h_source.html#l00054">name2value()</a>, and <a class="el" href="_t_enum_type_8h_source.html#l00061">value2name()</a>.</p>

</div>
</div>
<a class="anchor" id="a17c74be362636780836d70c0ed5857e4"></a><!-- doxytag: member="mrpt::utils::TEnumType::name2value" ref="a17c74be362636780836d70c0ed5857e4" args="(const std::string &amp;name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static ENUMTYPE mrpt::utils::TEnumType::name2value </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gives the numerical name for a given enum text name </p>
<dl><dt><b>Exceptions:</b></dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classstd_1_1exception.html" title="STL class.">std::exception</a></td><td>on unknown enum name. </td></tr>
  </table>
  </dd>
</dl>
</p>

<p>Definition at line <a class="el" href="_t_enum_type_8h_source.html#l00054">54</a> of file <a class="el" href="_t_enum_type_8h_source.html">TEnumType.h</a>.</p>

<p>References <a class="el" href="_t_enum_type_8h_source.html#l00068">getBimap()</a>, <a class="el" href="eigen__plugins_8h_source.html#l00503">empty()</a>, and <a class="el" href="eigen__plugins_8h_source.html#l00058">fill()</a>.</p>

</div>
</div>
<a class="anchor" id="a60b778bf271cdcd4180d31e3376df6a0"></a><!-- doxytag: member="mrpt::utils::TEnumType::value2name" ref="a60b778bf271cdcd4180d31e3376df6a0" args="(const ENUMTYPE val)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classstd_1_1string.html">std::string</a> mrpt::utils::TEnumType::value2name </td>
          <td>(</td>
          <td class="paramtype">const ENUMTYPE&#160;</td>
          <td class="paramname"><em>val</em></td><td>)</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gives the textual name for a given enum value </p>
<dl><dt><b>Exceptions:</b></dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classstd_1_1exception.html" title="STL class.">std::exception</a></td><td>on unknown enum value name. </td></tr>
  </table>
  </dd>
</dl>
</p>

<p>Definition at line <a class="el" href="_t_enum_type_8h_source.html#l00061">61</a> of file <a class="el" href="_t_enum_type_8h_source.html">TEnumType.h</a>.</p>

<p>References <a class="el" href="_t_enum_type_8h_source.html#l00068">getBimap()</a>, <a class="el" href="eigen__plugins_8h_source.html#l00503">empty()</a>, and <a class="el" href="eigen__plugins_8h_source.html#l00058">fill()</a>.</p>

</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150">  </td></tr> </table>  </body></html>