Salome HOME
New implementation of SALOMEDSImpl package based on DF data structure instead of...
[modules/kernel.git] / 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 #include <string>
28
29 #include "DF_Document.hxx"
30 #include "DF_Label.hxx"
31 #include "SALOMEDSImpl_AttributeTreeNode.hxx"
32 #include "SALOMEDSImpl_UseCaseIterator.hxx"
33
34 class SALOMEDSImpl_UseCaseBuilder
35 {
36 private:
37
38   SALOMEDSImpl_AttributeTreeNode*     _root;
39   DF_Document*                        _doc;
40
41 public:
42
43   //! standard constructor  
44   Standard_EXPORT SALOMEDSImpl_UseCaseBuilder(DF_Document* theDocument);
45   
46   //! standard destructor
47   Standard_EXPORT ~SALOMEDSImpl_UseCaseBuilder();
48   
49   Standard_EXPORT virtual bool Append(const SALOMEDSImpl_SObject& theObject);
50
51   Standard_EXPORT virtual bool Remove(const SALOMEDSImpl_SObject& theObject);
52
53   Standard_EXPORT virtual bool AppendTo(const SALOMEDSImpl_SObject& theFather, const SALOMEDSImpl_SObject& theObject);
54
55   Standard_EXPORT virtual bool InsertBefore(const SALOMEDSImpl_SObject& theFirst, const SALOMEDSImpl_SObject& theNext);
56
57   Standard_EXPORT virtual bool  SetCurrentObject(const SALOMEDSImpl_SObject& theObject);
58   
59   Standard_EXPORT virtual bool SetRootCurrent();
60
61   Standard_EXPORT virtual bool  HasChildren(const SALOMEDSImpl_SObject& theObject);
62
63   Standard_EXPORT virtual bool  IsUseCase(const SALOMEDSImpl_SObject& theObject);
64
65   Standard_EXPORT virtual bool SetName(const std::string& theName);
66
67   Standard_EXPORT virtual SALOMEDSImpl_SObject GetCurrentObject();
68
69   Standard_EXPORT virtual std::string GetName();
70
71   Standard_EXPORT virtual SALOMEDSImpl_SObject AddUseCase(const std::string& theName);
72
73   Standard_EXPORT virtual SALOMEDSImpl_UseCaseIterator GetUseCaseIterator(const SALOMEDSImpl_SObject& anObject);
74
75   Standard_EXPORT SALOMEDSImpl_SObject GetSObject(const std::string& theEntry);    
76
77 };
78 #endif