src/SALOMEDSClient/SALOMEDSClient_Study.hxx

   1 // Copyright (C) 2007-2024  CEA, EDF, 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   : SALOMEDSClient_Study.hxx
  24 //  Author : Sergey RUIN
  25 //  Module : SALOME
  26 //
  27 #ifndef __SALOMEDSClient_STUDY_H__
  28 #define __SALOMEDSClient_STUDY_H__
  29
  30 #include <vector>
  31 #include <string>
  32
  33 #include "SALOMEDSClient_definitions.hxx"
  34 #include "SALOMEDSClient_SComponentIterator.hxx"
  35 #include "SALOMEDSClient_StudyBuilder.hxx"
  36 #include "SALOMEDSClient_AttributeParameter.hxx"
  37 #include "SALOMEDSClient_SObject.hxx"
  38 #include "SALOMEDSClient_SComponent.hxx"
  39 #include "SALOMEDSClient_UseCaseBuilder.hxx"
  40 #include "SALOMEDSClient_AttributeStudyProperties.hxx"
  41 #include "SALOMEDSClient_ChildIterator.hxx"
  42 #include "SALOMEDSClient_Observer.hxx"
  43 #include <SALOMEconfig.h>
  44 #include CORBA_CLIENT_HEADER(SALOMEDS)
  45
  46 class SALOMEDSClient_Study
  47 {
  48
  49 public:
  50   virtual ~SALOMEDSClient_Study() {}
  51
  52   virtual void Init() = 0;
  53   virtual void Clear() = 0;
  54
  55   virtual bool Open(const std::string& theStudyUrl) = 0;
  56   virtual bool CanOpen(const std::string& theStudyUrl) = 0;
  57
  58   virtual std::string GetPersistentReference() = 0;
  59   virtual bool IsEmpty() = 0;
  60   virtual _PTR(SComponent) FindComponent (const std::string& aComponentName) = 0;
  61   virtual _PTR(SComponent) FindComponentID(const std::string& aComponentID) = 0;
  62   virtual _PTR(SObject) FindObject(const std::string& anObjectName) = 0;
  63   virtual std::vector<_PTR(SObject)> FindObjectByName( const std::string& anObjectName, const std::string& aComponentName ) = 0;
  64   virtual _PTR(SObject) FindObjectID(const std::string& anObjectID) = 0;
  65   virtual _PTR(SObject) CreateObjectID(const std::string& anObjectID) = 0;
  66   virtual _PTR(SObject) FindObjectIOR(const std::string& anObjectIOR) = 0;
  67   virtual _PTR(SObject) FindObjectByPath(const std::string& thePath) = 0;
  68   virtual std::string GetObjectPath(const _PTR(SObject)& theSO) = 0;
  69   virtual _PTR(ChildIterator) NewChildIterator(const _PTR(SObject)& theSO) = 0;
  70   virtual _PTR(SComponentIterator) NewComponentIterator() = 0;
  71   virtual _PTR(StudyBuilder) NewBuilder() = 0;
  72   virtual std::string Name() = 0;
  73   virtual bool IsSaved() = 0;
  74   virtual void  IsSaved(bool save) = 0;
  75   virtual bool IsModified() = 0;
  76   virtual void Modified() = 0;
  77   virtual std::string URL() = 0;
  78   virtual void  URL(const std::string& url) = 0;
  79   virtual std::vector<_PTR(SObject)> FindDependances(const _PTR(SObject)& theSO) = 0;
  80   virtual _PTR(AttributeStudyProperties) GetProperties() = 0;
  81   virtual std::string GetLastModificationDate() = 0;
  82   virtual std::vector<std::string> GetModificationsDate() = 0;
  83   virtual _PTR(UseCaseBuilder) GetUseCaseBuilder() = 0;
  84
  85   virtual bool Save(bool theMultiFile, bool theASCII) = 0;
  86   virtual bool SaveAs(const std::string& theUrl, bool theMultiFile, bool theASCII) = 0;
  87
  88   virtual bool CanCopy(const _PTR(SObject)& theSO) = 0;
  89   virtual bool Copy(const _PTR(SObject)& theSO) = 0;
  90   virtual bool CanPaste(const _PTR(SObject)& theSO) = 0;
  91   virtual _PTR(SObject) Paste(const _PTR(SObject)& theSO) = 0;
  92
  93   virtual void EnableUseCaseAutoFilling(bool isEnabled) = 0;
  94   virtual bool DumpStudy(const std::string& thePath,
  95                          const std::string& theBaseName,
  96                          bool isPublished,
  97                          bool isMultiFile) = 0;
  98   virtual _PTR(AttributeParameter) GetCommonParameters(const std::string& theID, int theSavePoint) = 0;
  99   virtual _PTR(AttributeParameter) GetModuleParameters(const std::string& theID,
 100                                                        const std::string& theModuleName, int theSavePoint) = 0;
 101   virtual void SetStudyLock(const std::string& theLockerID) = 0;
 102   virtual bool IsStudyLocked() = 0;
 103   virtual void UnLockStudy(const std::string& theLockerID) = 0;
 104   virtual std::vector<std::string> GetLockerID() = 0;
 105
 106   virtual void SetReal(const std::string& theVarName, const double theValue) = 0;
 107   virtual void SetInteger(const std::string& theVarName, const int theValue) = 0;
 108   virtual void SetBoolean(const std::string& theVarName, const bool theValue) = 0;
 109   virtual void SetString(const std::string& theVarName, const std::string& theValue) = 0;
 110   virtual void SetStringAsDouble(const std::string& theVarName, const double theValue) = 0;
 111
 112   virtual double GetReal(const std::string& theVarName) = 0;
 113   virtual int GetInteger(const std::string& theVarName) = 0;
 114   virtual bool GetBoolean(const std::string& theVarName) = 0;
 115   virtual std::string GetString(const std::string& theVarName) = 0;
 116
 117   virtual bool IsReal(const std::string& theVarName) = 0;
 118   virtual bool IsInteger(const std::string& theVarName) = 0;
 119   virtual bool IsBoolean(const std::string& theVarName) = 0;
 120   virtual bool IsString(const std::string& theVarName) = 0;
 121
 122   virtual bool IsVariable(const std::string& theVarName) = 0;
 123   virtual std::vector<std::string> GetVariableNames() = 0;
 124
 125   virtual bool RemoveVariable(const std::string& theVarName) = 0;
 126   virtual bool RenameVariable(const std::string& theVarName,
 127                               const std::string& theNewVarName) = 0;
 128   virtual bool IsVariableUsed(const std::string& theVarName) = 0;
 129
 130   virtual std::vector< std::vector<std::string> > ParseVariables(const std::string& theVars) = 0;
 131
 132   virtual void attach(SALOMEDS::Observer_ptr theObserver,bool modify) = 0;
 133   virtual void detach(SALOMEDS::Observer_ptr theObserver) = 0;
 134 };
 135
 136
 137 #endif