src/ModelHighAPI/ModelHighAPI_Folder.cpp

   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 #include "ModelHighAPI_Folder.h"
  22 #include <ModelHighAPI_Dumper.h>
  23 #include <ModelHighAPI_Reference.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   SET_ATTRIBUTE(firstFeature, ModelAPI_AttributeReference, ModelAPI_Folder::FIRST_FEATURE_ID());
  49   SET_ATTRIBUTE(lastFeature,  ModelAPI_AttributeReference, ModelAPI_Folder::LAST_FEATURE_ID());
  50
  51   return true;
  52 }
  53
  54 void ModelHighAPI_Folder::dump(ModelHighAPI_Dumper& theDumper) const
  55 {
  56   const std::string& aDocName = theDumper.name(myFolder->document());
  57
  58   AttributeReferencePtr aStartRef = myFolder->reference(ModelAPI_Folder::FIRST_FEATURE_ID());
  59   AttributeReferencePtr aEndRef   = myFolder->reference(ModelAPI_Folder::LAST_FEATURE_ID());
  60
  61   // Dump folder if it is empty or when its features have been already dumped.
  62   // Otherwise, just store the name of the folder.
  63   if (!aEndRef->value())
  64     theDumper << myFolder << " = model.addFolder(" << aDocName << ")" << std::endl;
  65   else if (theDumper.isDumped(aEndRef->value()))
  66     theDumper << myFolder << " = model.addFolder(" << aDocName << ", "
  67               << aStartRef << ", " << aEndRef << ")" << std::endl;
  68   else
  69     theDumper.name(myFolder);
  70 }
  71
  72 //--------------------------------------------------------------------------------------
  73
  74 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc)
  75 {
  76   std::shared_ptr<ModelAPI_Folder> aFolder = theDoc->addFolder();
  77   return std::shared_ptr<ModelHighAPI_Folder>(new ModelHighAPI_Folder(aFolder));
  78 }
  79
  80 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
  81                                                const ModelHighAPI_Reference& theFirstFeature,
  82                                                const ModelHighAPI_Reference& theLastFeature)
  83 {
  84   std::shared_ptr<ModelAPI_Folder> aFolder = theDoc->addFolder(theFirstFeature.feature());
  85
  86   AttributeReferencePtr aFirstFeatAttr = aFolder->reference(ModelAPI_Folder::FIRST_FEATURE_ID());
  87   theFirstFeature.fillAttribute(aFirstFeatAttr);
  88
  89   AttributeReferencePtr aLastFeatAttr = aFolder->reference(ModelAPI_Folder::LAST_FEATURE_ID());
  90   theLastFeature.fillAttribute(aLastFeatAttr);
  91
  92   return std::shared_ptr<ModelHighAPI_Folder>(new ModelHighAPI_Folder(aFolder));
  93 }