Main MRPT website > C++ reference
MRPT logo

CPropertiesValuesList.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  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                  */
00047                 class BASE_IMPEXP CPropertiesValuesList : public mrpt::utils::CSerializable
00048                 {
00049                         // This must be added to any CSerializable derived class:
00050                         DEFINE_SERIALIZABLE( CPropertiesValuesList )
00051                 protected:
00052                         struct BASE_IMPEXP  TPropertyValuePair
00053                         {
00054                                 std::string                     name;
00055                                 CSerializablePtr        value;
00056                         };
00057                         /** The properties list: a map between strings and objects
00058                           */
00059                         std::vector<TPropertyValuePair> m_properties;
00060 
00061                 public:
00062                         /** Default constructor
00063                           */
00064                         CPropertiesValuesList();
00065 
00066                         /** Copy constructor
00067                           */
00068                         CPropertiesValuesList(const CPropertiesValuesList &o);
00069 
00070                         /** Copy operator
00071                           */
00072                         CPropertiesValuesList& operator = (const CPropertiesValuesList &o);
00073 
00074                         /** Destructor
00075                           */
00076                         virtual ~CPropertiesValuesList();
00077 
00078                         /** Clears the list.
00079                           */
00080                         void  clear();
00081 
00082                         /** Returns the value of the property (case insensitive), or NULL if it does not exist.
00083                           */
00084                         CSerializablePtr get(const std::string &propertyName) const;
00085 
00086                         /** 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)
00087                           */
00088                         void  set(const std::string &propertyName,const CSerializablePtr &obj);
00089 
00090                         /** Returns the number of properties in the list
00091                           */
00092                         size_t  size() const;
00093 
00094                         /** Returns the name of all properties in the list
00095                           */
00096                         std::vector<std::string>  getPropertyNames() const;
00097 
00098                 }; // End of class def.
00099 
00100 
00101         } // End of namespace
00102 } // End of namespace
00103 
00104 #endif



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