1 // Copyright (C) 2007-2012 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 : 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"
46 #include "SALOMEDSImpl_Study.hxx"
47 #include "SALOMEDSImpl_AttributeIOR.hxx"
49 class Standard_EXPORT SALOMEDS_Study_i: public POA_SALOMEDS::Study
53 SALOMEDSImpl_Study* _impl;
54 SALOMEDS_StudyBuilder_i* _builder;
55 static std::map<SALOMEDSImpl_Study*, SALOMEDS_Study_i*> _mapOfStudies;
56 SALOMEDSImpl_AbstractCallback* _notifier;
57 SALOMEDSImpl_AbstractCallback* _genObjRegister;
61 //! standard constructor
62 SALOMEDS_Study_i(SALOMEDSImpl_Study*, CORBA::ORB_ptr);
64 //! standard destructor
65 virtual ~SALOMEDS_Study_i();
67 //! method to Get persistent reference of study (idem URL())
70 \return char* arguments, the persistent reference of the study
72 virtual char* GetPersistentReference();
75 //! method to Get transient reference of study
77 \return char* arguments, the transient reference of the study
79 virtual char* GetTransientReference();
81 //! method to detect if a study is empty
83 \return bool arguments, true if study is empty
85 virtual CORBA::Boolean IsEmpty();
87 //! method to Find a Component with ComponentDataType = aComponentName
89 \param aComponentName char* arguments
90 \return SComponent_ptr arguments, the component found
92 virtual SALOMEDS::SComponent_ptr FindComponent (const char* aComponentName);
94 //! method to Find a Component Find a Component from it's ID
96 \param aComponentID char* arguments
97 \return SComponent_ptr arguments, the component found
99 virtual SALOMEDS::SComponent_ptr FindComponentID(const char* aComponentID);
101 //! method to Find an Object with SALOMEDS::Name = anObjectName
103 \param anObjectName char* arguments
104 \return SObject_ptr arguments, the object found
106 virtual SALOMEDS::SObject_ptr FindObject(const char* anObjectName);
109 //! method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName
111 \param anObjectName char* arguments
112 \param aComponentName char* arguments
113 \return ListOfSObject_ptr arguments, a list of objects found
116 virtual SALOMEDS::Study::ListOfSObject* FindObjectByName( const char* anObjectName, const char* aComponentName ) ;
118 //! method to Find an Object with ID = anObjectID
120 \param anObjectID char* arguments
121 \return SObject_ptr arguments, the object found
123 virtual SALOMEDS::SObject_ptr FindObjectID(const char* anObjectID);
125 //! method to Create an Object with ID = anObjectID
127 \param anObjectID char* arguments
128 \return SObject_ptr arguments, the object found
130 virtual SALOMEDS::SObject_ptr CreateObjectID(const char* anObjectID);
132 //! method to Find an Object with ID = anObjectIOR
134 \param anObjectIOR char* arguments
135 \return SObject_ptr arguments, the object found
137 virtual SALOMEDS::SObject_ptr FindObjectIOR(const char* anObjectIOR);
139 //! method to Find an Object by its path
141 \param thePath char* arguments
142 \return SObject_ptr arguments, the object found
144 virtual SALOMEDS::SObject_ptr FindObjectByPath(const char* thePath);
146 //! method to get a path of SObject
148 \param aSO SObject_ptr arguments
149 \return char* arguments, the path of the SObject
151 virtual char* GetObjectPath(CORBA::Object_ptr theObject);
153 //! method to set a context: root ('/') is UserData component
156 virtual void SetContext(const char* thePath);
158 //! method to get a context
161 virtual char* GetContext();
163 //! method to get all object names in the given context (or in the current context, if 'theContext' is empty)
166 virtual SALOMEDS::ListOfStrings* GetObjectNames(const char* theContext);
168 //! method to get all directory names in the given context (or in the current context, if 'theContext' is empty)
171 virtual SALOMEDS::ListOfStrings* GetDirectoryNames(const char* theContext);
173 //! method to get all file names in the given context (or in the current context, if 'theContext' is empty)
176 virtual SALOMEDS::ListOfStrings* GetFileNames(const char* theContext);
178 //! method to get all components names
181 virtual SALOMEDS::ListOfStrings* GetComponentNames(const char* theContext);
183 //! method to Create a ChildIterator from an SObject
185 \param aSO SObject_ptr arguments
186 \return ChildIterator_ptr arguments, the created ChildIterator
188 virtual SALOMEDS::ChildIterator_ptr NewChildIterator(SALOMEDS::SObject_ptr aSO);
190 //! method to Create a SComponentIterator
192 \return SComponentIterator_ptr arguments, the created SComponentIterator
194 virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator();
196 //! method to Create a StudyBuilder
198 \return StudyBuilder_ptr arguments, the created StudyBuilder
200 virtual SALOMEDS::StudyBuilder_ptr NewBuilder();
202 //! method to get study name
204 \return char* arguments, the study name
206 virtual char* Name();
208 //! method to set study name
210 \param name char* arguments, the study name
212 virtual void Name(const char* name);
214 //! method to get if study has been saved
216 \return bool arguments
218 virtual CORBA::Boolean IsSaved();
220 //! method to set if study has been saved
222 \param save bool arguments
224 virtual void IsSaved(CORBA::Boolean save);
226 //! method to Detect if a Study has been modified since it has been saved
228 \return bool arguments
230 virtual CORBA::Boolean IsModified();
232 //! method to set Modified flag of a Study to True
233 virtual void Modified();
235 //! method to get URL of the study (idem GetPersistentReference)
237 \return char* arguments, the study URL
241 //! method to set URL of the study
243 \param url char* arguments, the study URL
245 virtual void URL(const char* url);
247 virtual CORBA::Short StudyId();
248 virtual void StudyId(CORBA::Short id);
250 static SALOMEDS::Study_ptr GetStudy(const DF_Label& theLabel, CORBA::ORB_ptr orb);
251 static SALOMEDS_Study_i* GetStudyServant(SALOMEDSImpl_Study*, CORBA::ORB_ptr orb);
253 static void IORUpdated(SALOMEDSImpl_AttributeIOR* theAttribute);
255 virtual void UpdateIORLabelMap(const char* anIOR, const char* aLabel);
257 virtual SALOMEDS::Study::ListOfSObject* FindDependances(SALOMEDS::SObject_ptr anObject);
259 virtual SALOMEDS::AttributeStudyProperties_ptr GetProperties();
261 virtual char* GetLastModificationDate();
263 virtual SALOMEDS::ListOfDates* GetModificationsDate();
265 virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
266 virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
268 virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder();
270 virtual void Close();
272 void EnableUseCaseAutoFilling(CORBA::Boolean isEnabled);
274 // postponed destroying of CORBA object functionality
275 virtual void AddPostponed(const char* theIOR);
277 virtual void AddCreatedPostponed(const char* theIOR);
280 virtual void RemovePostponed(const CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
281 // if theUndoLimit==0, removes all
282 virtual void UndoPostponed(const CORBA::Long theWay); // theWay = 1: resurrect objects,
283 // theWay = -1: get back to the list of postponed
285 virtual void RemovePostponed(CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
286 // if theUndoLimit==0, removes all
287 virtual void UndoPostponed(CORBA::Long theWay); // theWay = 1: resurrect objects,
288 // theWay = -1: get back to the list of postponed
291 virtual SALOMEDS::AttributeParameter_ptr GetCommonParameters(const char* theID, CORBA::Long theSavePoint);
292 virtual SALOMEDS::AttributeParameter_ptr GetModuleParameters(const char* theID,
293 const char* theModuleName,
294 CORBA::Long theSavePoint);
296 virtual void SetStudyLock(const char* theLockerID);
298 virtual bool IsStudyLocked();
300 virtual void UnLockStudy(const char* theLockerID);
302 virtual SALOMEDS::ListOfStrings* GetLockerID();
304 virtual void SetReal(const char* theVarName, CORBA::Double theValue);
306 virtual void SetInteger(const char* theVarName, CORBA::Long theValue);
308 virtual void SetBoolean(const char* theVarName, CORBA::Boolean theValue);
310 virtual void SetString(const char* theVarName, const char* theValue);
312 virtual void SetStringAsDouble(const char* theVarName, CORBA::Double theValue);
314 virtual CORBA::Double GetReal(const char* theVarName);
316 virtual CORBA::Long GetInteger(const char* theVarName);
318 virtual CORBA::Boolean GetBoolean(const char* theVarName);
320 virtual char* GetString(const char* theVarName);
322 virtual CORBA::Boolean IsReal(const char* theVarName);
324 virtual CORBA::Boolean IsInteger(const char* theVarName);
326 virtual CORBA::Boolean IsBoolean(const char* theVarName);
328 virtual CORBA::Boolean IsString(const char* theVarName);
330 virtual CORBA::Boolean IsVariable(const char* theVarName);
332 virtual SALOMEDS::ListOfStrings* GetVariableNames();
334 virtual CORBA::Boolean RemoveVariable(const char* theVarName);
336 virtual CORBA::Boolean RenameVariable(const char* theVarName, const char* theNewVarName);
338 virtual CORBA::Boolean IsVariableUsed(const char* theVarName);
340 virtual SALOMEDS::ListOfListOfStrings* ParseVariables(const char* theVars);
342 virtual char* GetDefaultScript(const char* theModuleName, const char* theShift);
344 virtual CORBA::Boolean DumpStudy(const char* thePath,
345 const char* theBaseName,
346 CORBA::Boolean isPublished,
347 CORBA::Boolean isMultiFile);
349 virtual SALOMEDSImpl_Study* GetImpl() { return _impl; }
351 virtual CORBA::LongLong GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
353 virtual void attach(SALOMEDS::Observer_ptr theObs, CORBA::Boolean modify);