1 // Copyright (C) 2007-2016 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, or (at your option) any later version.
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 : SALOMEDS_Study_i.hxx
24 // Author : Sergey RUIN
27 #ifndef __SALOMEDS_STUDY_I_H__
28 #define __SALOMEDS_STUDY_I_H__
34 #include <SALOMEconfig.h>
35 #include CORBA_SERVER_HEADER(SALOME_GenericObj)
36 #include CORBA_SERVER_HEADER(SALOMEDS)
41 #include "SALOMEDS_SComponentIterator_i.hxx"
42 #include "SALOMEDS_StudyBuilder_i.hxx"
43 #include "SALOMEDS_SObject_i.hxx"
44 #include "SALOMEDS_UseCaseBuilder_i.hxx"
45 #include "SALOMEDS_Driver_i.hxx"
47 #include "SALOMEDSImpl_Study.hxx"
48 #include "SALOMEDSImpl_AttributeIOR.hxx"
50 class Standard_EXPORT SALOMEDS_Study_i: public POA_SALOMEDS::Study
54 SALOMEDSImpl_Study* _impl;
55 SALOMEDS_StudyBuilder_i* _builder;
56 SALOMEDSImpl_AbstractCallback* _notifier;
57 SALOMEDS_DriverFactory_i* _factory;
62 //! standard constructor
63 SALOMEDS_Study_i(CORBA::ORB_ptr);
65 //! standard destructor
66 virtual ~SALOMEDS_Study_i();
71 //! method to Open a Study
73 \param char* arguments, the study URL
74 \return Study_ptr arguments
76 virtual bool Open(const char* aStudyUrl) throw (SALOME::SALOME_Exception);
78 //! method to save a Study
79 virtual CORBA::Boolean Save(CORBA::Boolean theMultiFile);
80 virtual CORBA::Boolean SaveASCII(CORBA::Boolean theMultiFile);
82 //! method to save a Study to the persistent reference aUrl
84 \param char* arguments, the new URL of the study
86 virtual CORBA::Boolean SaveAs(const char* aUrl, CORBA::Boolean theMultiFile);
87 virtual CORBA::Boolean SaveAsASCII(const char* aUrl, CORBA::Boolean theMultiFile);
89 //! method to copy the object
91 \param theObject object to copy
93 virtual CORBA::Boolean Copy(SALOMEDS::SObject_ptr theObject);
94 virtual CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
95 //! method to paste the object in study
97 \param theObject object to paste
99 virtual SALOMEDS::SObject_ptr Paste(SALOMEDS::SObject_ptr theObject) throw(SALOMEDS::StudyBuilder::LockProtection);
100 virtual CORBA::Boolean CanPaste(SALOMEDS::SObject_ptr theObject);
102 //! method to Get persistent reference of study (idem URL())
105 \return char* arguments, the persistent reference of the study
107 virtual char* GetPersistentReference();
110 //! method to Get transient reference of study
112 \return char* arguments, the transient reference of the study
114 virtual char* GetTransientReference();
116 //! method to detect if a study is empty
118 \return bool arguments, true if study is empty
120 virtual CORBA::Boolean IsEmpty();
122 //! method to Find a Component with ComponentDataType = aComponentName
124 \param aComponentName char* arguments
125 \return SComponent_ptr arguments, the component found
127 virtual SALOMEDS::SComponent_ptr FindComponent (const char* aComponentName);
129 //! method to Find a Component Find a Component from it's ID
131 \param aComponentID char* arguments
132 \return SComponent_ptr arguments, the component found
134 virtual SALOMEDS::SComponent_ptr FindComponentID(const char* aComponentID);
136 //! method to Find an Object with SALOMEDS::Name = anObjectName
138 \param anObjectName char* arguments
139 \return SObject_ptr arguments, the object found
141 virtual SALOMEDS::SObject_ptr FindObject(const char* anObjectName);
144 //! method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName
146 \param anObjectName char* arguments
147 \param aComponentName char* arguments
148 \return ListOfSObject_ptr arguments, a list of objects found
151 virtual SALOMEDS::Study::ListOfSObject* FindObjectByName( const char* anObjectName, const char* aComponentName ) ;
153 //! method to Find an Object with ID = anObjectID
155 \param anObjectID char* arguments
156 \return SObject_ptr arguments, the object found
158 virtual SALOMEDS::SObject_ptr FindObjectID(const char* anObjectID);
160 //! method to Create an Object with ID = anObjectID
162 \param anObjectID char* arguments
163 \return SObject_ptr arguments, the object found
165 virtual SALOMEDS::SObject_ptr CreateObjectID(const char* anObjectID);
167 //! method to Find an Object with ID = anObjectIOR
169 \param anObjectIOR char* arguments
170 \return SObject_ptr arguments, the object found
172 virtual SALOMEDS::SObject_ptr FindObjectIOR(const char* anObjectIOR);
174 //! method to Find an Object by its path
176 \param thePath char* arguments
177 \return SObject_ptr arguments, the object found
179 virtual SALOMEDS::SObject_ptr FindObjectByPath(const char* thePath);
181 //! method to get a path of SObject
183 \param aSO SObject_ptr arguments
184 \return char* arguments, the path of the SObject
186 virtual char* GetObjectPath(CORBA::Object_ptr theObject);
188 //! method to set a context: root ('/') is UserData component
191 virtual void SetContext(const char* thePath);
193 //! method to get a context
196 virtual char* GetContext();
198 //! method to get all object names in the given context (or in the current context, if 'theContext' is empty)
201 virtual SALOMEDS::ListOfStrings* GetObjectNames(const char* theContext);
203 //! method to get all directory names in the given context (or in the current context, if 'theContext' is empty)
206 virtual SALOMEDS::ListOfStrings* GetDirectoryNames(const char* theContext);
208 //! method to get all file names in the given context (or in the current context, if 'theContext' is empty)
211 virtual SALOMEDS::ListOfStrings* GetFileNames(const char* theContext);
213 //! method to get all components names
216 virtual SALOMEDS::ListOfStrings* GetComponentNames(const char* theContext);
218 //! method to Create a ChildIterator from an SObject
220 \param aSO SObject_ptr arguments
221 \return ChildIterator_ptr arguments, the created ChildIterator
223 virtual SALOMEDS::ChildIterator_ptr NewChildIterator(SALOMEDS::SObject_ptr aSO);
225 //! method to Create a SComponentIterator
227 \return SComponentIterator_ptr arguments, the created SComponentIterator
229 virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator();
231 //! method to Create a StudyBuilder
233 \return StudyBuilder_ptr arguments, the created StudyBuilder
235 virtual SALOMEDS::StudyBuilder_ptr NewBuilder();
237 //! method to get study name
239 \return char* arguments, the study name
241 virtual char* Name();
243 //! method to get if study has been saved
245 \return bool arguments
247 virtual CORBA::Boolean IsSaved();
249 //! method to set if study has been saved
251 \param save bool arguments
253 virtual void IsSaved(CORBA::Boolean save);
255 //! method to Detect if a Study has been modified since it has been saved
257 \return bool arguments
259 virtual CORBA::Boolean IsModified();
261 //! method to set Modified flag of a Study to True
262 virtual void Modified();
264 //! method to get URL of the study (idem GetPersistentReference)
266 \return char* arguments, the study URL
270 //! method to set URL of the study
272 \param url char* arguments, the study URL
274 virtual void URL(const char* url);
276 static SALOMEDS::Study_ptr GetStudy(const DF_Label& theLabel, CORBA::ORB_ptr orb);
278 static void IORUpdated(SALOMEDSImpl_AttributeIOR* theAttribute);
280 virtual void UpdateIORLabelMap(const char* anIOR, const char* aLabel);
282 virtual SALOMEDS::Study::ListOfSObject* FindDependances(SALOMEDS::SObject_ptr anObject);
284 virtual SALOMEDS::AttributeStudyProperties_ptr GetProperties();
286 virtual char* GetLastModificationDate();
288 virtual SALOMEDS::ListOfDates* GetModificationsDate();
290 virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
291 virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
293 virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder();
295 void EnableUseCaseAutoFilling(CORBA::Boolean 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(CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
303 // if theUndoLimit==0, removes all
304 virtual void UndoPostponed(CORBA::Long theWay); // theWay = 1: resurrect objects,
305 // theWay = -1: get back to the list of postponed
307 virtual SALOMEDS::AttributeParameter_ptr GetCommonParameters(const char* theID, CORBA::Long theSavePoint);
308 virtual SALOMEDS::AttributeParameter_ptr GetModuleParameters(const char* theID,
309 const char* theModuleName,
310 CORBA::Long theSavePoint);
312 virtual void SetStudyLock(const char* theLockerID);
314 virtual bool IsStudyLocked();
316 virtual void UnLockStudy(const char* theLockerID);
318 virtual SALOMEDS::ListOfStrings* GetLockerID();
320 virtual void SetReal(const char* theVarName, CORBA::Double theValue);
322 virtual void SetInteger(const char* theVarName, CORBA::Long theValue);
324 virtual void SetBoolean(const char* theVarName, CORBA::Boolean theValue);
326 virtual void SetString(const char* theVarName, const char* theValue);
328 virtual void SetStringAsDouble(const char* theVarName, CORBA::Double theValue);
330 virtual CORBA::Double GetReal(const char* theVarName);
332 virtual CORBA::Long GetInteger(const char* theVarName);
334 virtual CORBA::Boolean GetBoolean(const char* theVarName);
336 virtual char* GetString(const char* theVarName);
338 virtual CORBA::Boolean IsReal(const char* theVarName);
340 virtual CORBA::Boolean IsInteger(const char* theVarName);
342 virtual CORBA::Boolean IsBoolean(const char* theVarName);
344 virtual CORBA::Boolean IsString(const char* theVarName);
346 virtual CORBA::Boolean IsVariable(const char* theVarName);
348 virtual SALOMEDS::ListOfStrings* GetVariableNames();
350 virtual CORBA::Boolean RemoveVariable(const char* theVarName);
352 virtual CORBA::Boolean RenameVariable(const char* theVarName, const char* theNewVarName);
354 virtual CORBA::Boolean IsVariableUsed(const char* theVarName);
356 virtual SALOMEDS::ListOfListOfStrings* ParseVariables(const char* theVars);
358 virtual char* GetDefaultScript(const char* theModuleName, const char* theShift);
360 virtual CORBA::Boolean DumpStudy(const char* thePath,
361 const char* theBaseName,
362 CORBA::Boolean isPublished,
363 CORBA::Boolean isMultiFile);
365 virtual SALOMEDSImpl_Study* GetImpl() { return _impl; }
367 virtual CORBA::LongLong GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
370 CORBA::Long getPID();
371 void ShutdownWithExit();
375 virtual void attach(SALOMEDS::Observer_ptr theObs, CORBA::Boolean modify);
376 virtual void detach(SALOMEDS::Observer_ptr theObs);