src/TreeData/DataObject.hxx

   1 // Copyright (C) 2007-2023  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // Author: Guillaume Boulant (EDF/R&D)
  21
  22 #ifndef DATAOBJECT_H
  23 #define DATAOBJECT_H
  24
  25 #include "TreeData.hxx"
  26
  27 #include <map>
  28 #include <string>
  29
  30 class TREEDATA_EXPORT DataObject {
  31
  32 public:
  33   DataObject();
  34   ~DataObject();
  35
  36   void setLabel(std::string label);
  37   std::string getLabel();
  38   void setProperty(std::string key, std::string value);
  39   std::string getProperty(std::string key);
  40
  41   /*!
  42    * This function specifies the localization of the object in the
  43    * hierarchical organization that can be defined by the DataModel it
  44    * belongs to.
  45    */
  46   virtual std::string getPath() = 0;
  47   std::string getPathName();
  48   std::string getNameId();
  49
  50   static const std::string pathsep;
  51
  52   /*! This function can be used for debug */
  53   std::string toString();
  54
  55 private:
  56   /*! The name this object can be displayed with */
  57   std::string _label;
  58   /*! The identifier of this object. An identifier is invariant all the session long */
  59   std::string _nameId;
  60   /*! The dictionnary of properties that characterize this object */
  61   std::map<std::string, std::string> _properties;
  62
  63   static int _lastId;
  64   static const std::string _BASENAME;
  65 };
  66
  67 #endif // DATAOBJECT_H