Main MRPT website > C++ reference
MRPT logo

TEnumType.h

Go to the documentation of this file.
00001 /* +---------------------------------------------------------------------------+
00002    |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
00003    |                                                                           |
00004    |                   http://mrpt.sourceforge.net/                            |
00005    |                                                                           |
00006    |   Copyright (C) 2005-2011  University of Malaga                           |
00007    |                                                                           |
00008    |    This software was written by the Machine Perception and Intelligent    |
00009    |      Robotics Lab, University of Malaga (Spain).                          |
00010    |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
00011    |                                                                           |
00012    |  This file is part of the MRPT project.                                   |
00013    |                                                                           |
00014    |     MRPT is free software: you can redistribute it and/or modify          |
00015    |     it under the terms of the GNU General Public License as published by  |
00016    |     the Free Software Foundation, either version 3 of the License, or     |
00017    |     (at your option) any later version.                                   |
00018    |                                                                           |
00019    |   MRPT is distributed in the hope that it will be useful,                 |
00020    |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |
00021    |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |
00022    |     GNU General Public License for more details.                          |
00023    |                                                                           |
00024    |     You should have received a copy of the GNU General Public License     |
00025    |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
00026    |                                                                           |
00027    +---------------------------------------------------------------------------+ */
00028 #ifndef  mrpt_TEnumType_H
00029 #define  mrpt_TEnumType_H
00030 
00031 #include <mrpt/utils/utils_defs.h>
00032 #include <mrpt/utils/stl_extensions.h>
00033 
00034 namespace mrpt
00035 {
00036         namespace utils
00037         {
00038                 /** Only specializations of this class are defined for each enum type of interest
00039                   * \sa TEnumType
00040                   */
00041                 template <typename ENUMTYPE>
00042                 struct TEnumTypeFiller
00043                 {
00044                         typedef ENUMTYPE enum_t;
00045                         static void fill(bimap<enum_t,std::string>  &m_map);
00046                 };
00047 
00048 
00049                 /** A helper class that can convert an enum value into its textual representation, and viceversa.  */
00050                 template <typename ENUMTYPE>
00051                 struct TEnumType
00052                 {
00053                         /** Gives the numerical name for a given enum text name \exception std::exception on unknown enum name */
00054                         static ENUMTYPE    name2value(const std::string &name)
00055                         {
00056                                 if (getBimap().empty()) TEnumTypeFiller<ENUMTYPE>::fill(getBimap());
00057                                 return getBimap().inverse(name);
00058                         }
00059 
00060                         /** Gives the textual name for a given enum value \exception std::exception on unknown enum value name */
00061                         static std::string value2name(const ENUMTYPE val)
00062                         {
00063                                 if (getBimap().empty()) TEnumTypeFiller<ENUMTYPE>::fill(getBimap());
00064                                 return getBimap().direct(val);
00065                         }
00066 
00067                         /** Singleton access */
00068                         static inline bimap<ENUMTYPE,std::string> &getBimap()
00069                         {
00070                                 static bimap<ENUMTYPE,std::string> data;
00071                                 return data;
00072                         }
00073                 };
00074 
00075         } // End of namespace
00076 } // end of namespace
00077 #endif



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011