1 // Copyright (C) 2007-2014 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"
54 class SALOMEDSImpl_StudyManager;
55 class SALOMEDSImpl_GenericAttribute;
58 class SALOMEDSIMPL_EXPORT SALOMEDSImpl_Study
62 DF_Document* _doc; // Document
63 bool _Saved; // True if the Study is saved
64 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;
76 std::map<std::string, SALOMEDSImpl_SObject> _mapOfSO;
77 std::map<std::string, SALOMEDSImpl_SComponent> _mapOfSCO;
78 std::map<std::string, DF_Label> myIORLabels;
79 std::vector<SALOMEDSImpl_GenericVariable*> myNoteBookVars;
81 SALOMEDSImpl_SObject _FindObject(const SALOMEDSImpl_SObject& SO,
82 const std::string& anObjectName,
85 SALOMEDSImpl_SObject _FindObjectIOR(const SALOMEDSImpl_SObject& SO,
86 const std::string& anObjectIOR,
89 std::string _GetStudyVariablesScript();
90 std::string _GetNoteBookAccessor();
91 std::string _GetNoteBookAccess(const std::string& theStudyVar);
95 static SALOMEDSImpl_Study* GetStudy(const DF_Label& theLabel);
96 static SALOMEDSImpl_SObject SObject(const DF_Label& theLabel);
97 static SALOMEDSImpl_SComponent SComponent(const DF_Label& theLabel);
98 static void IORUpdated(const SALOMEDSImpl_AttributeIOR* theAttribute);
100 //! standard constructor
101 SALOMEDSImpl_Study(const DF_Document*, const std::string& study_name);
103 //! standard destructor
104 virtual ~SALOMEDSImpl_Study();
106 //! method to Get persistent reference of study (idem URL())
107 virtual std::string GetPersistentReference();
109 //! method to Get transient reference of study
110 virtual std::string GetTransientReference();
112 virtual void SetTransientReference(const std::string& theIOR);
114 //! method to detect if a study is empty
115 virtual bool IsEmpty();
117 //! method to Find a Component with ComponentDataType = aComponentName
118 virtual SALOMEDSImpl_SComponent FindComponent (const std::string& aComponentName);
120 //! method to Find a Component Find a Component from it's ID
121 virtual SALOMEDSImpl_SComponent FindComponentID(const std::string& aComponentID);
123 //! method to Find an Object with SALOMEDSImpl::Name = anObjectName
124 virtual SALOMEDSImpl_SObject FindObject(const std::string& anObjectName);
127 //! method to Find Object(s) with SALOMEDSImpl::Name=anObjectName in a component with ComponentDataType = aComponentName
128 virtual std::vector<SALOMEDSImpl_SObject> FindObjectByName( const std::string& anObjectName,
129 const std::string& aComponentName ) ;
131 //! method to Find an Object with ID = anObjectID
132 virtual SALOMEDSImpl_SObject FindObjectID(const std::string& anObjectID);
134 //! method to Create an Object with ID = anObjectID
135 virtual SALOMEDSImpl_SObject CreateObjectID(const std::string& anObjectID);
137 //! method to Find an Object with ID = anObjectIOR
138 virtual SALOMEDSImpl_SObject FindObjectIOR(const std::string& anObjectIOR);
140 //! method to Find an Object by its path
141 virtual SALOMEDSImpl_SObject FindObjectByPath(const std::string& thePath);
143 //! method to get a path of SObject
144 virtual std::string GetObjectPath(const SALOMEDSImpl_SObject& theObject);
146 std::string GetObjectPathByIOR(const std::string& theIOR);
148 //! method to set a context: root ('/') is UserData component
149 virtual bool SetContext(const std::string& thePath);
151 //! method to get a context
152 virtual std::string GetContext();
154 //! method to get all object names in the given context (or in the current context, if 'theContext' is empty)
155 virtual std::vector<std::string> GetObjectNames(const std::string& theContext);
157 //! method to get all directory names in the given context (or in the current context, if 'theContext' is empty)
158 virtual std::vector<std::string> GetDirectoryNames(const std::string& theContext);
160 //! method to get all file names in the given context (or in the current context, if 'theContext' is empty)
161 virtual std::vector<std::string> GetFileNames(const std::string& theContext);
163 //! method to get all components names
164 virtual std::vector<std::string> GetComponentNames(const std::string& theContext);
166 //! method to Create a ChildIterator from an SObject
167 virtual SALOMEDSImpl_ChildIterator NewChildIterator(const SALOMEDSImpl_SObject& aSO);
169 //! method to Create a SComponentIterator
170 virtual SALOMEDSImpl_SComponentIterator NewComponentIterator();
172 //! method to Create a StudyBuilder
173 virtual SALOMEDSImpl_StudyBuilder* NewBuilder();
175 //! method to get study name
176 virtual std::string Name();
178 //! method to set study name
179 virtual void Name(const std::string& name);
181 //! method to get if study has been saved
182 virtual bool IsSaved();
184 //! method to set if study has been saved
185 virtual void IsSaved(bool save);
187 //! method to Detect if a Study has been modified since it has been saved
188 virtual bool IsModified();
190 //! method to get URL of the study (idem GetPersistentReference)
191 virtual std::string URL();
193 //! method to set URL of the study
194 virtual void URL(const std::string& url);
196 virtual bool IsLocked();
198 virtual int StudyId();
200 virtual void StudyId(int id);
202 virtual void DeleteIORLabelMapItem(const std::string& anIOR);
203 virtual void UpdateIORLabelMap(const std::string& anIOR, const std::string& aLabel);
205 virtual std::vector<SALOMEDSImpl_SObject> FindDependances(const SALOMEDSImpl_SObject& anObject);
207 virtual SALOMEDSImpl_AttributeStudyProperties* GetProperties();
209 virtual std::string GetLastModificationDate();
211 virtual std::vector<std::string> GetModificationsDate();
213 virtual SALOMEDSImpl_UseCaseBuilder* GetUseCaseBuilder();
215 virtual void Close();
217 void EnableUseCaseAutoFilling(bool isEnabled);
219 virtual std::string GetErrorCode() { return _errorCode; }
220 virtual bool IsError() { return _errorCode != ""; }
222 virtual SALOMEDSImpl_SComponent GetSComponent(const std::string& theEntry);
223 virtual SALOMEDSImpl_SComponent GetSComponent(const DF_Label& theLabel);
224 virtual SALOMEDSImpl_SObject GetSObject(const std::string& theEntry);
225 virtual SALOMEDSImpl_SObject GetSObject(const DF_Label& theEntryLabel);
226 virtual DF_Attribute* GetAttribute(const std::string& theEntry,
227 const std::string& theType);
229 virtual bool HasCurrentContext() { return !_current.IsNull(); }
231 virtual bool DumpStudy(const std::string& thePath,
232 const std::string& theBaseName,
235 SALOMEDSImpl_DriverFactory* theFactory);
237 static std::string GetDumpStudyComment(const char* theComponentName = 0);
239 virtual DF_Document* GetDocument() { return _doc; }
241 //The method dump creates a txt file that contain a dump of the study, for debug use
242 void dump(const std::string& theFileName);
244 //This method marks the study as being modified
247 SALOMEDSImpl_AttributeParameter* GetCommonParameters(const char* theID, int theSavePoint);
249 SALOMEDSImpl_AttributeParameter* GetModuleParameters(const char* theID,
250 const char* theModuleName,
253 //Locks the study, theLockerID is identificator of the of the one who locked the study for ex. IOR
254 void SetStudyLock(const char* theLockerID);
256 //Returns True if the study is locked
257 bool IsStudyLocked();
260 void UnLockStudy(const char* theLockerID);
262 //Returns an ID of the study locker
263 std::vector<std::string> GetLockerID();
265 //Managing of variables
266 void SetVariable(const std::string& theVarName,
267 const double theValue,
268 const SALOMEDSImpl_GenericVariable::VariableTypes);
270 void SetStringVariable(const std::string& theVarName,
271 const std::string& theValue,
272 const SALOMEDSImpl_GenericVariable::VariableTypes);
274 void SetStringVariableAsDouble(const std::string& theVarName,
275 const double theValue,
276 const SALOMEDSImpl_GenericVariable::VariableTypes);
278 double GetVariableValue(const std::string& theVarName);
280 std::string GetStringVariableValue(const std::string& theVarName);
282 bool IsTypeOf(const std::string& theVarName,
283 SALOMEDSImpl_GenericVariable::VariableTypes theType) const;
285 bool IsVariable(const std::string& theVarName) const;
288 std::vector<std::string> GetVariableNames() const;
290 void AddVariable(SALOMEDSImpl_GenericVariable* theVariable);
292 SALOMEDSImpl_GenericVariable* GetVariable(const std::string& theName) const;
294 bool RemoveVariable(const std::string& theVarName);
296 bool RenameVariable(const std::string& theVarName, const std::string& theNewVarName);
298 bool IsVariableUsed(const std::string& theVarName);
300 bool FindVariableAttribute(SALOMEDSImpl_StudyBuilder* theStudyBuilder,
301 SALOMEDSImpl_SObject theSObject,
302 const std::string& theName);
303 bool FindVariableAttribute(const std::string& theName);
305 void ReplaceVariableAttribute(SALOMEDSImpl_StudyBuilder* theStudyBuilder,
306 SALOMEDSImpl_SObject theSObject,
307 const std::string& theSource,
308 const std::string& theDest);
309 void ReplaceVariableAttribute(const std::string& theSource, const std::string& theDest);
311 std::vector< std::vector<std::string> > ParseVariables(const std::string& theVariables) const;
314 SALOMEDSImpl_Callback* GetCallback() { return _cb; }
316 //Returns a list of IOR's stored in the study
317 std::vector<std::string> GetIORs();
319 // Notification mechanism
320 virtual bool addSO_Notification(const SALOMEDSImpl_SObject& theSObject);
321 virtual bool removeSO_Notification(const SALOMEDSImpl_SObject& theSObject);
322 virtual bool modifySO_Notification(const SALOMEDSImpl_SObject& theSObject, int reason);
323 virtual void setNotifier(SALOMEDSImpl_AbstractCallback* notifier);
325 static void RegisterGenObj (const std::string& theIOR, DF_Label label);
326 static void UnRegisterGenObj(const std::string& theIOR, DF_Label label);
327 void setGenObjRegister(SALOMEDSImpl_AbstractCallback* theRegister);
329 friend class SALOMEDSImpl_StudyManager;
330 friend class SALOMEDSImpl_GenericAttribute;
331 friend class SALOMEDSImpl_GenericVariable;