1 // Copyright (C) 2007-2010 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"
51 class Standard_EXPORT SALOMEDS_Study_i: public POA_SALOMEDS::Study
55 SALOMEDSImpl_Study* _impl;
56 SALOMEDS_StudyBuilder_i* _builder;
57 static std::map<SALOMEDSImpl_Study*, SALOMEDS_Study_i*> _mapOfStudies;
62 //! standard constructor
63 SALOMEDS_Study_i(SALOMEDSImpl_Study*, CORBA::ORB_ptr);
65 //! standard destructor
66 virtual ~SALOMEDS_Study_i();
68 //! method to Get persistent reference of study (idem URL())
71 \return char* arguments, the persistent reference of the study
73 virtual char* GetPersistentReference();
76 //! method to Get transient reference of study
78 \return char* arguments, the transient reference of the study
80 virtual char* GetTransientReference();
82 //! method to detect if a study is empty
84 \return bool arguments, true if study is empty
86 virtual CORBA::Boolean IsEmpty();
88 //! method to Find a Component with ComponentDataType = aComponentName
90 \param aComponentName char* arguments
91 \return SComponent_ptr arguments, the component found
93 virtual SALOMEDS::SComponent_ptr FindComponent (const char* aComponentName);
95 //! method to Find a Component Find a Component from it's ID
97 \param aComponentID char* arguments
98 \return SComponent_ptr arguments, the component found
100 virtual SALOMEDS::SComponent_ptr FindComponentID(const char* aComponentID);
102 //! method to Find an Object with SALOMEDS::Name = anObjectName
104 \param anObjectName char* arguments
105 \return SObject_ptr arguments, the object found
107 virtual SALOMEDS::SObject_ptr FindObject(const char* anObjectName);
110 //! method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName
112 \param anObjectName char* arguments
113 \param aComponentName char* arguments
114 \return ListOfSObject_ptr arguments, a list of objects found
117 virtual SALOMEDS::Study::ListOfSObject* FindObjectByName( const char* anObjectName, const char* aComponentName ) ;
119 //! method to Find an Object with ID = anObjectID
121 \param anObjectID char* arguments
122 \return SObject_ptr arguments, the object found
124 virtual SALOMEDS::SObject_ptr FindObjectID(const char* anObjectID);
126 //! method to Create an Object with ID = anObjectID
128 \param anObjectID char* arguments
129 \return SObject_ptr arguments, the object found
131 virtual SALOMEDS::SObject_ptr CreateObjectID(const char* anObjectID);
133 //! method to Find an Object with ID = anObjectIOR
135 \param anObjectIOR char* arguments
136 \return SObject_ptr arguments, the object found
138 virtual SALOMEDS::SObject_ptr FindObjectIOR(const char* anObjectIOR);
140 //! method to Find an Object by its path
142 \param thePath char* arguments
143 \return SObject_ptr arguments, the object found
145 virtual SALOMEDS::SObject_ptr FindObjectByPath(const char* thePath);
147 //! method to get a path of SObject
149 \param aSO SObject_ptr arguments
150 \return char* arguments, the path of the SObject
152 virtual char* GetObjectPath(CORBA::Object_ptr theObject);
154 //! method to set a context: root ('/') is UserData component
157 virtual void SetContext(const char* thePath);
159 //! method to get a context
162 virtual char* GetContext();
164 //! method to get all object names in the given context (or in the current context, if 'theContext' is empty)
167 virtual SALOMEDS::ListOfStrings* GetObjectNames(const char* theContext);
169 //! method to get all directory names in the given context (or in the current context, if 'theContext' is empty)
172 virtual SALOMEDS::ListOfStrings* GetDirectoryNames(const char* theContext);
174 //! method to get all file names in the given context (or in the current context, if 'theContext' is empty)
177 virtual SALOMEDS::ListOfStrings* GetFileNames(const char* theContext);
179 //! method to get all components names
182 virtual SALOMEDS::ListOfStrings* GetComponentNames(const char* theContext);
184 //! method to Create a ChildIterator from an SObject
186 \param aSO SObject_ptr arguments
187 \return ChildIterator_ptr arguments, the created ChildIterator
189 virtual SALOMEDS::ChildIterator_ptr NewChildIterator(SALOMEDS::SObject_ptr aSO);
191 //! method to Create a SComponentIterator
193 \return SComponentIterator_ptr arguments, the created SComponentIterator
195 virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator();
197 //! method to Create a StudyBuilder
199 \return StudyBuilder_ptr arguments, the created StudyBuilder
201 virtual SALOMEDS::StudyBuilder_ptr NewBuilder();
203 //! method to get study name
205 \return char* arguments, the study name
207 virtual char* Name();
209 //! method to set study name
211 \param name char* arguments, the study name
213 virtual void Name(const char* name);
215 //! method to get if study has been saved
217 \return bool arguments
219 virtual CORBA::Boolean IsSaved();
221 //! method to set if study has been saved
223 \param save bool arguments
225 virtual void IsSaved(CORBA::Boolean save);
227 //! method to Detect if a Study has been modified since it has been saved
229 \return bool arguments
231 virtual CORBA::Boolean IsModified();
233 //! method to set Modified flag of a Study to True
234 virtual void Modified();
236 //! method to get URL of the study (idem GetPersistentReference)
238 \return char* arguments, the study URL
242 //! method to set URL of the study
244 \param url char* arguments, the study URL
246 virtual void URL(const char* url);
248 virtual CORBA::Short StudyId();
249 virtual void StudyId(CORBA::Short id);
251 static SALOMEDS::Study_ptr GetStudy(const DF_Label& theLabel, CORBA::ORB_ptr orb);
252 static SALOMEDS_Study_i* GetStudyServant(SALOMEDSImpl_Study*, CORBA::ORB_ptr orb);
254 static void IORUpdated(SALOMEDSImpl_AttributeIOR* theAttribute);
256 virtual void UpdateIORLabelMap(const char* anIOR, const char* aLabel);
258 virtual SALOMEDS::Study::ListOfSObject* FindDependances(SALOMEDS::SObject_ptr anObject);
260 virtual SALOMEDS::AttributeStudyProperties_ptr GetProperties();
262 virtual char* GetLastModificationDate();
264 virtual SALOMEDS::ListOfDates* GetModificationsDate();
266 virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
267 virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
269 virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder();
271 virtual void Close();
273 void EnableUseCaseAutoFilling(CORBA::Boolean isEnabled);
275 // postponed destroying of CORBA object functionality
276 virtual void AddPostponed(const char* theIOR);
278 virtual void AddCreatedPostponed(const char* theIOR);
281 virtual void RemovePostponed(const CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
282 // if theUndoLimit==0, removes all
283 virtual void UndoPostponed(const CORBA::Long theWay); // theWay = 1: resurrect objects,
284 // theWay = -1: get back to the list of postponed
286 virtual void RemovePostponed(CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
287 // if theUndoLimit==0, removes all
288 virtual void UndoPostponed(CORBA::Long theWay); // theWay = 1: resurrect objects,
289 // theWay = -1: get back to the list of postponed
292 virtual SALOMEDS::AttributeParameter_ptr GetCommonParameters(const char* theID, CORBA::Long theSavePoint);
293 virtual SALOMEDS::AttributeParameter_ptr GetModuleParameters(const char* theID,
294 const char* theModuleName,
295 CORBA::Long theSavePoint);
297 virtual void SetStudyLock(const char* theLockerID);
299 virtual bool IsStudyLocked();
301 virtual void UnLockStudy(const char* theLockerID);
303 virtual SALOMEDS::ListOfStrings* GetLockerID();
305 virtual void SetReal(const char* theVarName, CORBA::Double theValue);
307 virtual void SetInteger(const char* theVarName, CORBA::Long theValue);
309 virtual void SetBoolean(const char* theVarName, CORBA::Boolean theValue);
311 virtual void SetString(const char* theVarName, const char* theValue);
313 virtual void SetStringAsDouble(const char* theVarName, CORBA::Double theValue);
315 virtual CORBA::Double GetReal(const char* theVarName);
317 virtual CORBA::Long GetInteger(const char* theVarName);
319 virtual CORBA::Boolean GetBoolean(const char* theVarName);
321 virtual char* GetString(const char* theVarName);
323 virtual CORBA::Boolean IsReal(const char* theVarName);
325 virtual CORBA::Boolean IsInteger(const char* theVarName);
327 virtual CORBA::Boolean IsBoolean(const char* theVarName);
329 virtual CORBA::Boolean IsString(const char* theVarName);
331 virtual CORBA::Boolean IsVariable(const char* theVarName);
333 virtual SALOMEDS::ListOfStrings* GetVariableNames();
335 virtual CORBA::Boolean RemoveVariable(const char* theVarName);
337 virtual CORBA::Boolean RenameVariable(const char* theVarName, const char* theNewVarName);
339 virtual CORBA::Boolean IsVariableUsed(const char* theVarName);
341 virtual SALOMEDS::ListOfListOfStrings* ParseVariables(const char* theVars);
343 virtual char* GetDefaultScript(const char* theModuleName, const char* theShift);
345 virtual CORBA::Boolean DumpStudy(const char* thePath, const char* theBaseName, CORBA::Boolean isPublished);
347 virtual SALOMEDSImpl_Study* GetImpl() { return _impl; }
349 virtual CORBA::LongLong GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
351 virtual void attach(SALOMEDS::Observer_ptr theObs, CORBA::Boolean modify);