<!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>CListOfClasses.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.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 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>
<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="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">
<div class="title">CListOfClasses.h</div> </div>
</div>
<div class="contents">
<a href="_c_list_of_classes_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://www.mrpt.org/ |</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 CListOfClasses_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CListOfClasses_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="_c_serializable_8h.html">mrpt/utils/CSerializable.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="string__utils_8h.html">mrpt/system/string_utils.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"> /** A list (actually based on a std::set) of MRPT classes, capable of keeping any class registered by the mechanism of CSerializable classes.</span>
<a name="l00039"></a>00039 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a>00041 <span class="keyword">class </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> CListOfClasses
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="keyword">private</span>:
<a name="l00044"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a41aade07374c48e232bebb13e372936b">00044</a> <span class="keyword">typedef</span> std<a class="code" href="classstd_1_1set.html">::set<const mrpt::utils::TRuntimeClassId*></a> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a41aade07374c48e232bebb13e372936b">TSet</a>;
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6923d3520944ec3bd1415e9f4d789b28">00046</a> <a class="code" href="classstd_1_1set.html">TSet</a> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6923d3520944ec3bd1415e9f4d789b28">m_data</a>;
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00049"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6f04e2b9ca51feb66afee399fcb3019e">00049</a> <span class="keyword">typedef</span> <a class="code" href="classstd_1_1set.html">TSet</a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6f04e2b9ca51feb66afee399fcb3019e">::iterator</a> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6f04e2b9ca51feb66afee399fcb3019e">iterator</a>;
<a name="l00050"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#ab4ac757dc1e4139f8998d73ddc370030">00050</a> <span class="keyword">typedef</span> <a class="code" href="classstd_1_1set.html">TSet</a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#ab4ac757dc1e4139f8998d73ddc370030">::const_iterator</a> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#ab4ac757dc1e4139f8998d73ddc370030">const_iterator</a>;
<a name="l00051"></a>00051
<a name="l00052"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6093118b49125b434c6e3ed627ed20e3">00052</a> <span class="keyword">inline</span> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6f04e2b9ca51feb66afee399fcb3019e">iterator</a> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6093118b49125b434c6e3ed627ed20e3">begin</a>() {<span class="keywordflow">return</span> m_data.begin(); }
<a name="l00053"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a9a434eab355b7914f9785bd949238f0a">00053</a> <span class="keyword">inline</span> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#ab4ac757dc1e4139f8998d73ddc370030">const_iterator</a> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a9a434eab355b7914f9785bd949238f0a">begin</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_data.begin(); }
<a name="l00054"></a>00054
<a name="l00055"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#aff53a1c2607f8fb1b10060332c0fe1f2">00055</a> <span class="keyword">inline</span> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a6f04e2b9ca51feb66afee399fcb3019e">iterator</a> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#aff53a1c2607f8fb1b10060332c0fe1f2">end</a>() {<span class="keywordflow">return</span> m_data.end(); }
<a name="l00056"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#aef5c044087aa6bc0a28879dc5d33811a">00056</a> <span class="keyword">inline</span> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#ab4ac757dc1e4139f8998d73ddc370030">const_iterator</a> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#aef5c044087aa6bc0a28879dc5d33811a">end</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_data.end(); }
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /** Insert a class in the list. Example of usage:</span>
<a name="l00059"></a>00059 <span class="comment"> * \code</span>
<a name="l00060"></a>00060 <span class="comment"> * myList.insert(CLASS_ID(CObservationImage));</span>
<a name="l00061"></a>00061 <span class="comment"> * \endcode</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#ab98aa6cf77cb11bd753c56caa9a4d8f6">00063</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#ab98aa6cf77cb11bd753c56caa9a4d8f6" title="Insert a class in the list.">insert</a>( <span class="keyword">const</span> <a class="code" href="structmrpt_1_1utils_1_1_t_runtime_class_id.html" title="A structure that holds runtime class type information.">mrpt::utils::TRuntimeClassId</a>* <span class="keywordtype">id</span> ) { m_data.insert(<span class="keywordtype">id</span>); }
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /** Does the list contains this class? */</span>
<a name="l00066"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a2631067c3e0c5bda64d557620aeebd78">00066</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a2631067c3e0c5bda64d557620aeebd78" title="Does the list contains this class?">contains</a>( <span class="keyword">const</span> <a class="code" href="structmrpt_1_1utils_1_1_t_runtime_class_id.html" title="A structure that holds runtime class type information.">mrpt::utils::TRuntimeClassId</a>* <span class="keywordtype">id</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_data.find(<span class="keywordtype">id</span>)!=m_data.end(); }
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> /** Does the list contains a class derived from...? */</span>
<a name="l00069"></a>00069 <span class="keywordtype">bool</span> containsDerivedFrom( <span class="keyword">const</span> <a class="code" href="structmrpt_1_1utils_1_1_t_runtime_class_id.html" title="A structure that holds runtime class type information.">mrpt::utils::TRuntimeClassId</a>* <span class="keywordtype">id</span> ) <span class="keyword">const</span>;
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /** Empty the list */</span>
<a name="l00072"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a298cbe46dff2c359ef12a9e5510c23b5">00072</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a298cbe46dff2c359ef12a9e5510c23b5" title="Empty the list.">clear</a>() { m_data.clear(); }
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment"> /** Is the list empty? */</span>
<a name="l00075"></a><a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a0f75e83f537d13d82681cb24813f768b">00075</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1utils_1_1_c_list_of_classes.html#a0f75e83f537d13d82681cb24813f768b" title="Is the list empty?">empty</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_data.empty(); }
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** Return a string representation of the list, for example: "CPose2D, CObservation, CPose3D".</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a>00079 std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> toString() <span class="keyword">const</span>;
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /** Return a string representation of the list, for example: "CPose2D, CObservation, CPose3D".</span>
<a name="l00082"></a>00082 <span class="comment"> * \exception std::exception On unregistered class name found.</span>
<a name="l00083"></a>00083 <span class="comment"> */</span>
<a name="l00084"></a>00084 <span class="keywordtype">void</span> fromString(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &s);
<a name="l00085"></a>00085
<a name="l00086"></a>00086 }; <span class="comment">// end of class</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 } <span class="comment">// End of namespace</span>
<a name="l00089"></a>00089 } <span class="comment">// end of namespace</span>
<a name="l00090"></a>00090 <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.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>
