1 // Copyright (C) 2007-2019 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 : SALOMEDSImpl_Study.hxx
24 // Author : Sergey RUIN
27 #ifndef __SALOMEDSIMPL_STUDY_I_H__
28 #define __SALOMEDSIMPL_STUDY_I_H__
36 #include "DF_Document.hxx"
37 #include "DF_Label.hxx"
40 //SALOMEDSImpl headers
41 #include "SALOMEDSImpl_Defines.hxx"
42 #include "SALOMEDSImpl_SComponentIterator.hxx"
43 #include "SALOMEDSImpl_SObject.hxx"
44 #include "SALOMEDSImpl_StudyBuilder.hxx"
45 #include "SALOMEDSImpl_UseCaseBuilder.hxx"
46 #include "SALOMEDSImpl_AttributeStudyProperties.hxx"
47 #include "SALOMEDSImpl_AttributeIOR.hxx"
48 #include "SALOMEDSImpl_AttributeParameter.hxx"
49 #include "SALOMEDSImpl_Callback.hxx"
50 #include "SALOMEDSImpl_Driver.hxx"
51 #include "SALOMEDSImpl_ChildIterator.hxx"
52 #include "SALOMEDSImpl_GenericVariable.hxx"
55 class SALOMEDSImpl_GenericAttribute;
58 class SALOMEDSIMPL_EXPORT SALOMEDSImpl_Study
62 DF_Application* _appli;
63 DF_Document* _doc; // Document
64 DF_Document* _clipboard;
65 bool _Saved; // True if the Study is saved
66 std::string _URL; //URL of the persistent reference of the study
68 std::string _errorCode;
69 std::vector<std::string> _lockers;
70 SALOMEDSImpl_Callback* _cb;
71 SALOMEDSImpl_StudyBuilder* _builder;
72 SALOMEDSImpl_UseCaseBuilder* _useCaseBuilder;
73 SALOMEDSImpl_AbstractCallback* _notifier;
74 SALOMEDSImpl_AbstractCallback* _genObjRegister;
75 std::string _dumpPath; // path (folder) to the python file which is currently dumped
77 std::map<std::string, SALOMEDSImpl_SObject> _mapOfSO;
78 std::map<std::string, SALOMEDSImpl_SComponent> _mapOfSCO;
79 std::map<std::string, DF_Label> myIORLabels;
80 std::vector<SALOMEDSImpl_GenericVariable*> myNoteBookVars;
82 SALOMEDSImpl_SObject _FindObject(const SALOMEDSImpl_SObject& SO,
83 const std::string& anObjectName,
86 SALOMEDSImpl_SObject _FindObjectIOR(const SALOMEDSImpl_SObject& SO,
87 const std::string& anObjectIOR,
90 std::string _GetStudyVariablesScript();
91 std::string _GetNoteBookAccessor();
92 std::string _GetNoteBookAccess();
96 static SALOMEDSImpl_Study* GetStudyImpl(const DF_Label& theLabel);
97 static SALOMEDSImpl_SObject SObject(const DF_Label& theLabel);
98 static SALOMEDSImpl_SComponent SComponent(const DF_Label& theLabel);
99 static void IORUpdated(const SALOMEDSImpl_AttributeIOR* theAttribute);
101 //! standard constructor
102 SALOMEDSImpl_Study();
104 //! standard destructor
105 virtual ~SALOMEDSImpl_Study();
108 virtual void Clear();
110 //! method to Open a Study from it's persistent reference
111 virtual bool Open(const std::string& aStudyUrl);
113 //! method to save a Study
114 virtual bool Save(SALOMEDSImpl_DriverFactory* aFactory,
118 //! method to save a Study to the persistent reference aUrl
119 virtual bool SaveAs(const std::string& aUrl,
120 SALOMEDSImpl_DriverFactory* aFactory,
124 bool CopyLabel(SALOMEDSImpl_Driver* theEngine,
125 const int theSourceStartDepth,
126 const DF_Label& theSource,
127 const DF_Label& theDestinationMain);
129 DF_Label PasteLabel(SALOMEDSImpl_Driver* theEngine,
130 const DF_Label& theSource,
131 const DF_Label& theDestinationStart,
132 const bool isFirstElement);
134 virtual bool CanCopy(const SALOMEDSImpl_SObject& theObject, SALOMEDSImpl_Driver* Engine);
135 virtual bool Copy(const SALOMEDSImpl_SObject& theObject, SALOMEDSImpl_Driver* Engine);
136 virtual bool CanPaste(const SALOMEDSImpl_SObject& theObject, SALOMEDSImpl_Driver* Engine);
137 virtual SALOMEDSImpl_SObject Paste(const SALOMEDSImpl_SObject& theObject, SALOMEDSImpl_Driver* Engine);
139 // _SaveAs private function called by Save and SaveAs
140 virtual bool Impl_SaveAs(const std::string& aUrl,
141 SALOMEDSImpl_DriverFactory* aFactory,
145 // _SaveObject private function called by _SaveAs
146 virtual bool Impl_SaveObject(const SALOMEDSImpl_SObject& SC, HDFgroup *hdf_group_datatype);
148 virtual bool Impl_SaveProperties(HDFgroup *hdf_group);
151 //! method to Get persistent reference of study (idem URL())
152 virtual std::string GetPersistentReference();
154 //! method to detect if a study is empty
155 virtual bool IsEmpty();
157 //! method to Find a Component with ComponentDataType = aComponentName
158 virtual SALOMEDSImpl_SComponent FindComponent (const std::string& aComponentName);
160 //! method to Find a Component Find a Component from it's ID
161 virtual SALOMEDSImpl_SComponent FindComponentID(const std::string& aComponentID);
163 //! method to Find an Object with SALOMEDSImpl::Name = anObjectName
164 virtual SALOMEDSImpl_SObject FindObject(const std::string& anObjectName);
167 //! method to Find Object(s) with SALOMEDSImpl::Name=anObjectName in a component with ComponentDataType = aComponentName
168 virtual std::vector<SALOMEDSImpl_SObject> FindObjectByName( const std::string& anObjectName,
169 const std::string& aComponentName ) ;
171 //! method to Find an Object with ID = anObjectID
172 virtual SALOMEDSImpl_SObject FindObjectID(const std::string& anObjectID);
174 //! method to Create an Object with ID = anObjectID
175 virtual SALOMEDSImpl_SObject CreateObjectID(const std::string& anObjectID);
177 //! method to Find an Object with ID = anObjectIOR
178 virtual SALOMEDSImpl_SObject FindObjectIOR(const std::string& anObjectIOR);
180 //! method to Find an Object by its path
181 virtual SALOMEDSImpl_SObject FindObjectByPath(const std::string& thePath);
183 //! method to get a path of SObject
184 virtual std::string GetObjectPath(const SALOMEDSImpl_SObject& theObject);
186 std::string GetObjectPathByIOR(const std::string& theIOR);
188 //! method to Create a ChildIterator from an SObject
189 virtual SALOMEDSImpl_ChildIterator NewChildIterator(const SALOMEDSImpl_SObject& aSO);
191 //! method to Create a SComponentIterator
192 virtual SALOMEDSImpl_SComponentIterator NewComponentIterator();
194 //! method to Create a StudyBuilder
195 virtual SALOMEDSImpl_StudyBuilder* NewBuilder();
197 //! method to get study name
198 virtual std::string Name();
200 //! method to set study name
201 virtual void Name(const std::string& name);
203 //! method to get if study has been saved
204 virtual bool IsSaved();
206 //! method to set if study has been saved
207 virtual void IsSaved(bool save);
209 //! method to Detect if a Study has been modified since it has been saved
210 virtual bool IsModified();
212 //! method to get URL of the study (idem GetPersistentReference)
213 virtual std::string URL();
215 //! method to set URL of the study
216 virtual void URL(const std::string& url);
218 virtual bool IsLocked();
220 virtual void DeleteIORLabelMapItem(const std::string& anIOR);
221 virtual void UpdateIORLabelMap(const std::string& anIOR, const std::string& aLabel);
223 virtual std::vector<SALOMEDSImpl_SObject> FindDependances(const SALOMEDSImpl_SObject& anObject);
225 virtual SALOMEDSImpl_AttributeStudyProperties* GetProperties();
227 virtual std::string GetLastModificationDate();
229 virtual std::vector<std::string> GetModificationsDate();
231 virtual SALOMEDSImpl_UseCaseBuilder* GetUseCaseBuilder();
233 void EnableUseCaseAutoFilling(bool isEnabled);
235 virtual std::string GetErrorCode() { return _errorCode; }
236 virtual bool IsError() { return _errorCode != ""; }
238 virtual SALOMEDSImpl_SComponent GetSComponent(const std::string& theEntry);
239 virtual SALOMEDSImpl_SComponent GetSComponent(const DF_Label& theLabel);
240 virtual SALOMEDSImpl_SObject GetSObject(const std::string& theEntry);
241 virtual SALOMEDSImpl_SObject GetSObject(const DF_Label& theEntryLabel);
242 virtual DF_Attribute* GetAttribute(const std::string& theEntry,
243 const std::string& theType);
245 virtual bool DumpStudy(const std::string& thePath,
246 const std::string& theBaseName,
249 SALOMEDSImpl_DriverFactory* theFactory);
251 static std::string GetDumpStudyComment(const char* theComponentName = 0);
253 // Returns the folder of the python script which is currently dumped
254 std::string GetDumpPath();
256 virtual DF_Document* GetDocument() { return _doc; }
258 //The method dump creates a txt file that contain a dump of the study, for debug use
259 void dump(const std::string& theFileName);
261 //This method marks the study as being modified
264 SALOMEDSImpl_AttributeParameter* GetCommonParameters(const char* theID, int theSavePoint);
266 SALOMEDSImpl_AttributeParameter* GetModuleParameters(const char* theID,
267 const char* theModuleName,
270 //Locks the study, theLockerID is identificator of the of the one who locked the study for ex. IOR
271 void SetStudyLock(const char* theLockerID);
273 //Returns True if the study is locked
274 bool IsStudyLocked();
277 void UnLockStudy(const char* theLockerID);
279 //Returns an ID of the study locker
280 std::vector<std::string> GetLockerID();
282 //Managing of variables
283 void SetVariable(const std::string& theVarName,
284 const double theValue,
285 const SALOMEDSImpl_GenericVariable::VariableTypes);
287 void SetStringVariable(const std::string& theVarName,
288 const std::string& theValue,
289 const SALOMEDSImpl_GenericVariable::VariableTypes);
291 void SetStringVariableAsDouble(const std::string& theVarName,
292 const double theValue,
293 const SALOMEDSImpl_GenericVariable::VariableTypes);
295 double GetVariableValue(const std::string& theVarName);
297 std::string GetStringVariableValue(const std::string& theVarName);
299 bool IsTypeOf(const std::string& theVarName,
300 SALOMEDSImpl_GenericVariable::VariableTypes theType) const;
302 bool IsVariable(const std::string& theVarName) const;
305 std::vector<std::string> GetVariableNames() const;
307 void AddVariable(SALOMEDSImpl_GenericVariable* theVariable);
309 SALOMEDSImpl_GenericVariable* GetVariable(const std::string& theName) const;
311 bool RemoveVariable(const std::string& theVarName);
313 bool RenameVariable(const std::string& theVarName, const std::string& theNewVarName);
315 bool IsVariableUsed(const std::string& theVarName);
317 bool FindVariableAttribute(SALOMEDSImpl_StudyBuilder* theStudyBuilder,
318 SALOMEDSImpl_SObject theSObject,
319 const std::string& theName);
320 bool FindVariableAttribute(const std::string& theName);
322 void ReplaceVariableAttribute(SALOMEDSImpl_StudyBuilder* theStudyBuilder,
323 SALOMEDSImpl_SObject theSObject,
324 const std::string& theSource,
325 const std::string& theDest);
326 void ReplaceVariableAttribute(const std::string& theSource, const std::string& theDest);
328 std::vector< std::vector<std::string> > ParseVariables(const std::string& theVariables) const;
331 SALOMEDSImpl_Callback* GetCallback() { return _cb; }
333 //Returns a list of IOR's stored in the study
334 std::vector<std::string> GetIORs();
336 // Notification mechanism
337 virtual bool addSO_Notification(const SALOMEDSImpl_SObject& theSObject);
338 virtual bool removeSO_Notification(const SALOMEDSImpl_SObject& theSObject);
339 virtual bool modifySO_Notification(const SALOMEDSImpl_SObject& theSObject, int reason);
340 virtual void setNotifier(SALOMEDSImpl_AbstractCallback* notifier);
342 static void RegisterGenObj (const std::string& theIOR, DF_Label label);
343 static void UnRegisterGenObj(const std::string& theIOR, DF_Label label);
344 void setGenObjRegister(SALOMEDSImpl_AbstractCallback* theRegister);
346 friend class SALOMEDSImpl_GenericAttribute;
347 friend class SALOMEDSImpl_GenericVariable;