src/ModelHighAPI/ModelHighAPI_Folder.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
  22 #define SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
  23
  24 //--------------------------------------------------------------------------------------
  25 #include <ModelHighAPI_Interface.h>
  26
  27 #include <ModelAPI_Folder.h>
  28
  29 #include <memory>
  30 //--------------------------------------------------------------------------------------
  31 class ModelAPI_AttributeReference;
  32 class ModelAPI_Document;
  33 class ModelHighAPI_Reference;
  34 //--------------------------------------------------------------------------------------
  35 /**\class ModelHighAPI_Folder
  36  * \ingroup CPPHighAPI
  37  * \brief Class for filling ModelAPI_Folder
  38  */
  39 class ModelHighAPI_Folder : public ModelHighAPI_Interface
  40 {
  41 public:
  42   /// Constructor for a folder
  43   MODELHIGHAPI_EXPORT
  44   explicit ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder>& theFolder);
  45   /// Destructor
  46   MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Folder();
  47
  48   static std::string ID() { return ModelAPI_Folder::ID(); }
  49   virtual std::string getID() { return ID(); }
  50
  51   /// First feature reference
  52   std::shared_ptr<ModelAPI_AttributeReference> firstFeature() const
  53   { return myFirstFeature; }
  54
  55   /// Last feature reference
  56   std::shared_ptr<ModelAPI_AttributeReference> lastFeature() const
  57   { return myLastFeature; }
  58
  59   /// Shortcut for data()->setName()
  60   MODELHIGHAPI_EXPORT
  61   void setName(const std::string& theName);
  62
  63   /// Shortcut for data()->name()
  64   MODELHIGHAPI_EXPORT
  65   std::string name() const;
  66
  67   /// Dump wrapped feature
  68   MODELHIGHAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  69
  70 protected:
  71   bool initialize();
  72
  73 private:
  74   std::shared_ptr<ModelAPI_Folder> myFolder;
  75
  76   std::shared_ptr<ModelAPI_AttributeReference> myFirstFeature;
  77   std::shared_ptr<ModelAPI_AttributeReference> myLastFeature;
  78 };
  79
  80 //--------------------------------------------------------------------------------------
  81 /**\ingroup CPPHighAPI
  82  * \brief Create empty Folder feature
  83  */
  84 MODELHIGHAPI_EXPORT
  85 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc);
  86
  87 /**\ingroup CPPHighAPI
  88  * \brief Create Folder feature
  89  */
  90 MODELHIGHAPI_EXPORT
  91 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
  92                                                const ModelHighAPI_Reference& theFirstFeature,
  93                                                const ModelHighAPI_Reference& theLastFeature);
  94 //--------------------------------------------------------------------------------------
  95 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */