SALOME documentation central

salome Namespace Reference

Module salome gives access to Salome ressources. More...

Functions

def salome_init

Variables

int salome_initial = 1

Detailed Description

Module salome gives access to Salome ressources.

Parameters:
salome.orb: CORBA orb object
salome.naming_service: instance of naming Service class (SALOME_NamingServicePy::SALOME_NamingServicePy_i)
salome.lcc: instance of lifeCycleCORBA class (SALOME_LifeCycleCORBA)
salome.sg: Salome object to communicate with the graphical user interface, if running (see interface in salome_iapp::SalomeOutsideGUI)
salome.myStudyName: active Study Name
salome.myStudyId: active Study Id
salome.myStudy: the active Study (interface SALOMEDS::Study)

Function Documentation

def salome::salome_init (   theStudyId = 0,
  embedded = 0 
)
Performs only once SALOME general purpose intialisation for scripts.
optional argument : theStudyId
  When in embedded interpreter inside IAPP, theStudyId is not used
  When used without GUI (external interpreter)
    0      : create a new study (default).
    n (>0) : try connection to study with Id = n, or create a new one
             if study not found.
             If study creation, its Id may be different from theStudyId !
Provides:
orb             reference to CORBA
lcc             a LifeCycleCorba instance
naming_service  a naming service instance
cm              reference to the container manager
sg              access to SALOME GUI (when linked with IAPP GUI)
myStudyManager  the study manager
myStudyId       active study identifier
myStudy         active study itself (CORBA reference)
myStudyName     active study name