src/TreeData/DataObject.hxx

   1 // Copyright (C) 2007-2014  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 using namespace std;
  30
  31 class TREEDATA_EXPORT DataObject {
  32
  33 public:
  34   DataObject();
  35   ~DataObject();
  36
  37   void setLabel(string label);
  38   string getLabel();
  39   void setProperty(string key, string value);
  40   string getProperty(string key);
  41
  42   /*!
  43    * This function specifies the localization of the object in the
  44    * hierarchical organization that can be defined by the DataModel it
  45    * belongs to.
  46    */
  47   virtual string getPath() = 0;
  48   string getPathName();
  49   string getNameId();
  50
  51   static const string pathsep;
  52
  53   /*! This function can be used for debug */
  54   string toString();
  55
  56 private:
  57   /*! The name this object can be displayed with */
  58   string _label;
  59   /*! The identifier of this object. An identifier is invariant all the session long */
  60   string _nameId;
  61   /*! The dictionnary of properties that characterize this object */
  62   map<string, string> _properties;
  63
  64   static int _lastId;
  65   static const string _BASENAME;
  66 };
  67
  68 #endif // DATAOBJECT_H