Salome HOME
Make PYHELLO component appear into SALOME_Session_Server_No_Server application
[samples/pyhello.git] / src / PYHELLO / PYHELLO.py
1 # Copyright (C) 2007-2021  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 # ---
24 # File   : PYHELLOGUI.py
25 # Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
26 # ---
27 #
28 import PYHELLO_ORB__POA
29 import SALOME_ComponentPy
30 import SALOME_Embedded_NamingService_ClientPy
31 import SALOME_DriverPy
32 import SALOMEDS
33 from PYHELLO_utils import findOrCreateComponent, objectID, moduleName, getStudy
34
35 class PYHELLO(PYHELLO_ORB__POA.PYHELLO_Gen,
36               SALOME_ComponentPy.SALOME_ComponentPy_i,
37               SALOME_DriverPy.SALOME_DriverPy_i):
38     """
39     Construct an instance of PYHELLO module engine.
40     The class PYHELLO implements CORBA interface PYHELLO_Gen (see PYHELLO_Gen.idl).
41     It is inherited from the classes SALOME_ComponentPy_i (implementation of
42     Engines::EngineComponent CORBA interface - SALOME component) and SALOME_DriverPy_i
43     (implementation of SALOMEDS::Driver CORBA interface - SALOME module's engine).
44     """
45     def __init__ ( self, orb, poa, contID, containerName, instanceName,
46                    interfaceName ):
47         SALOME_ComponentPy.SALOME_ComponentPy_i.__init__(self, orb, poa,
48                     contID, containerName, instanceName, interfaceName, False)
49         SALOME_DriverPy.SALOME_DriverPy_i.__init__(self, interfaceName)
50         #
51         emb_ns = self._contId.get_embedded_NS_if_ssl()
52         import CORBA
53         if CORBA.is_nil(emb_ns):
54             self._naming_service = SALOME_ComponentPy.SALOME_NamingServicePy_i( self._orb )
55         else:
56             self._naming_service = SALOME_Embedded_NamingService_ClientPy.SALOME_Embedded_NamingService_ClientPy(emb_ns)
57         #
58         pass
59
60     def getNamingService(self):
61         return self._naming_service
62
63     """
64     Get version information.
65     """
66     def getVersion( self ):
67         import salome_version
68         return salome_version.getVersion("PYHELLO", True)
69
70     """
71     Generate hello banner.
72     """
73     def makeBanner( self, name ):
74         banner = "Hello %s!" % name
75         return banner
76
77     """
78     Intentionnally raises an exception for test purposes.
79     """
80     def raiseAnException( self ):
81         import SALOME
82         exData = SALOME.ExceptionStruct( SALOME.BAD_PARAM, "Test exception in raiseAnException()",'',0)
83         raise SALOME.SALOME_Exception( exData )
84
85     """
86     Create object.
87     """
88     def createObject( self, name ):
89         study = getStudy( self._naming_service )
90         builder = study.NewBuilder()
91         father  = findOrCreateComponent()
92         obj  = builder.NewObject( father )
93         attr    = builder.FindOrCreateAttribute( obj, "AttributeName" )
94         attr.SetValue( name )
95         attr    = builder.FindOrCreateAttribute( obj, "AttributeLocalID" )
96         attr.SetValue( objectID() )
97         pass
98
99     """
100     Dump module data to the Python script.
101     """
102     def DumpPython( self, isPublished, isMultiFile ):
103         abuffer = []
104         names = []
105         study = getStudy()
106         father = study.FindComponent( moduleName() )
107         if father:
108             iterator = study.NewChildIterator(father)
109             while iterator.More():
110                 name = iterator.Value().GetName()
111                 if name: names.append( name )
112                 iterator.Next()
113                 pass
114             pass
115         if names:
116             abuffer += [ "import salome" ]
117             abuffer += [ "import PYHELLO_ORB" ]
118             abuffer += [ "" ]
119             abuffer += [ "pyhello = salome.lcc.FindOrLoadComponent( 'FactoryServerPy', '%s' )" % moduleName() ]
120             abuffer += [ "" ]
121             abuffer += [ "pyhello.createObject( '%s')" % name for name in names ]
122             abuffer += [ "" ]
123             pass
124         if isMultiFile:
125             abuffer = [ "  " + s for s in abuffer ]
126             abuffer[0:0] = [ "def RebuildData():" ]
127             abuffer += [ "    pass" ]
128         abuffer += [ "\0" ]
129         res = "\n".join( abuffer )
130         return (res.encode(), 1)