src/SALOMEDSClient/SALOMEDSClient_Study.hxx

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 //
  20 //  File   : SALOMEDSClient_Study.hxx
  21 //  Author : Sergey RUIN
  22 //  Module : SALOME
  23
  24 #ifndef __SALOMEDSClient_STUDY_H__
  25 #define __SALOMEDSClient_STUDY_H__
  26
  27 #include <vector>
  28 #include <string>
  29
  30 #include "SALOMEDSClient_definitions.hxx"
  31 #include "SALOMEDSClient_SComponentIterator.hxx"
  32 #include "SALOMEDSClient_StudyBuilder.hxx"
  33 #include "SALOMEDSClient_AttributeParameter.hxx"
  34 #include "SALOMEDSClient_SObject.hxx"
  35 #include "SALOMEDSClient_SComponent.hxx"
  36 #include "SALOMEDSClient_UseCaseBuilder.hxx"
  37 #include "SALOMEDSClient_AttributeStudyProperties.hxx"
  38 #include "SALOMEDSClient_ChildIterator.hxx"
  39
  40 class SALOMEDSClient_Study
  41 {
  42
  43 public:
  44   virtual ~SALOMEDSClient_Study() {}
  45
  46   virtual std::string GetPersistentReference() = 0;
  47   virtual std::string GetTransientReference() = 0;
  48   virtual bool IsEmpty() = 0;
  49   virtual _PTR(SComponent) FindComponent (const std::string& aComponentName) = 0;
  50   virtual _PTR(SComponent) FindComponentID(const std::string& aComponentID) = 0;
  51   virtual _PTR(SObject) FindObject(const std::string& anObjectName) = 0;
  52   virtual std::vector<_PTR(SObject)> FindObjectByName( const std::string& anObjectName, const std::string& aComponentName ) = 0;
  53   virtual _PTR(SObject) FindObjectID(const std::string& anObjectID) = 0;
  54   virtual _PTR(SObject) CreateObjectID(const std::string& anObjectID) = 0;
  55   virtual _PTR(SObject) FindObjectIOR(const std::string& anObjectIOR) = 0;
  56   virtual _PTR(SObject) FindObjectByPath(const std::string& thePath) = 0;
  57   virtual std::string GetObjectPath(const _PTR(SObject)& theSO) = 0;
  58   virtual void SetContext(const std::string& thePath) = 0;
  59   virtual std::string GetContext() = 0;
  60   virtual std::vector<std::string> GetObjectNames(const std::string& theContext) = 0;
  61   virtual std::vector<std::string> GetDirectoryNames(const std::string& theContext) = 0;
  62   virtual std::vector<std::string> GetFileNames(const std::string& theContext) = 0;
  63   virtual std::vector<std::string> GetComponentNames(const std::string& theContext) = 0;
  64   virtual _PTR(ChildIterator) NewChildIterator(const _PTR(SObject)& theSO) = 0;
  65   virtual _PTR(SComponentIterator) NewComponentIterator() = 0;
  66   virtual _PTR(StudyBuilder) NewBuilder() = 0;
  67   virtual std::string Name() = 0;
  68   virtual void  Name(const std::string& name) = 0;
  69   virtual bool IsSaved() = 0;
  70   virtual void  IsSaved(bool save) = 0;
  71   virtual bool IsModified() = 0;
  72   virtual void Modified() = 0;
  73   virtual std::string URL() = 0;
  74   virtual void  URL(const std::string& url) = 0;
  75   virtual int StudyId() = 0;
  76   virtual void  StudyId(int id) = 0;
  77   virtual std::vector<_PTR(SObject)> FindDependances(const _PTR(SObject)& theSO) = 0;
  78   virtual _PTR(AttributeStudyProperties) GetProperties() = 0;
  79   virtual std::string GetLastModificationDate() = 0;
  80   virtual std::vector<std::string> GetModificationsDate() = 0;
  81   virtual _PTR(UseCaseBuilder) GetUseCaseBuilder() = 0;
  82   virtual void Close() = 0;
  83   virtual void EnableUseCaseAutoFilling(bool isEnabled) = 0;
  84   virtual bool DumpStudy(const std::string& thePath,
  85                          const std::string& theBaseName,
  86                          bool isPublished) = 0;
  87   virtual _PTR(AttributeParameter) GetCommonParameters(const std::string& theID, int theSavePoint) = 0;
  88   virtual _PTR(AttributeParameter) GetModuleParameters(const std::string& theID,
  89                                                        const std::string& theModuleName, int theSavePoint) = 0;
  90   virtual void SetStudyLock(const std::string& theLockerID) = 0;
  91   virtual bool IsStudyLocked() = 0;
  92   virtual void UnLockStudy(const std::string& theLockerID) = 0;
  93   virtual std::vector<std::string> GetLockerID() = 0;
  94 };
  95
  96
  97 #endif