Salome HOME
Rename Engines::Component to Engines::EngineComponent
[modules/kernel.git] / src / Container / SALOME_Component_i.hxx
1 //  Copyright (C) 2007-2010  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.
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   void Names( const char * graphName , const char * nodeName ) ;
91   bool Kill_impl();
92   bool Stop_impl();
93   bool Suspend_impl();
94   bool Resume_impl();
95   CORBA::Long CpuUsed_impl() ;
96
97   virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
98                                        CORBA::Boolean isPublished,
99                                        CORBA::Boolean& isValidScript);
100
101   // CORBA operations for Salome_file
102   virtual Engines::Salome_file_ptr getInputFileToService(const char* service_name, 
103                                                          const char* Salome_file_name);
104   virtual Engines::Salome_file_ptr getOutputFileToService(const char* service_name, 
105                                                           const char* Salome_file_name);
106
107   virtual void checkInputFilesToService(const char* service_name);
108   virtual Engines::Salome_file_ptr setInputFileToService(const char* service_name, 
109                                                          const char* Salome_file_name);
110
111   virtual void checkOutputFilesToService(const char* service_name);
112   virtual Engines::Salome_file_ptr setOutputFileToService(const char* service_name, 
113                                                           const char* Salome_file_name);
114
115   // Object information
116   virtual bool hasObjectInfo() { return false; }
117   virtual char* getObjectInfo(CORBA::Long studyId, const char* entry) { return CORBA::string_dup(""); }
118   
119   // --- local C++ methods
120
121   PortableServer::ObjectId * getId(); 
122   Engines_Container_i *GetContainerPtr();
123   std::string getContainerName();
124   void setContainerName();
125
126   virtual bool setStudyId(CORBA::Long studyId);
127   static bool isMultiStudy();
128   static bool isMultiInstance();
129   static std::string GetDynLibraryName(const char *componentName);
130
131   void beginService(const char *serviceName);
132   void endService(const char *serviceName);
133   void sendMessage(const char *event_type, const char *message);
134   char * graphName() ;
135   char * nodeName() ;
136   bool Killer( pthread_t ThreadId , int signum );
137   void SetCurCpu() ;
138   long CpuUsed() ;
139   void CancelThread() ;
140
141   virtual void configureSalome_file(std::string service_name,
142                                     std::string file_port_name,
143                                     Salome_file_i * file);
144
145
146 protected:
147   int _studyId; // -1: not initialised; 0: multiStudy; >0: study
148   static bool _isMultiStudy;
149   static bool _isMultiInstance;
150
151   std::string _instanceName ;
152   std::string _interfaceName ;
153   std::string _containerName ;
154
155   CORBA::ORB_var _orb;
156   PortableServer::POA_var _poa;
157   PortableServer::ObjectId * _id;
158   PortableServer::ObjectId * _contId;
159   Engines::Container_var _container;
160   Engines_Component_i * _thisObj ;
161   RegistryConnexion *_myConnexionToRegistry;
162   NOTIFICATION_Supplier* _notifSupplier;
163   std::map<std::string,CORBA::Any>_fieldsDict;
164
165   // Map Salome_file_name to Salome_file*
166   typedef std::map<std::string, Salome_file_i*> _t_Salome_file_map;
167   // Map Service_name to  _Salome_file_map
168   typedef std::map<std::string, Engines_Component_i::_t_Salome_file_map*> _t_Service_file_map;
169   
170   _t_Service_file_map _Input_Service_file_map;
171   _t_Service_file_map _Output_Service_file_map;
172   _t_Service_file_map::iterator _Service_file_map_it;
173   _t_Salome_file_map::iterator _Salome_file_map_it;
174
175   std::string _serviceName ;
176   std::string _graphName ;
177   std::string _nodeName ;
178
179 private:
180 #ifndef WIN32
181   pthread_t _ThreadId ;
182 #else
183   pthread_t* _ThreadId ;
184 #endif
185   long      _StartUsed ;
186   long      _ThreadCpuUsed ;
187   bool      _Executed ;
188   bool      _CanceledThread ;
189 };
190
191 #endif