1 # -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
4 # This library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2.1 of the License, or (at your option) any later version.
9 # This library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 # Lesser General Public License for more details.
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with this library; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 # Author: Guillaume Boulant (EDF/R&D)
23 ## \defgroup service service
25 # \details Helper for using %SALOME kernel services
29 # WARNING: development notes
31 # This python module is aimed to be a (yet another?) end user
32 # interface to manipulate the KERNEL SALOME services. Note that it
33 # does not replace the salome module (i.e. what you get when typing
34 # "import salome", actually implemented in the file __init__.py of the
35 # salome python package). It provides instead functions that help to
36 # use the salome module in a end user context (development of domain
37 # specific tools by programmers that are not ten years experienced in
38 # SALOME development).
41 from .deprecation import is_called_by_sphinx
42 if not is_called_by_sphinx() and salome.lcc is None:
45 except Exception as e:
48 # Note that the salome module provides you with standard SALOME
49 # objects: CORBA broker (orb): salome.orb lyfe cycle (lcc) :
50 # salome.lcc naming service : salome.naming_service
51 # The default study : salome.myStudy
53 # Alternatively, you may obtain these objects directly with the
54 # following instructions:
56 # from omniORB import CORBA
57 # from LifeCycleCORBA import LifeCycleCORBA
58 # orb = CORBA.ORB_init( [''], CORBA.ORB_ID )
59 # lcc = LifeCycleCORBA( orb )
61 # from SALOME_NamingServicePy import SALOME_NamingServicePy_i
62 # naming_service = SALOME_NamingServicePy_i( orb )
64 # (See salome.py page in the KERNEL documentation)
67 # ==============================================================================
68 # Helper functions for SALOME components
69 # ==============================================================================
72 ## Get a %SALOME CORBA component from its name
73 # \param componentName is the name of the component as declared in the XML
74 # %SALOME catalog. %A loadable library with name lib<componentName>Engine.so
75 # is supposed to be reachable. This library is supposed to provide a
76 # factory function with the prototype:
79 # PortableServer::ObjectId * <componentName>Engine_factory( CORBA::ORB_ptr orb,
80 # PortableServer::POA_ptr poa,
81 # PortableServer::ObjectId* contId,
82 # const char *instanceName,
83 # const char *interfaceName );
86 # \param corbaModule is the name of the IDL module that contains the
87 # definition of the interface of the component. This name corresponds
88 # to the namespace of the servant classes.
90 # \param containerType specified the container in which the servants are
93 def getComponent(componentName = "SalomeTestComponent",
94 corbaModule = "Engines",
95 containerType = "FactoryServer"):
97 Get a SALOME CORBA component from its name
99 print("INF: getting component %s from CORBA module %s ..."%(componentName,corbaModule))
100 __import__(corbaModule)
101 component=salome.lcc.FindOrLoadComponent(containerType,componentName)
102 if component is None:
103 print("ERR: the SALOME component "+componentName+" can't be reached")
104 print("INF: component %s obtained from CORBA module %s"%(componentName,corbaModule))
107 # Note that an alternative (and maybe better) method to get a component
108 # is to use the module catalog. Here, we just use the catalog to get
109 # the list of components defined in the current session.
110 import SALOME_ModuleCatalog
112 ## Get the list of names of all %SALOME componenents register in
115 def getComponentList():
117 Get the list of names of all SALOME componenents register in
120 obj = salome.naming_service.Resolve('Kernel/ModulCatalog')
121 catalog = obj._narrow(SALOME_ModuleCatalog.ModuleCatalog)
123 raise RuntimeError("Can't access module catalog")
124 return catalog.GetComponentList()
127 ## Get a study to create SALOME study.
128 # \warning you should use instead the variable salome.myStudy.
129 # This function is given for illustration of usage of the naming service
131 def __getStudy_demo():
133 Get a study to create SALOME study. WARN: you
134 should use instead the variable salome.myStudy. This
135 function is given for illustration of usage of the naming service
137 naming_service = SALOME_NamingServicePy_i( orb )
138 obj = naming_service.Resolve( '/Study' )
139 study = obj._narrow( SALOMEDS.Study)
144 # ==============================================================================
145 # Helper functions for manipulating objects, sobjects and entry
146 # ==============================================================================
149 # - the SObject is an item in a study (Study Object).
150 # - the entry is the identifier of an item.
151 # - the ID is the entry
152 # - the object (geom object or smesh object) is a CORBA servant
153 # embedded in the SALOME component container and with a reference in
154 # the SALOME study, so that it can be retrieved.
156 # __GBO__ WARN: theses functions are already defined in
157 # salome_study.py, but without the possibility to specify the
158 # underlying study (in salome_study.py, the study is the default study
159 # binded to the salome.myStudy attribute). TODO: see if it can be
160 # extends to the prototype (with the study as an argument) below and
161 # resorb the functions below.
163 def IDToObject(id, study=None):
166 myStudy = salome.myStudy
169 mySO = myStudy.FindObjectID(id);
171 ok, anAttr = mySO.FindAttribute("AttributeIOR")
173 AtIOR = anAttr._narrow(SALOMEDS.AttributeIOR)
174 if AtIOR.Value() != "":
175 myObj = salome.orb.string_to_object(AtIOR.Value())
178 def ObjectToSObject(obj, study=None):
182 myStudy = salome.myStudy
187 ior = salome.orb.object_to_string(obj)
189 mySO = myStudy.FindObjectIOR(ior)
192 def ObjectToID(obj, study=None):
193 mySO = ObjectToSObject(obj,study)
198 def IDToSObject(id, study=None):
200 myStudy = salome.myStudy
204 mySO = myStudy.FindObjectID(id);
207 def SObjectToID(sobject):
208 if sobject is None: return None
209 return sobject.GetID()
213 # ==============================================================================
214 # Basic use cases and unit tests
215 # ==============================================================================
218 def TEST_getComponent():
219 component=getComponent(componentName = "SalomeTestComponent")
221 ref_string = 'TestComponent_i : L = 3'
222 res_string = component.Coucou(3)
223 if ref_string != ref_string:
227 def TEST_getComponentList():
228 componentList=getComponentList()
229 if 'SalomeTestComponent' not in componentList:
233 def TEST_createObject():
235 WARNING: for this test, we need GEOM (used to create an object)
238 from salome.geom import geomBuilder
239 geompy = geomBuilder.New()
241 box = geompy.MakeBoxDXDYDZ(200, 200, 200)
242 id = geompy.addToStudy( box, 'box' )
245 def TEST_objectsManipulation():
246 myEntry = TEST_createObject()
248 mySObject = IDToSObject(myEntry)
249 entry = SObjectToID(mySObject)
251 if str(entry) != str(myEntry):
255 myObject = IDToObject(myEntry)
262 if __name__ == "__main__":
263 from . import unittester
264 unittester.run("services","TEST_getComponent")
265 unittester.run("services","TEST_getComponentList")
266 unittester.run("services","TEST_objectsManipulation")