1 // SALOME SALOMEDS : data structure of SALOME and sources of Salome data server
3 // Copyright (C) 2003 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
24 // File : SALOMEDS_StudyBuilder_i.hxx
25 // Author : Yves FRICAUD
29 #ifndef __SALOMEDS_STUDYBUIlDER_I_H__
30 #define __SALOMEDS_STUDYBUILDER_I_H__
33 #include <SALOMEconfig.h>
34 #include CORBA_SERVER_HEADER(SALOMEDS)
35 #include CORBA_SERVER_HEADER(SALOMEDS_Attributes)
38 #include <TDocStd_Document.hxx>
40 class SALOMEDS_Study_i;
41 class SALOMEDS_Callback_i;
43 class SALOMEDS_StudyBuilder_i: public virtual POA_SALOMEDS::StudyBuilder,
44 public virtual PortableServer::RefCountServantBase
46 SALOMEDS_StudyBuilder_i(); // Not implemented
47 void operator=(const SALOMEDS_StudyBuilder_i&); // Not implemented
49 SALOMEDS_Study_i* _study;
50 Handle(TDocStd_Document) _doc; // OCAF Document
52 void OnAddSObject(SALOMEDS::SObject_ptr theObject);
53 void OnRemoveSObject(SALOMEDS::SObject_ptr theObject);
56 SALOMEDS_StudyBuilder_i(SALOMEDS_Study_i* theStudy,
57 const Handle(TDocStd_Document)& theDocument);
59 ~SALOMEDS_StudyBuilder_i();
61 CORBA::ORB_var GetORB() const;
62 PortableServer::POA_var GetPOA() const;
66 \param ComponentDataType
69 virtual SALOMEDS::SComponent_ptr NewComponent(const char* ComponentDataType);
71 //! DefineComponentInstance
76 virtual void DefineComponentInstance (SALOMEDS::SComponent_ptr, CORBA::Object_ptr ComponentIOR);
84 virtual void RemoveComponent(SALOMEDS::SComponent_ptr aComponent);
90 \param theFatherObject
93 virtual SALOMEDS::SObject_ptr NewObject(SALOMEDS::SObject_ptr theFatherObject);
98 \param theFatherObject
100 \return <ReturnValue>
102 virtual SALOMEDS::SObject_ptr NewObjectToTag(SALOMEDS::SObject_ptr theFatherObject, CORBA::Long atag);
105 The methods adds a new subdirectory, the path can be absolute or relative (then the current context is used)
107 virtual void AddDirectory(const char* thePath);
109 virtual void LoadWith(SALOMEDS::SComponent_ptr sco, SALOMEDS::Driver_ptr Engine)
110 throw(SALOME::SALOME_Exception);
111 virtual void Load(SALOMEDS::SObject_ptr sco);
113 virtual void RemoveObject(SALOMEDS::SObject_ptr anObject);
114 virtual void RemoveObjectWithChildren(SALOMEDS::SObject_ptr anObject);
116 virtual SALOMEDS::GenericAttribute_ptr FindOrCreateAttribute(SALOMEDS::SObject_ptr anObject, const char* aTypeOfAttribute);
117 virtual CORBA::Boolean FindAttribute(SALOMEDS::SObject_ptr anObject, SALOMEDS::GenericAttribute_out anAttribute, const char* aTypeOfAttribute);
118 virtual void RemoveAttribute(SALOMEDS::SObject_ptr anObject, const char* aTypeOfAttribute);
120 virtual void Addreference(SALOMEDS::SObject_ptr me, SALOMEDS::SObject_ptr thereferencedObject);
122 virtual void RemoveReference(SALOMEDS::SObject_ptr me);
124 virtual void SetGUID(SALOMEDS::SObject_ptr anObject, const char* theGUID);
125 virtual bool IsGUID(SALOMEDS::SObject_ptr anObject, const char* theGUID);
127 virtual void NewCommand();
128 virtual void CommitCommand() throw(SALOMEDS::StudyBuilder::LockProtection);
129 virtual CORBA::Boolean HasOpenCommand();
130 virtual void AbortCommand();
131 virtual void Undo() throw(SALOMEDS::StudyBuilder::LockProtection);
132 virtual void Redo() throw(SALOMEDS::StudyBuilder::LockProtection);
133 CORBA::Boolean GetAvailableUndos();
134 CORBA::Boolean GetAvailableRedos();
135 CORBA::Boolean IsSaved();
136 CORBA::Boolean IsModified();
137 virtual CORBA::Long UndoLimit();
138 virtual void UndoLimit(CORBA::Long);
140 void CheckLocked() throw (SALOMEDS::StudyBuilder::LockProtection);
142 virtual SALOMEDS::Callback_ptr SetOnAddSObject(SALOMEDS::Callback_ptr theCallback);
143 virtual SALOMEDS::Callback_ptr SetOnRemoveSObject(SALOMEDS::Callback_ptr theCallback);
145 virtual void SetName(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);
146 virtual void SetComment(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);
147 virtual void SetIOR(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);