Version: 8.3.0
SALOMEDS_Study.hxx
Go to the documentation of this file.
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 : SALOMEDS_Study.hxx
24 // Author : Sergey RUIN
25 // Module : SALOME
26 //
27 #ifndef __SALOMEDS_STUDY_H__
28 #define __SALOMEDS_STUDY_H__
29 
30 #include <vector>
31 #include <string>
32 
33 #include "SALOMEDSClient.hxx"
34 #include "SALOMEDSImpl_Study.hxx"
35 
36 // IDL headers
37 #include <SALOMEconfig.h>
38 #include CORBA_SERVER_HEADER(SALOMEDS)
39 
40 class Standard_EXPORT SALOMEDS_Study: public SALOMEDSClient_Study
41 {
42 
43 private:
44  bool _isLocal;
45  SALOMEDSImpl_Study* _local_impl;
46  SALOMEDS::Study_var _corba_impl;
47  CORBA::ORB_var _orb;
48 
49 public:
50 
51  SALOMEDS_Study(SALOMEDSImpl_Study* theStudy);
52  SALOMEDS_Study(SALOMEDS::Study_ptr theStudy);
53  ~SALOMEDS_Study();
54 
55  virtual std::string GetPersistentReference();
56  virtual std::string GetTransientReference();
57  virtual bool IsEmpty();
58  virtual _PTR(SComponent) FindComponent (const std::string& aComponentName);
59  virtual _PTR(SComponent) FindComponentID(const std::string& aComponentID);
60  virtual _PTR(SObject) FindObject(const std::string& anObjectName);
61  virtual std::vector<_PTR(SObject)> FindObjectByName( const std::string& anObjectName, const std::string& aComponentName ) ;
62  virtual _PTR(SObject) FindObjectID(const std::string& anObjectID);
63  virtual _PTR(SObject) CreateObjectID(const std::string& anObjectID);
64  virtual _PTR(SObject) FindObjectIOR(const std::string& anObjectIOR);
65  virtual _PTR(SObject) FindObjectByPath(const std::string& thePath);
66  virtual std::string GetObjectPath(const _PTR(SObject)& theSO);
67  virtual void SetContext(const std::string& thePath);
68  virtual std::string GetContext();
69  virtual std::vector<std::string> GetObjectNames(const std::string& theContext);
70  virtual std::vector<std::string> GetDirectoryNames(const std::string& theContext);
71  virtual std::vector<std::string> GetFileNames(const std::string& theContext);
72  virtual std::vector<std::string> GetComponentNames(const std::string& theContext);
73  virtual _PTR(ChildIterator) NewChildIterator(const _PTR(SObject)& theSO);
74  virtual _PTR(SComponentIterator) NewComponentIterator();
75  virtual _PTR(StudyBuilder) NewBuilder();
76  virtual std::string Name();
77  virtual void Name(const std::string& name);
78  virtual bool IsSaved();
79  virtual void IsSaved(bool save);
80  virtual bool IsModified();
81  virtual void Modified();
82  virtual std::string URL();
83  virtual void URL(const std::string& url);
84  virtual int StudyId();
85  virtual void StudyId(int id);
86  virtual std::vector<_PTR(SObject)> FindDependances(const _PTR(SObject)& theSO);
87  virtual _PTR(AttributeStudyProperties) GetProperties();
88  virtual std::string GetLastModificationDate();
89  virtual std::vector<std::string> GetModificationsDate();
90  virtual _PTR(UseCaseBuilder) GetUseCaseBuilder();
91  virtual void Close();
92  virtual void EnableUseCaseAutoFilling(bool isEnabled);
93  virtual bool DumpStudy(const std::string& thePath,const std::string& theBaseName,bool isPublished,bool isMultiFile);
94  virtual _PTR(AttributeParameter) GetCommonParameters(const std::string& theID, int theSavePoint);
95  virtual _PTR(AttributeParameter) GetModuleParameters(const std::string& theID,
96  const std::string& theModuleName, int theSavePoint);
97  virtual void SetStudyLock(const std::string& theLockerID);
98  virtual bool IsStudyLocked();
99  virtual void UnLockStudy(const std::string& theLockerID);
100  virtual std::vector<std::string> GetLockerID();
101 
102  virtual void SetReal(const std::string& theVarName, const double theValue);
103  virtual void SetInteger(const std::string& theVarName, const int theValue);
104  virtual void SetBoolean(const std::string& theVarName, const bool theValue);
105  virtual void SetString(const std::string& theVarName, const std::string& theValue);
106  virtual void SetStringAsDouble(const std::string& theVarName, const double theValue);
107 
108  virtual double GetReal(const std::string& theVarName);
109  virtual int GetInteger(const std::string& theVarName);
110  virtual bool GetBoolean(const std::string& theVarName);
111  virtual std::string GetString(const std::string& theVarName);
112 
113  virtual bool IsReal(const std::string& theVarName);
114  virtual bool IsInteger(const std::string& theVarName);
115  virtual bool IsBoolean(const std::string& theVarName);
116  virtual bool IsString(const std::string& theVarName);
117 
118  virtual bool IsVariable(const std::string& theVarName);
119  virtual std::vector<std::string> GetVariableNames();
120 
121  virtual bool RemoveVariable(const std::string& theVarName);
122  virtual bool RenameVariable(const std::string& theVarName, const std::string& theNewVarName);
123  virtual bool IsVariableUsed(const std::string& theVarName);
124  virtual std::vector< std::vector<std::string> > ParseVariables(const std::string& theVars);
125  virtual void attach(SALOMEDS::Observer_ptr theObserver,bool modify);
126  virtual void detach(SALOMEDS::Observer_ptr theObserver);
127 
128  std::string ConvertObjectToIOR(CORBA::Object_ptr theObject);
129  CORBA::Object_ptr ConvertIORToObject(const std::string& theIOR);
130 
131  SALOMEDS::Study_ptr GetStudy();
132 
133  SALOMEDSImpl_Study* GetLocalImpl() { return _local_impl; }
134 
135 private:
136  void init_orb();
137 
138 };
139 #endif