00001 /* +---------------------------------------------------------------------------+ 00002 | The Mobile Robot Programming Toolkit (MRPT) C++ library | 00003 | | 00004 | http://mrpt.sourceforge.net/ | 00005 | | 00006 | Copyright (C) 2005-2009 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( CTypeSelector ) 00039 00040 /** This class represents a std::string derived class which is also CSerializable 00041 * \sa CSerializable 00042 */ 00043 class MRPTDLLIMPEXP CTypeSelector : public mrpt::utils::CSerializable 00044 { 00045 // This must be added to any CSerializable derived class: 00046 DEFINE_SERIALIZABLE( CTypeSelector ) 00047 protected: 00048 /** The possibilities 00049 */ 00050 std::vector<std::string> possibleTypes; 00051 00052 /** The selected one: 00053 */ 00054 unsigned int selection; 00055 00056 public: 00057 /** Default constructor. 00058 * \param posibilitiesList The list of options, as a comma-separated-string, for example: "type 1,other type 2,type_3" 00059 * \param defaultType Default type value 00060 */ 00061 CTypeSelector(std::string posibilitiesList = "", std::string defaultType = ""); 00062 00063 /** Destructor 00064 */ 00065 virtual ~CTypeSelector(); 00066 00067 /** Returns the set of posibilities in the "type" represented by this class. 00068 */ 00069 void getTypePosibilities( std::vector<std::string> &outPosibilities)const; 00070 00071 /** Gets the currently selected type, from the set of posibilities. 00072 * \sa setType,getTypePosibilities 00073 * \exception std::exception If currently there is not a valid selection. 00074 */ 00075 std::string getType() const; 00076 00077 /** Fast check for a given type, returns true if the selection is exactly the specified type name. 00078 */ 00079 bool isType(const char *type) const; 00080 00081 /** Fast check for a given type, returns true if the selection is exactly the specified type name. 00082 */ 00083 bool isType(const std::string &type) const; 00084 00085 /** Sets the currently selected type. 00086 * \sa getType,getTypePosibilities 00087 * \exception std::exception On trying to select a type not in the list of posible values. 00088 */ 00089 void setType(const std::string &type); 00090 00091 /** 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. 00092 */ 00093 int checkTypeIndex(const std::string &type) const; 00094 00095 }; // End of class def. 00096 00097 } // End of namespace 00098 } // End of namespace 00099 #endif
Page generated by Doxygen 1.5.9 for MRPT 0.7.1 SVN: at Mon Aug 17 22:20:53 EDT 2009 |