src/SALOMEDSImpl/SALOMEDSImpl_UseCaseBuilder.hxx

   1 // Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File   : SALOMEDSImpl_UseCaseBuilder.hxx
  24 //  Author : Sergey RUIN
  25 //  Module : SALOME
  26 //
  27 #ifndef __SALOMEDSIMPL_USECaseBuilder_H__
  28 #define __SALOMEDSIMPL_USECaseBuilder_H__
  29
  30 #include "SALOMEDSImpl_Defines.hxx"
  31
  32 #include <string>
  33
  34 #include "DF_Document.hxx"
  35 #include "DF_Label.hxx"
  36 #include "SALOMEDSImpl_AttributeTreeNode.hxx"
  37 #include "SALOMEDSImpl_UseCaseIterator.hxx"
  38
  39 class SALOMEDSIMPL_EXPORT SALOMEDSImpl_UseCaseBuilder
  40 {
  41 private:
  42
  43   SALOMEDSImpl_AttributeTreeNode*     _root;
  44   DF_Document*                        _doc;
  45
  46   //[bos #19765] optimize inserting huge nb objects in the study
  47   SALOMEDSImpl_AttributeTreeNode*     _lastChild;
  48   int                                 _childIndex; // in C mode
  49
  50 public:
  51
  52   //! standard constructor
  53   SALOMEDSImpl_UseCaseBuilder(DF_Document* theDocument);
  54
  55   //! standard destructor
  56   virtual ~SALOMEDSImpl_UseCaseBuilder();
  57
  58   virtual bool Append(const SALOMEDSImpl_SObject& theObject);
  59
  60   virtual bool Remove(const SALOMEDSImpl_SObject& theObject);
  61
  62   virtual bool AppendTo(const SALOMEDSImpl_SObject& theFather, const SALOMEDSImpl_SObject& theObject);
  63
  64   virtual bool InsertBefore(const SALOMEDSImpl_SObject& theFirst, const SALOMEDSImpl_SObject& theNext);
  65
  66   int GetIndexInFather(const SALOMEDSImpl_SObject& theFather, const SALOMEDSImpl_SObject& theObject);
  67
  68   virtual bool  SetCurrentObject(const SALOMEDSImpl_SObject& theObject);
  69
  70   virtual bool SetRootCurrent();
  71
  72   virtual bool  HasChildren(const SALOMEDSImpl_SObject& theObject);
  73
  74   virtual bool SortChildren(const SALOMEDSImpl_SObject& theObject, bool theAscendingOrder);
  75
  76   virtual SALOMEDSImpl_SObject GetFather(const SALOMEDSImpl_SObject& theObject);
  77
  78   virtual bool  IsUseCase(const SALOMEDSImpl_SObject& theObject);
  79
  80   virtual bool  IsUseCaseNode(const SALOMEDSImpl_SObject& theObject);
  81
  82   virtual bool SetName(const std::string& theName);
  83
  84   virtual SALOMEDSImpl_SObject GetCurrentObject();
  85
  86   virtual std::string GetName();
  87
  88   virtual SALOMEDSImpl_SObject AddUseCase(const std::string& theName);
  89
  90   virtual SALOMEDSImpl_UseCaseIterator GetUseCaseIterator(const SALOMEDSImpl_SObject& anObject);
  91
  92   SALOMEDSImpl_SObject GetSObject(const std::string& theEntry);
  93
  94 };
  95 #endif