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 CPropertiesValuesList_H 00029 #define CPropertiesValuesList_H 00030 00031 #include <mrpt/utils/CSerializable.h> 00032 00033 /*--------------------------------------------------------------- 00034 Class 00035 ---------------------------------------------------------------*/ 00036 namespace mrpt 00037 { 00038 namespace utils 00039 { 00040 // This must be added to any CSerializable derived class: 00041 DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE( CPropertiesValuesList, mrpt::utils::CSerializable ) 00042 00043 /** An arbitrary list of "annotations", or named attributes, each being an instance of any CSerializable object. 00044 * A multi-hypotheses version exists in CMHPropertiesValuesList. 00045 * \sa CSerializable, CMHPropertiesValuesList, mrpt::utils::TParameters 00046 * \ingroup mrpt_base_grp 00047 */ 00048 class BASE_IMPEXP CPropertiesValuesList : public mrpt::utils::CSerializable 00049 { 00050 // This must be added to any CSerializable derived class: 00051 DEFINE_SERIALIZABLE( CPropertiesValuesList ) 00052 protected: 00053 struct BASE_IMPEXP TPropertyValuePair 00054 { 00055 std::string name; 00056 CSerializablePtr value; 00057 }; 00058 /** The properties list: a map between strings and objects 00059 */ 00060 std::vector<TPropertyValuePair> m_properties; 00061 00062 public: 00063 /** Default constructor 00064 */ 00065 CPropertiesValuesList(); 00066 00067 /** Copy constructor 00068 */ 00069 CPropertiesValuesList(const CPropertiesValuesList &o); 00070 00071 /** Copy operator 00072 */ 00073 CPropertiesValuesList& operator = (const CPropertiesValuesList &o); 00074 00075 /** Destructor 00076 */ 00077 virtual ~CPropertiesValuesList(); 00078 00079 /** Clears the list. 00080 */ 00081 void clear(); 00082 00083 /** Returns the value of the property (case insensitive), or NULL if it does not exist. 00084 */ 00085 CSerializablePtr get(const std::string &propertyName) const; 00086 00087 /** Sets/change the value of the property (case insensitive), making a copy of the object (or setting it to NULL if it is the passed value) 00088 */ 00089 void set(const std::string &propertyName,const CSerializablePtr &obj); 00090 00091 /** Returns the number of properties in the list 00092 */ 00093 size_t size() const; 00094 00095 /** Returns the name of all properties in the list 00096 */ 00097 std::vector<std::string> getPropertyNames() const; 00098 00099 }; // End of class def. 00100 00101 00102 } // End of namespace 00103 } // End of namespace 00104 00105 #endif
| Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011 |