src/SALOMEDSImpl/SALOMEDSImpl_UseCaseBuilder.hxx

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