src/TreeData/DataModel.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
  23 #ifndef DATAMODEL_H
  24 #define DATAMODEL_H
  25
  26 #include "TreeData.hxx"
  27
  28 #include <map>
  29 #include "DataObject.hxx"
  30
  31 class TREEDATA_EXPORT DataModel {
  32
  33 public:
  34   DataModel();
  35   ~DataModel();
  36
  37   /*!
  38    * This function can be used to create a specific instance of
  39    * DataObject. Note that this function is a pure virtual method and
  40    * then no default behavior is done. In particular, the newly
  41    * created object is not automatically added to the data model. This
  42    * behavior should be implemented in a dedicated version of this
  43    * class.
  44    */
  45   virtual DataObject * newDataObject() = 0;
  46
  47   /*! Function to add data object to the model */
  48   bool addDataObject(DataObject * dataObject);
  49   /*! Functions to remove data object from the model */
  50   bool removeDataObject(std::string nameId);
  51   bool removeDataObject(DataObject * dataObject);
  52   /*! Function to retrieve a data object in the model */
  53   DataObject * getDataObject(std::string nameId);
  54
  55   std::map<std::string, DataObject *>::iterator begin();
  56   std::map<std::string, DataObject *>::iterator end();
  57
  58 private:
  59   std::map<std::string, DataObject *> _mapDataObjects;
  60
  61
  62 };
  63
  64 #endif // DATAMODEL_H