1 // Copyright (C) 2007-2016 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 : SALOMEDS_Study.hxx
24 // Author : Sergey RUIN
27 #ifndef __SALOMEDS_STUDY_H__
28 #define __SALOMEDS_STUDY_H__
33 #include "SALOMEDSClient.hxx"
34 #include "SALOMEDSImpl_Study.hxx"
37 #include <SALOMEconfig.h>
38 #include CORBA_SERVER_HEADER(SALOMEDS)
40 class Standard_EXPORT SALOMEDS_Study: public SALOMEDSClient_Study
45 SALOMEDSImpl_Study* _local_impl;
46 SALOMEDS::Study_var _corba_impl;
51 SALOMEDS_Study(SALOMEDSImpl_Study* theStudy);
52 SALOMEDS_Study(SALOMEDS::Study_ptr theStudy);
57 virtual bool Open(const std::string& theStudyUrl);
59 virtual bool Save(bool theMultiFile);
60 virtual bool SaveASCII(bool theMultiFile);
61 virtual bool SaveAs(const std::string& theUrl, bool theMultiFile);
62 virtual bool SaveAsASCII(const std::string& theUrl, bool theMultiFile);
64 virtual bool CanCopy(const _PTR(SObject)& theSO);
65 virtual bool Copy(const _PTR(SObject)& theSO);
66 virtual bool CanPaste(const _PTR(SObject)& theSO);
67 virtual _PTR(SObject) Paste(const _PTR(SObject)& theSO);
69 virtual std::string GetPersistentReference();
70 virtual std::string GetTransientReference();
71 virtual bool IsEmpty();
72 virtual _PTR(SComponent) FindComponent (const std::string& aComponentName);
73 virtual _PTR(SComponent) FindComponentID(const std::string& aComponentID);
74 virtual _PTR(SObject) FindObject(const std::string& anObjectName);
75 virtual std::vector<_PTR(SObject)> FindObjectByName( const std::string& anObjectName, const std::string& aComponentName ) ;
76 virtual _PTR(SObject) FindObjectID(const std::string& anObjectID);
77 virtual _PTR(SObject) CreateObjectID(const std::string& anObjectID);
78 virtual _PTR(SObject) FindObjectIOR(const std::string& anObjectIOR);
79 virtual _PTR(SObject) FindObjectByPath(const std::string& thePath);
80 virtual std::string GetObjectPath(const _PTR(SObject)& theSO);
81 virtual void SetContext(const std::string& thePath);
82 virtual std::string GetContext();
83 virtual std::vector<std::string> GetObjectNames(const std::string& theContext);
84 virtual std::vector<std::string> GetDirectoryNames(const std::string& theContext);
85 virtual std::vector<std::string> GetFileNames(const std::string& theContext);
86 virtual std::vector<std::string> GetComponentNames(const std::string& theContext);
87 virtual _PTR(ChildIterator) NewChildIterator(const _PTR(SObject)& theSO);
88 virtual _PTR(SComponentIterator) NewComponentIterator();
89 virtual _PTR(StudyBuilder) NewBuilder();
90 virtual std::string Name();
91 virtual bool IsSaved();
92 virtual void IsSaved(bool save);
93 virtual bool IsModified();
94 virtual void Modified();
95 virtual std::string URL();
96 virtual void URL(const std::string& url);
97 virtual std::vector<_PTR(SObject)> FindDependances(const _PTR(SObject)& theSO);
98 virtual _PTR(AttributeStudyProperties) GetProperties();
99 virtual std::string GetLastModificationDate();
100 virtual std::vector<std::string> GetModificationsDate();
101 virtual _PTR(UseCaseBuilder) GetUseCaseBuilder();
102 virtual void EnableUseCaseAutoFilling(bool isEnabled);
103 virtual bool DumpStudy(const std::string& thePath,const std::string& theBaseName,bool isPublished,bool isMultiFile);
104 virtual _PTR(AttributeParameter) GetCommonParameters(const std::string& theID, int theSavePoint);
105 virtual _PTR(AttributeParameter) GetModuleParameters(const std::string& theID,
106 const std::string& theModuleName, int theSavePoint);
107 virtual void SetStudyLock(const std::string& theLockerID);
108 virtual bool IsStudyLocked();
109 virtual void UnLockStudy(const std::string& theLockerID);
110 virtual std::vector<std::string> GetLockerID();
112 virtual void SetReal(const std::string& theVarName, const double theValue);
113 virtual void SetInteger(const std::string& theVarName, const int theValue);
114 virtual void SetBoolean(const std::string& theVarName, const bool theValue);
115 virtual void SetString(const std::string& theVarName, const std::string& theValue);
116 virtual void SetStringAsDouble(const std::string& theVarName, const double theValue);
118 virtual double GetReal(const std::string& theVarName);
119 virtual int GetInteger(const std::string& theVarName);
120 virtual bool GetBoolean(const std::string& theVarName);
121 virtual std::string GetString(const std::string& theVarName);
123 virtual bool IsReal(const std::string& theVarName);
124 virtual bool IsInteger(const std::string& theVarName);
125 virtual bool IsBoolean(const std::string& theVarName);
126 virtual bool IsString(const std::string& theVarName);
128 virtual bool IsVariable(const std::string& theVarName);
129 virtual std::vector<std::string> GetVariableNames();
131 virtual bool RemoveVariable(const std::string& theVarName);
132 virtual bool RenameVariable(const std::string& theVarName, const std::string& theNewVarName);
133 virtual bool IsVariableUsed(const std::string& theVarName);
134 virtual std::vector< std::vector<std::string> > ParseVariables(const std::string& theVars);
135 virtual void attach(SALOMEDS::Observer_ptr theObserver,bool modify);
136 virtual void detach(SALOMEDS::Observer_ptr theObserver);
138 std::string ConvertObjectToIOR(CORBA::Object_ptr theObject);
139 CORBA::Object_ptr ConvertIORToObject(const std::string& theIOR);
141 SALOMEDS::Study_ptr GetStudy();
143 SALOMEDSImpl_Study* GetLocalImpl() { return _local_impl; }