00001 /* +---------------------------------------------------------------------------+ 00002 | The Mobile Robot Programming Toolkit (MRPT) C++ library | 00003 | | 00004 | http://www.mrpt.org/ | 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 CTypeSelector_H 00029 #define CTypeSelector_H 00030 00031 #include <mrpt/utils/CSerializable.h> 00032 00033 namespace mrpt 00034 { 00035 namespace utils 00036 { 00037 // This must be added to any CSerializable derived class: 00038 DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE( CTypeSelector, mrpt::utils::CSerializable ) 00039 00040 /** This class represents a std::string derived class which is also CSerializable 00041 * \sa CSerializable 00042 * \ingroup mrpt_base_grp 00043 */ 00044 class BASE_IMPEXP CTypeSelector : public mrpt::utils::CSerializable 00045 { 00046 // This must be added to any CSerializable derived class: 00047 DEFINE_SERIALIZABLE( CTypeSelector ) 00048 protected: 00049 /** The possibilities 00050 */ 00051 std::vector<std::string> possibleTypes; 00052 00053 /** The selected one: 00054 */ 00055 unsigned int selection; 00056 00057 public: 00058 /** Default constructor. 00059 * \param posibilitiesList The list of options, as a comma-separated-string, for example: "type 1,other type 2,type_3" 00060 * \param defaultType Default type value 00061 */ 00062 CTypeSelector(std::string posibilitiesList = "", std::string defaultType = ""); 00063 00064 /** Destructor 00065 */ 00066 virtual ~CTypeSelector(); 00067 00068 /** Returns the set of posibilities in the "type" represented by this class. 00069 */ 00070 void getTypePosibilities( std::vector<std::string> &outPosibilities)const; 00071 00072 /** Gets the currently selected type, from the set of posibilities. 00073 * \sa setType,getTypePosibilities 00074 * \exception std::exception If currently there is not a valid selection. 00075 */ 00076 std::string getType() const; 00077 00078 /** Fast check for a given type, returns true if the selection is exactly the specified type name. 00079 */ 00080 bool isType(const char *type) const; 00081 00082 /** Fast check for a given type, returns true if the selection is exactly the specified type name. 00083 */ 00084 bool isType(const std::string &type) const; 00085 00086 /** Sets the currently selected type. 00087 * \sa getType,getTypePosibilities 00088 * \exception std::exception On trying to select a type not in the list of posible values. 00089 */ 00090 void setType(const std::string &type); 00091 00092 /** Returns the index of a given type within the list of all possible types, or -1 if the given string is not a valid type. 00093 */ 00094 int checkTypeIndex(const std::string &type) const; 00095 00096 }; // End of class def. 00097 00098 } // End of namespace 00099 } // End of namespace 00100 #endif
| Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011 |