src/ModelHighAPI/ModelHighAPI_Folder.cpp

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