Version: 9.8.0
Collaboration diagram for service:

Functions

def services.getComponent (componentName="SalomeTestComponent", corbaModule="Engines", containerType="FactoryServer")
 Get a SALOME CORBA component from its name. More...
 
def services.getComponentList ()
 Get the list of names of all SALOME componenents register in the catalog. More...
 
def services.__getStudy_demo ()
 Get a study to create SALOME study. More...
 
def KERNEL_PY.kernel.services.getComponent (componentName="SalomeTestComponent", corbaModule="Engines", containerType="FactoryServer")
 Get a SALOME CORBA component from its name. More...
 
def KERNEL_PY.kernel.services.getComponentList ()
 Get the list of names of all SALOME componenents register in the catalog. More...
 
def KERNEL_PY.kernel.services.__getStudy_demo ()
 Get a study to create SALOME study. More...
 

Detailed Description

Helper for using SALOME kernel services

Function Documentation

◆ __getStudy_demo() [1/2]

def services.__getStudy_demo ( )
private

Get a study to create SALOME study.

Warning
you should use instead the variable salome.myStudy. This function is given for illustration of usage of the naming service

◆ __getStudy_demo() [2/2]

def KERNEL_PY.kernel.services.__getStudy_demo ( )
private

Get a study to create SALOME study.

Warning
you should use instead the variable salome.myStudy. This function is given for illustration of usage of the naming service
Get a study to create SALOME study. WARN: you
should use instead the variable salome.myStudy. This
function is given for illustration of usage of the naming service

◆ getComponent() [1/2]

def KERNEL_PY.kernel.services.getComponent (   componentName = "SalomeTestComponent",
  corbaModule = "Engines",
  containerType = "FactoryServer" 
)

Get a SALOME CORBA component from its name.

Parameters
componentNameis the name of the component as declared in the XML SALOME catalog. A loadable library with name lib<componentName>Engine.so is supposed to be reachable. This library is supposed to provide a factory function with the prototype:
PortableServer::ObjectId * <componentName>Engine_factory( CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa,
PortableServer::ObjectId* contId,
const char *instanceName,
const char *interfaceName );
Parameters
corbaModuleis the name of the IDL module that contains the definition of the interface of the component. This name corresponds to the namespace of the servant classes.
containerTypespecified the container in which the servants are executed.
Get a SALOME CORBA component from its name

Referenced by KERNEL_PY.kernel.services.TEST_getComponent().

◆ getComponent() [2/2]

def services.getComponent (   componentName = "SalomeTestComponent",
  corbaModule = "Engines",
  containerType = "FactoryServer" 
)

Get a SALOME CORBA component from its name.

Parameters
componentNameis the name of the component as declared in the XML SALOME catalog. A loadable library with name lib<componentName>Engine.so is supposed to be reachable. This library is supposed to provide a factory function with the prototype:
PortableServer::ObjectId * <componentName>Engine_factory( CORBA::ORB_ptr orb,
PortableServer::POA_ptr poa,
PortableServer::ObjectId* contId,
const char *instanceName,
const char *interfaceName );
Parameters
corbaModuleis the name of the IDL module that contains the definition of the interface of the component. This name corresponds to the namespace of the servant classes.
containerTypespecified the container in which the servants are executed.

Referenced by services.TEST_getComponent().

◆ getComponentList() [1/2]

def services.getComponentList ( )

Get the list of names of all SALOME componenents register in the catalog.

Referenced by KERNEL_PY.salome_test.main(), and services.TEST_getComponentList().

◆ getComponentList() [2/2]

def KERNEL_PY.kernel.services.getComponentList ( )

Get the list of names of all SALOME componenents register in the catalog.

Get the list of names of all SALOME componenents register in
the catalog.

Referenced by KERNEL_PY.kernel.services.TEST_getComponentList().