Salome HOME
updated copyright message
[modules/shaper.git] / src / ModelHighAPI / ModelHighAPI_Folder.h
index 6713ff0a04ffc1d49bad6d6e09c0834c9b9ac052..7e8d71ae3f4e4e4b781f22409958994c61eb868c 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
@@ -23,7 +22,6 @@
 
 //--------------------------------------------------------------------------------------
 #include <ModelHighAPI_Interface.h>
-#include <ModelHighAPI_Macro.h>
 
 #include <ModelAPI_Folder.h>
 
@@ -48,14 +46,28 @@ public:
 
   static std::string ID() { return ModelAPI_Folder::ID(); }
   virtual std::string getID() { return ID(); }
+  const std::shared_ptr<ModelAPI_Folder>& folder() const {return myFolder;}
 
   /// First feature reference
   std::shared_ptr<ModelAPI_AttributeReference> firstFeature() const
-  { return myfirstFeature; }
+  { return myFirstFeature; }
 
   /// Last feature reference
   std::shared_ptr<ModelAPI_AttributeReference> lastFeature() const
-  { return mylastFeature; }
+  { return myLastFeature; }
+
+  /// Shortcut for data()->setName()
+  MODELHIGHAPI_EXPORT
+  void setName(const std::wstring& theName);
+
+  /// Shortcut for data()->name()
+  MODELHIGHAPI_EXPORT
+  std::wstring name() const;
+
+  /// To update the folder state
+  /// \param isForce start execution of feature instead of sending events
+  //MODELHIGHAPI_EXPORT void execute();
+
 
   /// Dump wrapped feature
   MODELHIGHAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
@@ -66,8 +78,8 @@ protected:
 private:
   std::shared_ptr<ModelAPI_Folder> myFolder;
 
-  std::shared_ptr<ModelAPI_AttributeReference> myfirstFeature;
-  std::shared_ptr<ModelAPI_AttributeReference> mylastFeature;
+  std::shared_ptr<ModelAPI_AttributeReference> myFirstFeature;
+  std::shared_ptr<ModelAPI_AttributeReference> myLastFeature;
 };
 
 //--------------------------------------------------------------------------------------
@@ -84,5 +96,10 @@ MODELHIGHAPI_EXPORT
 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
                                                const ModelHighAPI_Reference& theFirstFeature,
                                                const ModelHighAPI_Reference& theLastFeature);
+/**\ingroup CPPHighAPI
+* \brief Removes Folder feature
+*/
+MODELHIGHAPI_EXPORT
+void removeFolder(std::shared_ptr<ModelHighAPI_Folder>& theFolder);
 //--------------------------------------------------------------------------------------
 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */