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 #include <ModelHighAPI_Macro.h>
  27
  28 #include <ModelAPI_Folder.h>
  29
  30 #include <memory>
  31 //--------------------------------------------------------------------------------------
  32 class ModelAPI_AttributeReference;
  33 class ModelAPI_Document;
  34 class ModelHighAPI_Reference;
  35 //--------------------------------------------------------------------------------------
  36 /**\class ModelHighAPI_Folder
  37  * \ingroup CPPHighAPI
  38  * \brief Class for filling ModelAPI_Folder
  39  */
  40 class ModelHighAPI_Folder : public ModelHighAPI_Interface
  41 {
  42 public:
  43   /// Constructor for a folder
  44   MODELHIGHAPI_EXPORT
  45   explicit ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder>& theFolder);
  46   /// Destructor
  47   MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Folder();
  48
  49   static std::string ID() { return ModelAPI_Folder::ID(); }
  50   virtual std::string getID() { return ID(); }
  51
  52   /// First feature reference
  53   std::shared_ptr<ModelAPI_AttributeReference> firstFeature() const
  54   { return myfirstFeature; }
  55
  56   /// Last feature reference
  57   std::shared_ptr<ModelAPI_AttributeReference> lastFeature() const
  58   { return mylastFeature; }
  59
  60   /// Dump wrapped feature
  61   MODELHIGHAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  62
  63 protected:
  64   bool initialize();
  65
  66 private:
  67   std::shared_ptr<ModelAPI_Folder> myFolder;
  68
  69   std::shared_ptr<ModelAPI_AttributeReference> myfirstFeature;
  70   std::shared_ptr<ModelAPI_AttributeReference> mylastFeature;
  71 };
  72
  73 //--------------------------------------------------------------------------------------
  74 /**\ingroup CPPHighAPI
  75  * \brief Create empty Folder feature
  76  */
  77 MODELHIGHAPI_EXPORT
  78 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc);
  79
  80 /**\ingroup CPPHighAPI
  81  * \brief Create Folder feature
  82  */
  83 MODELHIGHAPI_EXPORT
  84 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
  85                                                const ModelHighAPI_Reference& theFirstFeature,
  86                                                const ModelHighAPI_Reference& theLastFeature);
  87 //--------------------------------------------------------------------------------------
  88 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */