Salome HOME
PR: merge from branch BR_UnitTests tag mergeto_trunk_17oct05
[modules/kernel.git] / src / SALOMEDS / SALOMEDS_StudyManager_i.hxx
1 //  File   : SALOMEDS_StudyManager_i.hxx
2 //  Author : Sergey RUIN
3 //  Module : SALOME
4
5 #ifndef __SALOMEDS_STUDYMANAGER_I_H__
6 #define __SALOMEDS_STUDYMANAGER_I_H__
7
8 // std C++ headers
9 #include <iostream>
10
11 // IDL headers
12 #include <SALOMEconfig.h>
13 #include CORBA_SERVER_HEADER(SALOMEDS)
14
15 // Naming Service header
16 #include "SALOME_NamingService.hxx"
17
18 #include <stdlib.h>
19
20 //Standard not implemented
21 #include <Standard_NotImplemented.hxx>
22 #include "SALOMEDS_Driver_i.hxx"
23 #include "SALOMEDSImpl_StudyManager.hxx"
24
25 namespace SALOMEDS{
26
27   // To convert IOR from SALOMEDS_IORAttribute to CORBA::Object
28   /* CORBA::Object_var GetObject(const TDF_Label&, CORBA::ORB_ptr); */
29
30   // To convert CORBA::Object to  PortableServer::ServantBase
31   PortableServer::ServantBase_var GetServant(CORBA::Object_ptr, PortableServer::POA_ptr);
32
33 }    
34
35 class Standard_EXPORT SALOMEDS_StudyManager_i: public POA_SALOMEDS::StudyManager,
36                                public PortableServer::RefCountServantBase {
37 private:
38
39   CORBA::ORB_ptr                    _orb;
40   PortableServer::POA_var           _poa;
41   Handle(SALOMEDSImpl_StudyManager) _impl;  
42   SALOME_NamingService*             _name_service;
43   SALOMEDS_DriverFactory_i*         _factory; 
44
45 public:
46
47   //! standard constructor
48   SALOMEDS_StudyManager_i(CORBA::ORB_ptr orb, PortableServer::POA_ptr thePOA);
49
50   //! standard destructor
51   virtual  ~SALOMEDS_StudyManager_i(); 
52
53  //! method to Register study Manager in the naming service
54   /*!
55     \param char* arguments, the context to register the study manager in the NS
56   */  
57   void register_name(char * name);
58   
59  //! method to Create a New Study of name study_name
60   /*!
61     \param char* arguments, the new study name
62     \return Study_ptr arguments
63   */  
64   virtual SALOMEDS::Study_ptr NewStudy(const char* study_name);
65
66   //! method to Open a Study from it's persistent reference
67   /*!
68     \param char* arguments, the study URL
69     \return Study_ptr arguments
70   */ 
71   virtual SALOMEDS::Study_ptr Open(const char* aStudyUrl) throw (SALOME::SALOME_Exception);
72
73
74   //! method to close a Study 
75   /*!
76     \param Study_ptr arguments
77   */ 
78   virtual void Close( SALOMEDS::Study_ptr aStudy);
79
80   //! method to save a Study 
81   /*!
82     \param Study_ptr arguments
83   */
84   virtual void Save( SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile);
85
86   virtual void SaveASCII( SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile);
87
88   //! method to save a Study to the persistent reference aUrl
89   /*!
90     \param char* arguments, the new URL of the study
91     \param Study_ptr arguments
92   */
93   virtual void SaveAs(const char* aUrl,  SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile);
94   virtual void SaveAsASCII(const char* aUrl,  SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile);
95
96  //! method to Get name list of open studies in the session
97   /*!
98     \return ListOfOpenStudies* arguments
99   */
100   virtual SALOMEDS::ListOfOpenStudies* GetOpenStudies();
101
102   //! method to get a Study from it's name
103   /*!
104     \param char* arguments, the study name
105     \return Study_ptr arguments
106   */ 
107   virtual SALOMEDS::Study_ptr GetStudyByName(const char* aStudyName) ;
108
109   //! method to get a Study from it's ID
110   /*!
111     \param char* arguments, the study ID
112     \return Study_ptr arguments
113   */ 
114   virtual SALOMEDS::Study_ptr GetStudyByID(CORBA::Short aStudyID) ;
115   
116   virtual CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
117   virtual CORBA::Boolean Copy(SALOMEDS::SObject_ptr theObject);
118   virtual CORBA::Boolean CanPaste(SALOMEDS::SObject_ptr theObject);
119   virtual SALOMEDS::SObject_ptr Paste(SALOMEDS::SObject_ptr theObject) throw(SALOMEDS::StudyBuilder::LockProtection);
120
121   virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
122   virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };  
123   
124   void ping(){};
125
126   virtual long GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
127
128   static PortableServer::POA_ptr GetPOA(const SALOMEDS::Study_ptr theStudy);
129 };
130
131 #endif