Salome HOME
Merge remote-tracking branch 'origin/master'
[modules/kernel.git] / src / Container / SALOME_Component_i.hxx
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 //  SALOME Container : implementation of container and engine for Kernel
24 //  File   : SALOME_Component_i.hxx
25 //  Author : Paul RASCLE, EDF - MARC TAJCHMAN, CEA
26 //  Module : SALOME
27 //  $Header$
28 //
29 #ifndef _SALOME_COMPONENT_I_HXX_
30 #define _SALOME_COMPONENT_I_HXX_
31
32 #include <SALOMEconfig.h>
33
34 #include "SALOME_Container.hxx"
35
36 #include <iostream>
37 #include <signal.h>
38 #include <stdlib.h>
39 #ifndef WIN32
40 #include <unistd.h>
41 #endif
42 #include <sys/types.h>
43 #include <string>
44 #include <map>
45 #include CORBA_SERVER_HEADER(SALOME_Component)
46 #include "NOTIFICATION.hxx"
47 #include "Salome_file_i.hxx"
48
49 class RegistryConnexion;
50 class Engines_Container_i;
51
52 class CONTAINER_EXPORT Engines_Component_i:
53   public virtual POA_Engines::EngineComponent,
54   public virtual PortableServer::ServantBase
55 {
56 public:
57   Engines_Component_i();
58   Engines_Component_i(CORBA::ORB_ptr orb,
59                       PortableServer::POA_ptr poa,
60                       PortableServer::ObjectId * contId,
61                       const char *instanceName,
62                       const char *interfaceName,
63                       bool notif = false,
64                       bool regist = true);
65   //Constructor for standalone component
66   Engines_Component_i(CORBA::ORB_ptr orb,
67                       PortableServer::POA_ptr poa,
68                       Engines::Container_ptr container,
69                       const char *instanceName,
70                       const char *interfaceName,
71                       bool notif = false,
72                       bool regist = true);
73
74   virtual ~Engines_Component_i();
75
76   // --- CORBA methods
77
78   char* instanceName();
79   char* interfaceName();
80
81   void ping();
82   void destroy();
83
84   CORBA::Long getStudyId();
85   Engines::Container_ptr GetContainerRef();
86
87   void setProperties(const Engines::FieldsDict& dico);
88   Engines::FieldsDict* getProperties();
89
90   virtual void  SetOption(const char*, const char*);
91   virtual char* GetOption(const char*);
92
93         void Names( const char * graphName , const char * nodeName ) ;
94   bool Kill_impl();
95   bool Stop_impl();
96   bool Suspend_impl();
97   bool Resume_impl();
98   CORBA::Long CpuUsed_impl() ;
99
100   virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
101                                        CORBA::Boolean isPublished,
102                                        CORBA::Boolean isMultiFile,
103                                        CORBA::Boolean& isValidScript);
104
105   // CORBA operations for Salome_file
106   virtual Engines::Salome_file_ptr getInputFileToService(const char* service_name,
107                                                          const char* Salome_file_name);
108   virtual Engines::Salome_file_ptr getOutputFileToService(const char* service_name,
109                                                           const char* Salome_file_name);
110
111   virtual void checkInputFilesToService(const char* service_name);
112   virtual Engines::Salome_file_ptr setInputFileToService(const char* service_name,
113                                                          const char* Salome_file_name);
114
115   virtual void checkOutputFilesToService(const char* service_name);
116   virtual Engines::Salome_file_ptr setOutputFileToService(const char* service_name,
117                                                           const char* Salome_file_name);
118
119   // Object information
120   virtual bool hasObjectInfo() { return false; }
121   virtual char* getObjectInfo(CORBA::Long studyId, const char* entry) { return CORBA::string_dup(""); }
122
123   // Version information
124   virtual char* getVersion();
125
126   // --- local C++ methods
127
128   PortableServer::ObjectId * getId();
129   Engines_Container_i *GetContainerPtr();
130   std::string getContainerName();
131   void setContainerName();
132
133   virtual bool setStudyId(CORBA::Long studyId);
134   static bool isMultiStudy();
135   static bool isMultiInstance();
136   static std::string GetDynLibraryName(const char *componentName);
137
138   void beginService(const char *serviceName);
139   void endService(const char *serviceName);
140   void sendMessage(const char *event_type, const char *message);
141   char * graphName() ;
142   char * nodeName() ;
143   bool Killer( pthread_t ThreadId , int signum );
144   void SetCurCpu() ;
145   long CpuUsed() ;
146   void CancelThread() ;
147
148   virtual void configureSalome_file(std::string service_name,
149                                     std::string file_port_name,
150                                     Salome_file_i * file);
151
152 protected:
153   int _studyId; // -1: not initialised; 0: multiStudy; >0: study
154   static bool _isMultiStudy;
155   static bool _isMultiInstance;
156
157   std::string _instanceName ;
158   std::string _interfaceName ;
159   std::string _containerName ;
160
161   CORBA::ORB_var _orb;
162   PortableServer::POA_var _poa;
163   PortableServer::ObjectId * _id;
164   PortableServer::ObjectId * _contId;
165   Engines::Container_var _container;
166   Engines_Component_i * _thisObj ;
167   RegistryConnexion *_myConnexionToRegistry;
168   NOTIFICATION_Supplier* _notifSupplier;
169   std::map<std::string,CORBA::Any>_fieldsDict;
170
171   // Map Salome_file_name to Salome_file*
172   typedef std::map<std::string, Salome_file_i*> _t_Salome_file_map;
173   // Map Service_name to  _Salome_file_map
174   typedef std::map<std::string, Engines_Component_i::_t_Salome_file_map*> _t_Service_file_map;
175
176   _t_Service_file_map _Input_Service_file_map;
177   _t_Service_file_map _Output_Service_file_map;
178   _t_Service_file_map::iterator _Service_file_map_it;
179   _t_Salome_file_map::iterator _Salome_file_map_it;
180
181   std::string _serviceName ;
182   std::string _graphName ;
183   std::string _nodeName ;
184
185 private:
186 #ifndef WIN32
187   pthread_t _ThreadId ;
188 #else
189   pthread_t* _ThreadId ;
190 #endif
191   long      _StartUsed ;
192   long      _ThreadCpuUsed ;
193   bool      _Executed ;
194   bool      _CanceledThread ;
195 };
196
197 #endif