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_Study_i.hxx
25 // Author : Yves FRICAUD
29 #ifndef __SALOMEDS_STUDY_I_H__
30 #define __SALOMEDS_STUDY_I_H__
36 #include <SALOMEconfig.h>
37 #include CORBA_SERVER_HEADER(SALOMEDS)
40 #include <TDocStd_Document.hxx>
41 #include <TDF_Tool.hxx>
42 #include <TDF_Data.hxx>
43 #include <TDF_Label.hxx>
45 #include <TColStd_SequenceOfInteger.hxx>
46 #include <TColStd_SequenceOfAsciiString.hxx>
49 #include "SALOMEDS_SComponentIterator_i.hxx"
50 #include "SALOMEDS_ChildIterator_i.hxx"
51 #include "SALOMEDS_StudyBuilder_i.hxx"
52 #include "SALOMEDS_SObject_i.hxx"
53 #include "SALOMEDS_DataMapStringLabel.hxx"
54 #include "SALOMEDS_UseCaseBuilder_i.hxx"
56 #include "SALOMEDS_Callback_i.hxx"
58 class SALOMEDS_Study_i: public POA_SALOMEDS::Study,
59 public PortableServer::RefCountServantBase {
63 Handle(TDocStd_Document) _doc; // OCAF Document
64 CORBA::Boolean _isSaved; // True if the Study is saved
65 char* _URL; //URL of the persistent reference of the study
66 SALOMEDS::SObject_ptr _FindObject(SALOMEDS::SObject_ptr SO,
67 const char* anObjectName,
69 SALOMEDS::SObject_ptr _FindObjectIOR(SALOMEDS::SObject_ptr SO,
70 const char* anObjectIOR,
72 CORBA::Short _StudyId;
74 SALOMEDS_DataMapStringLabel myIORLabels;
76 // data structures for postponed destroying of CORBA object functionality
77 TColStd_SequenceOfAsciiString myPostponedIORs; // ordered set of IORs
78 TColStd_SequenceOfInteger myNbPostponed; // number of IOR in the each transaction
79 int myNbUndos; // number of current Undos, made by user
86 //! standard constructor
87 SALOMEDS_Study_i(const Handle(TDocStd_Document),
89 const char* study_name);
91 //! standard destructor
92 virtual ~SALOMEDS_Study_i();
94 //! method to Get persistent reference of study (idem URL())
97 \return char* arguments, the persistent reference of the study
99 virtual char* GetPersistentReference();
102 //! method to Get transient reference of study
104 \return char* arguments, the transient reference of the study
106 virtual char* GetTransientReference();
108 //! method to detect if a study is empty
110 \return bool arguments, true if study is empty
112 virtual CORBA::Boolean IsEmpty();
114 //! method to Find a Component with ComponentDataType = aComponentName
116 \param aComponentName char* arguments
117 \return SComponent_ptr arguments, the component found
119 virtual SALOMEDS::SComponent_ptr FindComponent (const char* aComponentName);
121 //! method to Find a Component Find a Component from it's ID
123 \param aComponentID char* arguments
124 \return SComponent_ptr arguments, the component found
126 virtual SALOMEDS::SComponent_ptr FindComponentID(const char* aComponentID);
128 //! method to Find an Object with SALOMEDS::Name = anObjectName
130 \param anObjectName char* arguments
131 \return SObject_ptr arguments, the object found
133 virtual SALOMEDS::SObject_ptr FindObject(const char* anObjectName);
136 //! method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName
138 \param anObjectName char* arguments
139 \param aComponentName char* arguments
140 \return ListOfSObject_ptr arguments, a list of objects found
143 virtual SALOMEDS::Study::ListOfSObject* FindObjectByName( const char* anObjectName, const char* aComponentName ) ;
145 //! method to Find an Object with ID = anObjectID
147 \param anObjectID char* arguments
148 \return SObject_ptr arguments, the object found
150 virtual SALOMEDS::SObject_ptr FindObjectID(const char* anObjectID);
152 //! method to Create an Object with ID = anObjectID
154 \param anObjectID char* arguments
155 \return SObject_ptr arguments, the object found
157 virtual SALOMEDS::SObject_ptr CreateObjectID(const char* anObjectID);
159 //! method to Find an Object with ID = anObjectIOR
161 \param anObjectIOR char* arguments
162 \return SObject_ptr arguments, the object found
164 virtual SALOMEDS::SObject_ptr FindObjectIOR(const char* anObjectIOR);
166 //! method to Find an Object by its path
168 \param thePath char* arguments
169 \return SObject_ptr arguments, the object found
171 virtual SALOMEDS::SObject_ptr FindObjectByPath(const char* thePath);
173 //! method to get a path of SObject
175 \param aSO SObject_ptr arguments
176 \return char* arguments, the path of the SObject
178 virtual char* GetObjectPath(CORBA::Object_ptr theObject);
180 //! method to set a context: root ('/') is UserData component
183 virtual void SetContext(const char* thePath);
185 //! method to get a context
188 virtual char* GetContext();
190 //! method to get all object names in the given context (or in the current context, if 'theContext' is empty)
193 virtual SALOMEDS::ListOfStrings* GetObjectNames(const char* theContext);
195 //! method to get all directory names in the given context (or in the current context, if 'theContext' is empty)
198 virtual SALOMEDS::ListOfStrings* GetDirectoryNames(const char* theContext);
200 //! method to get all file names in the given context (or in the current context, if 'theContext' is empty)
203 virtual SALOMEDS::ListOfStrings* GetFileNames(const char* theContext);
205 //! method to get all components names
208 virtual SALOMEDS::ListOfStrings* GetComponentNames(const char* theContext);
210 //! method to Create a ChildIterator from an SObject
212 \param aSO SObject_ptr arguments
213 \return ChildIterator_ptr arguments, the created ChildIterator
215 virtual SALOMEDS::ChildIterator_ptr NewChildIterator(SALOMEDS::SObject_ptr aSO);
217 //! method to Create a SComponentIterator
219 \return SComponentIterator_ptr arguments, the created SComponentIterator
221 virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator();
223 //! method to Create a StudyBuilder
225 \return StudyBuilder_ptr arguments, the created StudyBuilder
227 virtual SALOMEDS::StudyBuilder_ptr NewBuilder();
229 //! method to get study name
231 \return char* arguments, the study name
233 virtual char* Name();
235 //! method to set study name
237 \param name char* arguments, the study name
239 virtual void Name(const char* name);
241 //! method to get if study has been saved
243 \return bool arguments
245 virtual CORBA::Boolean IsSaved();
247 //! method to set if study has been saved
249 \param save bool arguments
251 virtual void IsSaved(CORBA::Boolean save);
253 //! method to Detect if a Study has been modified since it has been saved
255 \return bool arguments
257 virtual CORBA::Boolean IsModified();
259 //! method to get URL of the study (idem GetPersistentReference)
261 \return char* arguments, the study URL
265 //! method to set URL of the study
267 \param url char* arguments, the study URL
269 virtual void URL(const char* url);
271 virtual CORBA::Short StudyId();
272 virtual void StudyId(CORBA::Short id);
274 static SALOMEDS::Study_ptr GetStudy(const TDF_Label theLabel, CORBA::ORB_ptr orb);
276 static void IORUpdated(const Handle(SALOMEDS_IORAttribute) theAttribute, CORBA::ORB_ptr orb);
278 virtual void UpdateIORLabelMap(const char* anIOR, const char* aLabel);
280 virtual SALOMEDS::Study::ListOfSObject* FindDependances(SALOMEDS::SObject_ptr anObject);
282 virtual SALOMEDS::AttributeStudyProperties_ptr SALOMEDS_Study_i::GetProperties();
284 virtual char* GetLastModificationDate();
286 virtual SALOMEDS::ListOfDates* GetModificationsDate();
288 virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
289 virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
291 virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder();
293 virtual void Close();
295 void EnableUseCaseAutoFilling(CORBA::Boolean isEnabled) { _autoFill = isEnabled; }
297 // postponed destroying of CORBA object functionality
298 virtual void AddPostponed(const char* theIOR);
300 virtual void AddCreatedPostponed(const char* theIOR);
302 virtual void RemovePostponed(const CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
303 // if theUndoLimit==0, removes all
304 virtual void UndoPostponed(const CORBA::Long theWay); // theWay = 1: resurrect objects,
305 // theWay = -1: get back to the list of postponed