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 SALOMEDSImpl_AbstractCallback* _genObjRegister;
58 SALOMEDS_DriverFactory_i* _factory;
63 //! standard constructor
64 SALOMEDS_Study_i(CORBA::ORB_ptr);
66 //! standard destructor
67 virtual ~SALOMEDS_Study_i();
72 //! method to Open a Study
74 \param char* arguments, the study URL
75 \return Study_ptr arguments
77 virtual bool Open(const char* aStudyUrl) throw (SALOME::SALOME_Exception);
79 //! method to save a Study
80 virtual CORBA::Boolean Save(CORBA::Boolean theMultiFile);
81 virtual CORBA::Boolean SaveASCII(CORBA::Boolean theMultiFile);
83 //! method to save a Study to the persistent reference aUrl
85 \param char* arguments, the new URL of the study
87 virtual CORBA::Boolean SaveAs(const char* aUrl, CORBA::Boolean theMultiFile);
88 virtual CORBA::Boolean SaveAsASCII(const char* aUrl, CORBA::Boolean theMultiFile);
90 //! method to copy the object
92 \param theObject object to copy
94 virtual CORBA::Boolean Copy(SALOMEDS::SObject_ptr theObject);
95 virtual CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
96 //! method to paste the object in study
98 \param theObject object to paste
100 virtual SALOMEDS::SObject_ptr Paste(SALOMEDS::SObject_ptr theObject) throw(SALOMEDS::StudyBuilder::LockProtection);
101 virtual CORBA::Boolean CanPaste(SALOMEDS::SObject_ptr theObject);
103 //! method to Get persistent reference of study (idem URL())
106 \return char* arguments, the persistent reference of the study
108 virtual char* GetPersistentReference();
111 //! method to Get transient reference of study
113 \return char* arguments, the transient reference of the study
115 virtual char* GetTransientReference();
117 //! method to detect if a study is empty
119 \return bool arguments, true if study is empty
121 virtual CORBA::Boolean IsEmpty();
123 //! method to Find a Component with ComponentDataType = aComponentName
125 \param aComponentName char* arguments
126 \return SComponent_ptr arguments, the component found
128 virtual SALOMEDS::SComponent_ptr FindComponent (const char* aComponentName);
130 //! method to Find a Component Find a Component from it's ID
132 \param aComponentID char* arguments
133 \return SComponent_ptr arguments, the component found
135 virtual SALOMEDS::SComponent_ptr FindComponentID(const char* aComponentID);
137 //! method to Find an Object with SALOMEDS::Name = anObjectName
139 \param anObjectName char* arguments
140 \return SObject_ptr arguments, the object found
142 virtual SALOMEDS::SObject_ptr FindObject(const char* anObjectName);
145 //! method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName
147 \param anObjectName char* arguments
148 \param aComponentName char* arguments
149 \return ListOfSObject_ptr arguments, a list of objects found
152 virtual SALOMEDS::Study::ListOfSObject* FindObjectByName( const char* anObjectName, const char* aComponentName ) ;
154 //! method to Find an Object with ID = anObjectID
156 \param anObjectID char* arguments
157 \return SObject_ptr arguments, the object found
159 virtual SALOMEDS::SObject_ptr FindObjectID(const char* anObjectID);
161 //! method to Create an Object with ID = anObjectID
163 \param anObjectID char* arguments
164 \return SObject_ptr arguments, the object found
166 virtual SALOMEDS::SObject_ptr CreateObjectID(const char* anObjectID);
168 //! method to Find an Object with ID = anObjectIOR
170 \param anObjectIOR char* arguments
171 \return SObject_ptr arguments, the object found
173 virtual SALOMEDS::SObject_ptr FindObjectIOR(const char* anObjectIOR);
175 //! method to Find an Object by its path
177 \param thePath char* arguments
178 \return SObject_ptr arguments, the object found
180 virtual SALOMEDS::SObject_ptr FindObjectByPath(const char* thePath);
182 //! method to get a path of SObject
184 \param aSO SObject_ptr arguments
185 \return char* arguments, the path of the SObject
187 virtual char* GetObjectPath(CORBA::Object_ptr theObject);
189 //! method to set a context: root ('/') is UserData component
192 virtual void SetContext(const char* thePath);
194 //! method to get a context
197 virtual char* GetContext();
199 //! method to get all object names in the given context (or in the current context, if 'theContext' is empty)
202 virtual SALOMEDS::ListOfStrings* GetObjectNames(const char* theContext);
204 //! method to get all directory names in the given context (or in the current context, if 'theContext' is empty)
207 virtual SALOMEDS::ListOfStrings* GetDirectoryNames(const char* theContext);
209 //! method to get all file names in the given context (or in the current context, if 'theContext' is empty)
212 virtual SALOMEDS::ListOfStrings* GetFileNames(const char* theContext);
214 //! method to get all components names
217 virtual SALOMEDS::ListOfStrings* GetComponentNames(const char* theContext);
219 //! method to Create a ChildIterator from an SObject
221 \param aSO SObject_ptr arguments
222 \return ChildIterator_ptr arguments, the created ChildIterator
224 virtual SALOMEDS::ChildIterator_ptr NewChildIterator(SALOMEDS::SObject_ptr aSO);
226 //! method to Create a SComponentIterator
228 \return SComponentIterator_ptr arguments, the created SComponentIterator
230 virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator();
232 //! method to Create a StudyBuilder
234 \return StudyBuilder_ptr arguments, the created StudyBuilder
236 virtual SALOMEDS::StudyBuilder_ptr NewBuilder();
238 //! method to get study name
240 \return char* arguments, the study name
242 virtual char* Name();
244 //! method to get if study has been saved
246 \return bool arguments
248 virtual CORBA::Boolean IsSaved();
250 //! method to set if study has been saved
252 \param save bool arguments
254 virtual void IsSaved(CORBA::Boolean save);
256 //! method to Detect if a Study has been modified since it has been saved
258 \return bool arguments
260 virtual CORBA::Boolean IsModified();
262 //! method to set Modified flag of a Study to True
263 virtual void Modified();
265 //! method to get URL of the study (idem GetPersistentReference)
267 \return char* arguments, the study URL
271 //! method to set URL of the study
273 \param url char* arguments, the study URL
275 virtual void URL(const char* url);
277 static SALOMEDS::Study_ptr GetStudy(const DF_Label& theLabel, CORBA::ORB_ptr orb);
279 static void IORUpdated(SALOMEDSImpl_AttributeIOR* theAttribute);
281 virtual void UpdateIORLabelMap(const char* anIOR, const char* aLabel);
283 virtual SALOMEDS::Study::ListOfSObject* FindDependances(SALOMEDS::SObject_ptr anObject);
285 virtual SALOMEDS::AttributeStudyProperties_ptr GetProperties();
287 virtual char* GetLastModificationDate();
289 virtual SALOMEDS::ListOfDates* GetModificationsDate();
291 virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
292 virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
294 virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder();
296 void EnableUseCaseAutoFilling(CORBA::Boolean isEnabled);
298 // postponed destroying of CORBA object functionality
299 virtual void AddPostponed(const char* theIOR);
301 virtual void AddCreatedPostponed(const char* theIOR);
303 virtual void RemovePostponed(CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
304 // if theUndoLimit==0, removes all
305 virtual void UndoPostponed(CORBA::Long theWay); // theWay = 1: resurrect objects,
306 // theWay = -1: get back to the list of postponed
308 virtual SALOMEDS::AttributeParameter_ptr GetCommonParameters(const char* theID, CORBA::Long theSavePoint);
309 virtual SALOMEDS::AttributeParameter_ptr GetModuleParameters(const char* theID,
310 const char* theModuleName,
311 CORBA::Long theSavePoint);
313 virtual void SetStudyLock(const char* theLockerID);
315 virtual bool IsStudyLocked();
317 virtual void UnLockStudy(const char* theLockerID);
319 virtual SALOMEDS::ListOfStrings* GetLockerID();
321 virtual void SetReal(const char* theVarName, CORBA::Double theValue);
323 virtual void SetInteger(const char* theVarName, CORBA::Long theValue);
325 virtual void SetBoolean(const char* theVarName, CORBA::Boolean theValue);
327 virtual void SetString(const char* theVarName, const char* theValue);
329 virtual void SetStringAsDouble(const char* theVarName, CORBA::Double theValue);
331 virtual CORBA::Double GetReal(const char* theVarName);
333 virtual CORBA::Long GetInteger(const char* theVarName);
335 virtual CORBA::Boolean GetBoolean(const char* theVarName);
337 virtual char* GetString(const char* theVarName);
339 virtual CORBA::Boolean IsReal(const char* theVarName);
341 virtual CORBA::Boolean IsInteger(const char* theVarName);
343 virtual CORBA::Boolean IsBoolean(const char* theVarName);
345 virtual CORBA::Boolean IsString(const char* theVarName);
347 virtual CORBA::Boolean IsVariable(const char* theVarName);
349 virtual SALOMEDS::ListOfStrings* GetVariableNames();
351 virtual CORBA::Boolean RemoveVariable(const char* theVarName);
353 virtual CORBA::Boolean RenameVariable(const char* theVarName, const char* theNewVarName);
355 virtual CORBA::Boolean IsVariableUsed(const char* theVarName);
357 virtual SALOMEDS::ListOfListOfStrings* ParseVariables(const char* theVars);
359 virtual char* GetDefaultScript(const char* theModuleName, const char* theShift);
361 virtual CORBA::Boolean DumpStudy(const char* thePath,
362 const char* theBaseName,
363 CORBA::Boolean isPublished,
364 CORBA::Boolean isMultiFile);
366 virtual SALOMEDSImpl_Study* GetImpl() { return _impl; }
368 virtual CORBA::LongLong GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
371 CORBA::Long getPID();
372 void ShutdownWithExit();
376 virtual void attach(SALOMEDS::Observer_ptr theObs, CORBA::Boolean modify);
377 virtual void detach(SALOMEDS::Observer_ptr theObs);