src/ModelHighAPI/ModelHighAPI_Folder.cpp

   1 // Copyright (C) 2014-2023  CEA, EDF
   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 #include "ModelHighAPI_Folder.h"
  21 #include <ModelHighAPI_Dumper.h>
  22 #include <ModelHighAPI_Reference.h>
  23 #include <ModelHighAPI_Tools.h>
  24
  25 #include <ModelAPI_AttributeReference.h>
  26 #include <ModelAPI_Document.h>
  27 #include <ModelAPI_Events.h>
  28
  29 //--------------------------------------------------------------------------------------
  30
  31 ModelHighAPI_Folder::ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder> & theFolder)
  32   : ModelHighAPI_Interface(FeaturePtr()),
  33     myFolder(theFolder)
  34 {
  35   initialize();
  36 }
  37
  38 ModelHighAPI_Folder::~ModelHighAPI_Folder()
  39 {
  40 }
  41
  42 bool ModelHighAPI_Folder::initialize()
  43 {
  44   if (!myFolder) {
  45     throwException(ID() + " exception: The folder is NULL.");
  46     return false;
  47   }
  48
  49   myFirstFeature = myFolder->reference(ModelAPI_Folder::FIRST_FEATURE_ID());
  50   if (!myFirstFeature)
  51     return false;
  52   myAttrGetter[ModelAPI_Folder::FIRST_FEATURE_ID()] = "firstFeature";
  53
  54   myLastFeature = myFolder->reference(ModelAPI_Folder::LAST_FEATURE_ID());
  55   if (!myLastFeature)
  56     return false;
  57   myAttrGetter[ModelAPI_Folder::LAST_FEATURE_ID()] = "lastFeature";
  58
  59   return true;
  60 }
  61
  62 void ModelHighAPI_Folder::setName(const std::wstring& theName)
  63 {
  64   if (myFolder && myFolder->data() && myFolder->data()->isValid())
  65     myFolder->data()->setName(theName);
  66 }
  67
  68 std::wstring ModelHighAPI_Folder::name() const
  69 {
  70   return myFolder->data()->name();
  71 }
  72
  73 void ModelHighAPI_Folder::dump(ModelHighAPI_Dumper& theDumper) const
  74 {
  75   const std::string& aDocName = theDumper.name(myFolder->document());
  76
  77   AttributeReferencePtr aStartRef = firstFeature();
  78   AttributeReferencePtr aEndRef   = lastFeature();
  79
  80   // do not dump empty folders
  81   if (!aEndRef->value())
  82     return;
  83
  84   // Dump folder when its features have been already dumped.
  85   // Otherwise, store the folder postponed.
  86   if (theDumper.isDumped(EntityPtr(aEndRef->value())))
  87     theDumper << myFolder << " = model.addFolder(" << aDocName << ", "
  88               << aStartRef << ", " << aEndRef << ")" << std::endl;
  89   else
  90     theDumper.postpone(myFolder);
  91 }
  92
  93 //--------------------------------------------------------------------------------------
  94
  95 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc)
  96 {
  97   std::shared_ptr<ModelAPI_Folder> aFolder = theDoc->addFolder();
  98   return std::shared_ptr<ModelHighAPI_Folder>(new ModelHighAPI_Folder(aFolder));
  99 }
 100
 101 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
 102                                                const ModelHighAPI_Reference& theFirstFeature,
 103                                                const ModelHighAPI_Reference& theLastFeature)
 104 {
 105   std::shared_ptr<ModelAPI_Folder> aFolder = theDoc->addFolder(theFirstFeature.feature());
 106
 107   AttributeReferencePtr aFirstFeatAttr = aFolder->reference(ModelAPI_Folder::FIRST_FEATURE_ID());
 108   fillAttribute(theFirstFeature.feature(), aFirstFeatAttr);
 109
 110   AttributeReferencePtr aLastFeatAttr = aFolder->reference(ModelAPI_Folder::LAST_FEATURE_ID());
 111   fillAttribute(theLastFeature.feature(), aLastFeatAttr);
 112
 113   // to update the folder state in the Object Browser
 114   theDoc->updateHistory(ModelAPI_Feature::group());
 115
 116   return std::shared_ptr<ModelHighAPI_Folder>(new ModelHighAPI_Folder(aFolder));
 117 }
 118
 119 void removeFolder(std::shared_ptr<ModelHighAPI_Folder>& theFolder)
 120 {
 121   theFolder->folder()->document()->removeFolder(theFolder->folder());
 122 }