<!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>The MRPT project: TEnumType.h Source File</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> > <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.2 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <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="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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span 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> </span><span class="right"></span> </div> </li> </ul> </div> <div class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <h1>TEnumType.h</h1> </div> </div> <div class="contents"> <a href="_t_enum_type_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span> <a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span> <a name="l00003"></a>00003 <span class="comment"> | |</span> <a name="l00004"></a>00004 <span class="comment"> | http://mrpt.sourceforge.net/ |</span> <a name="l00005"></a>00005 <span class="comment"> | |</span> <a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span> <a name="l00007"></a>00007 <span class="comment"> | |</span> <a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span> <a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span> <a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span> <a name="l00011"></a>00011 <span class="comment"> | |</span> <a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span> <a name="l00013"></a>00013 <span class="comment"> | |</span> <a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span> <a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span> <a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span> <a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span> <a name="l00018"></a>00018 <span class="comment"> | |</span> <a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span> <a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span> <a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span> <a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span> <a name="l00023"></a>00023 <span class="comment"> | |</span> <a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span> <a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span> <a name="l00026"></a>00026 <span class="comment"> | |</span> <a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span> <a name="l00028"></a>00028 <span class="preprocessor">#ifndef mrpt_TEnumType_H</span> <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define mrpt_TEnumType_H</span> <a name="l00030"></a>00030 <span class="preprocessor"></span> <a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="utils__defs_8h.html">mrpt/utils/utils_defs.h</a>></span> <a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="stl__extensions_8h.html">mrpt/utils/stl_extensions.h</a>></span> <a name="l00033"></a>00033 <a name="l00034"></a>00034 <span class="keyword">namespace </span>mrpt <a name="l00035"></a>00035 { <a name="l00036"></a>00036 <span class="keyword">namespace </span>utils <a name="l00037"></a>00037 {<span class="comment"></span> <a name="l00038"></a>00038 <span class="comment"> /** Only specializations of this class are defined for each enum type of interest</span> <a name="l00039"></a>00039 <span class="comment"> * \sa TEnumType</span> <a name="l00040"></a>00040 <span class="comment"> */</span> <a name="l00041"></a>00041 <span class="keyword">template</span> <<span class="keyword">typename</span> ENUMTYPE> <a name="l00042"></a><a class="code" href="structmrpt_1_1utils_1_1_t_enum_type_filler.html">00042</a> <span class="keyword">struct </span><a class="code" href="structmrpt_1_1utils_1_1_t_enum_type_filler.html" title="Only specializations of this class are defined for each enum type of interest.">TEnumTypeFiller</a> <a name="l00043"></a>00043 { <a name="l00044"></a><a class="code" href="structmrpt_1_1utils_1_1_t_enum_type_filler.html#ad1b13504822ee248f9bfbc1b6e1f85c0">00044</a> <span class="keyword">typedef</span> ENUMTYPE <a class="code" href="structmrpt_1_1utils_1_1_t_enum_type_filler.html#ad1b13504822ee248f9bfbc1b6e1f85c0">enum_t</a>; <a name="l00045"></a>00045 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structmrpt_1_1utils_1_1_t_enum_type_filler.html#a83f4e6e152872a50c3cacd68126534ab">fill</a>(<a class="code" href="classmrpt_1_1utils_1_1bimap.html" title="A bidirectional version of std::map, declared as bimap&lt;KEY,VALUE&gt; and which actually contains t...">bimap<enum_t,std::string></a> &m_map); <a name="l00046"></a>00046 }; <a name="l00047"></a>00047 <a name="l00048"></a>00048 <span class="comment"></span> <a name="l00049"></a>00049 <span class="comment"> /** A helper class that can convert an enum value into its textual representation, and viceversa. */</span> <a name="l00050"></a>00050 <span class="keyword">template</span> <<span class="keyword">typename</span> ENUMTYPE> <a name="l00051"></a><a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html">00051</a> <span class="keyword">struct </span><a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html" title="A helper class that can convert an enum value into its textual representation, and viceversa...">TEnumType</a> <a name="l00052"></a>00052 {<span class="comment"></span> <a name="l00053"></a>00053 <span class="comment"> /** Gives the numerical name for a given enum text name \exception std::exception on unknown enum name */</span> <a name="l00054"></a><a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#ad73ebcc586c02c974ef092599f51fe4b">00054</a> <span class="keyword">static</span> ENUMTYPE <a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#ad73ebcc586c02c974ef092599f51fe4b" title="Gives the numerical name for a given enum text name on unknown enum name.">name2value</a>(<span class="keyword">const</span> std::string &name) <a name="l00055"></a>00055 { <a name="l00056"></a>00056 <span class="keywordflow">if</span> (<a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#a400abf63766a37902e7711b8bfbed1c4" title="Singleton access.">getBimap</a>().<a class="code" href="eigen__plugins_8h.html#a05ed04d61c4f7d75d93908c25a09d8c4">empty</a>()) <a class="code" href="eigen__plugins_8h.html#a57fce471b07c3c84924883b5e17e2388">TEnumTypeFiller<ENUMTYPE>::fill</a>(<a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#a400abf63766a37902e7711b8bfbed1c4" title="Singleton access.">getBimap</a>()); <a name="l00057"></a>00057 <span class="keywordflow">return</span> <a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#a400abf63766a37902e7711b8bfbed1c4" title="Singleton access.">getBimap</a>().inverse(name); <a name="l00058"></a>00058 } <a name="l00059"></a>00059 <span class="comment"></span> <a name="l00060"></a>00060 <span class="comment"> /** Gives the textual name for a given enum value \exception std::exception on unknown enum value name */</span> <a name="l00061"></a><a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#af915f6a5684c992ea3f31a0eb119e19c">00061</a> <span class="keyword">static</span> std::string <a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#af915f6a5684c992ea3f31a0eb119e19c" title="Gives the textual name for a given enum value on unknown enum value name.">value2name</a>(<span class="keyword">const</span> ENUMTYPE val) <a name="l00062"></a>00062 { <a name="l00063"></a>00063 <span class="keywordflow">if</span> (<a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#a400abf63766a37902e7711b8bfbed1c4" title="Singleton access.">getBimap</a>().<a class="code" href="eigen__plugins_8h.html#a05ed04d61c4f7d75d93908c25a09d8c4">empty</a>()) <a class="code" href="eigen__plugins_8h.html#a57fce471b07c3c84924883b5e17e2388">TEnumTypeFiller<ENUMTYPE>::fill</a>(<a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#a400abf63766a37902e7711b8bfbed1c4" title="Singleton access.">getBimap</a>()); <a name="l00064"></a>00064 <span class="keywordflow">return</span> <a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#a400abf63766a37902e7711b8bfbed1c4" title="Singleton access.">getBimap</a>().direct(val); <a name="l00065"></a>00065 } <a name="l00066"></a>00066 <span class="comment"></span> <a name="l00067"></a>00067 <span class="comment"> /** Singleton access */</span> <a name="l00068"></a><a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#a400abf63766a37902e7711b8bfbed1c4">00068</a> <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="classmrpt_1_1utils_1_1bimap.html" title="A bidirectional version of std::map, declared as bimap&lt;KEY,VALUE&gt; and which actually contains t...">bimap<ENUMTYPE,std::string></a> &<a class="code" href="structmrpt_1_1utils_1_1_t_enum_type.html#a400abf63766a37902e7711b8bfbed1c4" title="Singleton access.">getBimap</a>() <a name="l00069"></a>00069 { <a name="l00070"></a>00070 <span class="keyword">static</span> <a class="code" href="classmrpt_1_1utils_1_1bimap.html" title="A bidirectional version of std::map, declared as bimap&lt;KEY,VALUE&gt; and which actually contains t...">bimap<ENUMTYPE,std::string></a> data; <a name="l00071"></a>00071 <span class="keywordflow">return</span> data; <a name="l00072"></a>00072 } <a name="l00073"></a>00073 }; <a name="l00074"></a>00074 <a name="l00075"></a>00075 } <span class="comment">// End of namespace</span> <a name="l00076"></a>00076 } <span class="comment">// end of namespace</span> <a name="l00077"></a>00077 <span class="preprocessor">#endif</span> </pre></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.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>