src/SALOMEDSImpl/SALOMEDSImpl_Study.hxx

   1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File   : SALOMEDSImpl_Study.hxx
  24 //  Author : Sergey RUIN
  25 //  Module : SALOME
  26 //
  27 #ifndef __SALOMEDSIMPL_STUDY_I_H__
  28 #define __SALOMEDSIMPL_STUDY_I_H__
  29
  30 // std C++ headers
  31 #include <iostream>
  32 #include <string>
  33 #include <vector>
  34 #include <map>
  35
  36 #include "DF_Document.hxx"
  37 #include "DF_Label.hxx"
  38 #include <stdio.h>
  39
  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"
  53
  54 class HDFgroup;
  55 class SALOMEDSImpl_GenericAttribute;
  56
  57
  58 class SALOMEDSIMPL_EXPORT SALOMEDSImpl_Study
  59 {
  60 private:
  61   std::string              _name;
  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
  67   bool                     _autoFill;
  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
  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;
  80
  81   SALOMEDSImpl_SObject   _FindObject(const SALOMEDSImpl_SObject& SO,
  82     const std::string& anObjectName,
  83     bool& _find);
  84
  85   SALOMEDSImpl_SObject   _FindObjectIOR(const SALOMEDSImpl_SObject& SO,
  86     const std::string& anObjectIOR,
  87     bool& _find);
  88
  89   std::string _GetStudyVariablesScript();
  90   std::string _GetNoteBookAccessor();
  91   std::string _GetNoteBookAccess();
  92
  93 public:
  94
  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);
  99
 100    //! standard constructor
 101    SALOMEDSImpl_Study();
 102
 103   //! standard destructor
 104   virtual ~SALOMEDSImpl_Study();
 105
 106   virtual void Init();
 107   virtual void Clear();
 108
 109   //! method to Open a Study from it's persistent reference
 110   virtual bool Open(const std::string& aStudyUrl);
 111
 112   //! method to save a Study
 113   virtual bool Save(SALOMEDSImpl_DriverFactory* aFactory,
 114                     bool theMultiFile,
 115                     bool theASCII);
 116
 117   //! method to save a Study to the persistent reference aUrl
 118   virtual bool SaveAs(const std::string& aUrl,
 119                       SALOMEDSImpl_DriverFactory* aFactory,
 120                       bool theMultiFile,
 121                       bool theASCII);
 122
 123   bool CopyLabel(SALOMEDSImpl_Driver* theEngine,
 124                  const int theSourceStartDepth,
 125                  const DF_Label& theSource,
 126                  const DF_Label& theDestinationMain);
 127
 128   DF_Label PasteLabel(SALOMEDSImpl_Driver* theEngine,
 129                       const DF_Label& theSource,
 130                       const DF_Label& theDestinationStart,
 131                       const bool isFirstElement);
 132
 133   virtual bool CanCopy(const SALOMEDSImpl_SObject& theObject, SALOMEDSImpl_Driver* Engine);
 134   virtual bool Copy(const SALOMEDSImpl_SObject& theObject, SALOMEDSImpl_Driver* Engine);
 135   virtual bool CanPaste(const SALOMEDSImpl_SObject& theObject, SALOMEDSImpl_Driver* Engine);
 136   virtual SALOMEDSImpl_SObject Paste(const SALOMEDSImpl_SObject& theObject, SALOMEDSImpl_Driver* Engine);
 137
 138   // _SaveAs private function called by Save and SaveAs
 139   virtual bool Impl_SaveAs(const std::string& aUrl,
 140                            SALOMEDSImpl_DriverFactory* aFactory,
 141                            bool theMultiFile,
 142                            bool theASCII);
 143
 144   // _SaveObject private function called by _SaveAs
 145   virtual bool Impl_SaveObject(const SALOMEDSImpl_SObject& SC, HDFgroup *hdf_group_datatype);
 146
 147   virtual bool Impl_SaveProperties(HDFgroup *hdf_group);
 148
 149
 150   //! method to Get persistent reference of study (idem URL())
 151   virtual std::string GetPersistentReference();
 152
 153   //! method to Get transient reference of study
 154   virtual std::string GetTransientReference();
 155
 156   virtual void SetTransientReference(const std::string& theIOR);
 157
 158   //! method to detect if a study is empty
 159   virtual bool IsEmpty();
 160
 161   //! method to Find a Component with ComponentDataType = aComponentName
 162   virtual SALOMEDSImpl_SComponent FindComponent (const std::string& aComponentName);
 163
 164   //! method to Find a Component Find a Component from it's ID
 165   virtual SALOMEDSImpl_SComponent FindComponentID(const std::string& aComponentID);
 166
 167   //! method to  Find an Object with SALOMEDSImpl::Name = anObjectName
 168   virtual SALOMEDSImpl_SObject FindObject(const std::string& anObjectName);
 169
 170
 171   //! method to Find Object(s) with SALOMEDSImpl::Name=anObjectName in a component with ComponentDataType = aComponentName
 172   virtual std::vector<SALOMEDSImpl_SObject> FindObjectByName( const std::string& anObjectName,
 173                                                                        const std::string& aComponentName ) ;
 174
 175   //! method to Find an Object with ID = anObjectID
 176   virtual SALOMEDSImpl_SObject FindObjectID(const std::string& anObjectID);
 177
 178   //! method to Create an Object with ID = anObjectID
 179   virtual SALOMEDSImpl_SObject CreateObjectID(const std::string& anObjectID);
 180
 181   //! method to Find an Object with ID = anObjectIOR
 182   virtual SALOMEDSImpl_SObject FindObjectIOR(const std::string& anObjectIOR);
 183
 184   //! method to Find an Object by its path
 185   virtual SALOMEDSImpl_SObject FindObjectByPath(const std::string& thePath);
 186
 187   //! method to get a path of SObject
 188   virtual std::string GetObjectPath(const SALOMEDSImpl_SObject& theObject);
 189
 190   std::string GetObjectPathByIOR(const std::string& theIOR);
 191
 192   //! method to Create a ChildIterator from an SObject
 193   virtual SALOMEDSImpl_ChildIterator NewChildIterator(const SALOMEDSImpl_SObject& aSO);
 194
 195   //! method to Create a SComponentIterator
 196   virtual SALOMEDSImpl_SComponentIterator NewComponentIterator();
 197
 198   //! method to Create a StudyBuilder
 199   virtual SALOMEDSImpl_StudyBuilder* NewBuilder();
 200
 201   //! method to get study name
 202   virtual std::string Name();
 203
 204   //! method to get if study has been saved
 205   virtual bool IsSaved();
 206
 207   //! method to set if study has been saved
 208   virtual void  IsSaved(bool save);
 209
 210   //! method to Detect if a Study has been modified since it has been saved
 211   virtual bool IsModified();
 212
 213   //! method to get URL of the study (idem GetPersistentReference)
 214   virtual std::string URL();
 215
 216   //! method to set URL of the study
 217   virtual void  URL(const std::string& url);
 218
 219   virtual bool IsLocked();
 220
 221   virtual void DeleteIORLabelMapItem(const std::string& anIOR);
 222   virtual void UpdateIORLabelMap(const std::string& anIOR, const std::string& aLabel);
 223
 224   virtual std::vector<SALOMEDSImpl_SObject> FindDependances(const SALOMEDSImpl_SObject& anObject);
 225
 226   virtual SALOMEDSImpl_AttributeStudyProperties* GetProperties();
 227
 228   virtual std::string GetLastModificationDate();
 229
 230   virtual std::vector<std::string> GetModificationsDate();
 231
 232   virtual SALOMEDSImpl_UseCaseBuilder* GetUseCaseBuilder();
 233
 234   void EnableUseCaseAutoFilling(bool isEnabled);
 235
 236   virtual std::string GetErrorCode() { return _errorCode; }
 237   virtual bool IsError() { return _errorCode != ""; }
 238
 239   virtual SALOMEDSImpl_SComponent GetSComponent(const std::string& theEntry);
 240   virtual SALOMEDSImpl_SComponent GetSComponent(const DF_Label& theLabel);
 241   virtual SALOMEDSImpl_SObject GetSObject(const std::string& theEntry);
 242   virtual SALOMEDSImpl_SObject GetSObject(const DF_Label& theEntryLabel);
 243   virtual DF_Attribute* GetAttribute(const std::string& theEntry,
 244                                                      const std::string& theType);
 245
 246   virtual bool DumpStudy(const std::string& thePath,
 247                          const std::string& theBaseName,
 248                          bool isPublished,
 249                          bool isMultiFile,
 250                          SALOMEDSImpl_DriverFactory* theFactory);
 251
 252   static std::string GetDumpStudyComment(const char* theComponentName = 0);
 253
 254   virtual DF_Document* GetDocument() { return _doc; }
 255
 256   //The method dump creates a txt file that contain a dump of the study, for debug use
 257   void dump(const std::string& theFileName);
 258
 259   //This method marks the study as being modified
 260   void Modify();
 261
 262   SALOMEDSImpl_AttributeParameter* GetCommonParameters(const char* theID, int theSavePoint);
 263
 264   SALOMEDSImpl_AttributeParameter* GetModuleParameters(const char* theID,
 265                                                                               const char* theModuleName,
 266                                                                               int theSavePoint);
 267
 268   //Locks the study, theLockerID is identificator of the of the one who locked the study for ex. IOR
 269   void SetStudyLock(const char* theLockerID);
 270
 271   //Returns True if the study is locked
 272   bool IsStudyLocked();
 273
 274   //Unlocks the study
 275   void UnLockStudy(const char* theLockerID);
 276
 277   //Returns an ID of the study locker
 278   std::vector<std::string> GetLockerID();
 279
 280   //Managing of variables
 281   void SetVariable(const std::string& theVarName,
 282                    const double theValue,
 283                    const SALOMEDSImpl_GenericVariable::VariableTypes);
 284
 285   void SetStringVariable(const std::string& theVarName,
 286                          const std::string& theValue,
 287                          const SALOMEDSImpl_GenericVariable::VariableTypes);
 288
 289   void SetStringVariableAsDouble(const std::string& theVarName,
 290                                  const double theValue,
 291                                  const SALOMEDSImpl_GenericVariable::VariableTypes);
 292
 293   double GetVariableValue(const std::string& theVarName);
 294
 295   std::string GetStringVariableValue(const std::string& theVarName);
 296
 297   bool IsTypeOf(const std::string& theVarName,
 298                 SALOMEDSImpl_GenericVariable::VariableTypes theType) const;
 299
 300   bool IsVariable(const std::string& theVarName) const;
 301
 302
 303   std::vector<std::string> GetVariableNames() const;
 304
 305   void AddVariable(SALOMEDSImpl_GenericVariable* theVariable);
 306
 307   SALOMEDSImpl_GenericVariable* GetVariable(const std::string& theName) const;
 308
 309   bool RemoveVariable(const std::string& theVarName);
 310
 311   bool RenameVariable(const std::string& theVarName, const std::string& theNewVarName);
 312
 313   bool IsVariableUsed(const std::string& theVarName);
 314
 315   bool FindVariableAttribute(SALOMEDSImpl_StudyBuilder* theStudyBuilder,
 316                              SALOMEDSImpl_SObject theSObject,
 317                              const std::string& theName);
 318   bool FindVariableAttribute(const std::string& theName);
 319
 320   void ReplaceVariableAttribute(SALOMEDSImpl_StudyBuilder* theStudyBuilder,
 321                                 SALOMEDSImpl_SObject theSObject,
 322                                 const std::string& theSource,
 323                                 const std::string& theDest);
 324   void ReplaceVariableAttribute(const std::string& theSource, const std::string& theDest);
 325
 326   std::vector< std::vector<std::string> > ParseVariables(const std::string& theVariables) const;
 327
 328   //Returns a callback
 329   SALOMEDSImpl_Callback* GetCallback() { return _cb; }
 330
 331   //Returns a list of IOR's stored in the study
 332   std::vector<std::string> GetIORs();
 333
 334   // Notification mechanism
 335   virtual bool addSO_Notification(const SALOMEDSImpl_SObject& theSObject);
 336   virtual bool removeSO_Notification(const SALOMEDSImpl_SObject& theSObject);
 337   virtual bool modifySO_Notification(const SALOMEDSImpl_SObject& theSObject, int reason);
 338   virtual void setNotifier(SALOMEDSImpl_AbstractCallback* notifier);
 339
 340   static void RegisterGenObj  (const std::string& theIOR, DF_Label label);
 341   static void UnRegisterGenObj(const std::string& theIOR, DF_Label label);
 342   void setGenObjRegister(SALOMEDSImpl_AbstractCallback* theRegister);
 343
 344   friend class SALOMEDSImpl_GenericAttribute;
 345   friend class SALOMEDSImpl_GenericVariable;
 346 };
 347 #endif