1 // Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SALOMEDSImpl_StudyBuilder.hxx
24 // Author : Sergey RUIN
27 #ifndef __SALOMEDSImpl_STUDYBUILDER_H__
28 #define __SALOMEDSImpl_STUDYBUILDER_H__
30 #include "SALOMEDSImpl_Defines.hxx"
36 #include "SALOMEDSImpl_Callback.hxx"
37 #include "SALOMEDSImpl_Driver.hxx"
39 class SALOMEDSImpl_Study;
41 class SALOMEDSIMPL_EXPORT SALOMEDSImpl_StudyBuilder
45 SALOMEDSImpl_Study* _study;
46 SALOMEDSImpl_Callback* _callbackOnAdd;
47 SALOMEDSImpl_Callback* _callbackOnRemove;
48 std::string _errorCode;
52 SALOMEDSImpl_StudyBuilder(const SALOMEDSImpl_Study* theOwner);
54 ~SALOMEDSImpl_StudyBuilder();
56 virtual SALOMEDSImpl_SComponent NewComponent(const std::string& ComponentDataType);
58 virtual bool DefineComponentInstance (const SALOMEDSImpl_SComponent&, const std::string& ComponentIOR);
60 virtual bool RemoveComponent(const SALOMEDSImpl_SComponent& aComponent);
62 virtual SALOMEDSImpl_SObject NewObject(const SALOMEDSImpl_SObject& theFatherObject);
64 virtual SALOMEDSImpl_SObject NewObjectToTag(const SALOMEDSImpl_SObject& theFatherObject,
67 //! The methods adds a new subdirectory, the path can be absolute or relative (then the current context is used)
68 virtual bool AddDirectory(const std::string& thePath);
70 virtual bool LoadWith(const SALOMEDSImpl_SComponent& sco, SALOMEDSImpl_Driver* Engine);
71 virtual bool Load(const SALOMEDSImpl_SObject& sco);
73 virtual bool RemoveObject(const SALOMEDSImpl_SObject& anObject);
74 virtual bool RemoveObjectWithChildren(const SALOMEDSImpl_SObject& anObject);
76 virtual DF_Attribute* FindOrCreateAttribute(const SALOMEDSImpl_SObject& anObject,
77 const std::string& aTypeOfAttribute);
78 virtual bool FindAttribute(const SALOMEDSImpl_SObject& anObject,
79 DF_Attribute*& anAttribute,
80 const std::string& aTypeOfAttribute);
82 virtual bool RemoveAttribute(const SALOMEDSImpl_SObject& anObject, const std::string& aTypeOfAttribute);
84 virtual bool Addreference(const SALOMEDSImpl_SObject& me,
85 const SALOMEDSImpl_SObject& thereferencedObject);
87 virtual bool RemoveReference(const SALOMEDSImpl_SObject& me);
89 virtual bool SetGUID(const SALOMEDSImpl_SObject& anObject, const std::string& theGUID);
90 virtual bool IsGUID(const SALOMEDSImpl_SObject& anObject, const std::string& theGUID);
92 virtual void NewCommand();
93 virtual void CommitCommand();
94 virtual bool HasOpenCommand();
95 virtual void AbortCommand();
98 bool GetAvailableUndos();
99 bool GetAvailableRedos();
102 virtual int UndoLimit();
103 virtual void UndoLimit(const int);
107 virtual SALOMEDSImpl_Callback* SetOnAddSObject(const SALOMEDSImpl_Callback* theCallback);
108 virtual SALOMEDSImpl_Callback* SetOnRemoveSObject(const SALOMEDSImpl_Callback* theCallback);
110 virtual bool SetName(const SALOMEDSImpl_SObject& theSO, const std::string& theValue);
112 virtual bool SetComment(const SALOMEDSImpl_SObject& theSO, const std::string& theValue);
114 virtual bool SetIOR(const SALOMEDSImpl_SObject& theSO, const std::string& theValue);
116 virtual std::string GetErrorCode() { return _errorCode; }
117 virtual bool IsError() { return _errorCode != ""; }
119 virtual SALOMEDSImpl_Study* GetOwner() { return _study; }