salome Namespace Reference

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

Data Structures
class	SessionContextManager

Functions
def	extend_path (pname)
def	standalone ()
def	withServers ()
def	salome_init (path=None, embedded=False, iorfakensfile=None, forced=False)
def	salome_init_without_session_common (path=None, embedded=False)
def	salome_init_without_session (path=None, embedded=False, iorfakensfile=None)
def	salome_init_without_session_attached (path=None, embedded=False)
def	salome_init_with_session (path=None, embedded=False)
def	salome_close ()
def	salome_NS ()
def	salome_walk_on_containers (ns, root)
def	salome_shutdown_containers_with_session ()
def	retrieve_containers_in_ns ()
def	salome_shutdown_containers_without_session ()
def	salome_shutdown_containers ()
def	ContainerManagerSetOverrideEnvForContainersSimple (self, env)

Variables
string	ROOT_PYTHONPACKAGE_NAME = "salome"
string	MATCH_ENDING_PATTERN = "site-packages" + os.path.sep + "salome"
	flags = None
	orb
	lcc
	naming_service
	cm
	sg
	esm
	dsm
	modulcat
	rm
	myStudy
	myStudyName
bool	salome_initial = True

Detailed Description

Module salome gives access to Salome resources.

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.myStudy	: the active Study (interface SALOMEDS::Study)

Function Documentation

ContainerManagerSetOverrideEnvForContainersSimple()

def salome.ContainerManagerSetOverrideEnvForContainersSimple	(		self,
			env
	)

extend_path()

def salome.extend_path

(

pname

)

References virtual_salome.verbose.

retrieve_containers_in_ns()

def salome.retrieve_containers_in_ns

(

)

Referenced by salome_shutdown_containers_without_session().

salome_close()

def salome.salome_close

(

)

References salome_iapp.salome_iapp_close(), and KERNEL_PY.salome_study.salome_study_close().

Referenced by salome.SessionContextManager.__exit__().

salome_init()

def salome.salome_init	(		path = None,
			embedded = False,
			iorfakensfile = None,
			forced = False
	)

References salome_init_with_session(), salome_init_without_session(), and salome_init_without_session_attached().

Referenced by salome.SessionContextManager.__enter__(), salome_instance.SalomeInstance.__run(), studyedit.StudyEditor.builder(), KERNEL_PY.kernel.studyedit.StudyEditor.builder(), SalomeSDSClt.CreateRdExtGlobalVar(), SalomeSDSClt.CreateRdOnlyGlobalVar(), TestSalomeSDS.func_test7(), SalomeSDSClt.GetHandlerFromName(), studyedit.StudyEditor.lcc(), KERNEL_PY.kernel.studyedit.StudyEditor.lcc(), KERNEL_PY.salome_test.main(), salome_iapp.register_module_in_study(), KERNEL_PY.salome_iapp.register_module_in_study(), salome_shutdown_containers_with_session(), KERNEL_PY.kernel_test.TestKernel.setUp(), runConsole.start_client(), studyedit.StudyEditor.study(), KERNEL_PY.kernel.studyedit.StudyEditor.study(), testcontainer.TestResourceManager.test4(), test_launcher.TestCompo.test_command_salome(), testProxy.TestProxy.testExecCodeAtInit(), and TestSalomeSDS.SalomeSDSTest.testShutdownScopes().

salome_init_with_session()

def salome.salome_init_with_session	(		path = None,
			embedded = False
	)

References salome_iapp.salome_iapp_init(), KERNEL_PY.salome_kernel.salome_kernel_init(), and KERNEL_PY.salome_study.salome_study_init().

Referenced by salome_init().

salome_init_without_session()

def salome.salome_init_without_session	(		path = None,
			embedded = False,
			iorfakensfile = None
	)

References salome_init_without_session_common().

Referenced by salome_init().

salome_init_without_session_attached()

def salome.salome_init_without_session_attached	(		path = None,
			embedded = False
	)

References Kernel_Utils.decode(), and salome_init_without_session_common().

Referenced by salome_init().

salome_init_without_session_common()

def salome.salome_init_without_session_common	(		path = None,
			embedded = False
	)

References KERNEL_PY.salome_kernel.list_of_catalogs_regarding_environement(), salome_iapp.salome_iapp_init(), KERNEL_PY.salome_study.salome_study_init_without_session(), and ORBConfigFile.writeORBConfigFileSSL().

Referenced by salome_init_without_session(), and salome_init_without_session_attached().

salome_NS()

def salome.salome_NS

(

)

Referenced by salome_shutdown_containers_with_session().

salome_shutdown_containers()

def salome.salome_shutdown_containers

(

)

References salome_shutdown_containers_with_session(), and salome_shutdown_containers_without_session().

salome_shutdown_containers_with_session()

def salome.salome_shutdown_containers_with_session

(

)

References SalomeOnDemandTK.extension_utilities.format, salome_init(), salome_NS(), and salome_walk_on_containers().

Referenced by salome_shutdown_containers().

salome_shutdown_containers_without_session()

def salome.salome_shutdown_containers_without_session

(

)

References retrieve_containers_in_ns().

Referenced by salome_shutdown_containers().

salome_walk_on_containers()

def salome.salome_walk_on_containers	(		ns,
			root
	)

Referenced by salome_shutdown_containers_with_session().

standalone()

def salome.standalone

(

)

Referenced by salome.SessionContextManager.__enter__(), testcontainer.TestResourceManager.test4(), test_launcher.TestCompo.test_command_salome(), and testProxy.TestProxy.testExecCodeAtInit().

withServers()

def salome.withServers

(

)

Variable Documentation

cm

salome.cm

Referenced by GetContainerManagerInstance(), and GetResourcesManagerInstance().

dsm

salome.dsm

Referenced by GetDSMInstanceInternal(), main(), SALOMESDS::DataScopeServerBase.shutdownIfNotHostedByDSM(), and SALOME_LifeCycleCORBA.shutdownServers().

esm

salome.esm

Referenced by GetExternalServerInstance(), and main().

flags

salome.flags = None

Referenced by SALOMEDSTest.testAttributeFlags().

lcc

salome.lcc

Referenced by TEST_corba(), and KernelHelpersUnitTests.TEST_corba().

MATCH_ENDING_PATTERN

string salome.MATCH_ENDING_PATTERN = "site-packages" + os.path.sep + "salome"

modulcat

salome.modulcat

myStudy

salome.myStudy

Referenced by Test().

myStudyName

salome.myStudyName

naming_service

salome.naming_service

orb

salome.orb

Referenced by Abstract_Engines_Container_i.Abstract_Engines_Container_i(), MPIObject_i.BCastIOR(), CommonDataScopeServerMain(), ConnectionManager_i.ConnectionManager_i(), container_common_main(), CreateDataScope(), ClientFactory.createStudy(), CreateStudy(), CreateStudyNSAbstract(), ClientFactory.createStudyWithoutNS(), CreateStudyWithoutNS(), SALOMESDS::DataServerManager.DataServerManager(), Engines_Component_i.Engines_Component_i(), Engines_Parallel_Component_i.Engines_Parallel_Component_i(), Engines_Parallel_Container_i.Engines_Parallel_Container_i(), SALOMEDS::GenObjRegister.GenObjRegister(), GetContainerInstance(), GetContainerManagerInstance(), KERNEL.getContainerSA(), GetCustomORB(), GetDriver(), GetDSMInstanceInternal(), GetExternalServerInstance(), getGlobalORB(), KERNEL.getLauncherSA(), GetLoggerInstance(), KERNEL.getLoggerServantSA(), GetModuleCatalogInstance(), KERNEL.getModuleComponentServantSA(), GetNewSessionInstance(), Engines_Component_i.getNS(), KERNEL.getORB(), KERNEL.GetRefToORB(), GetResourcesManagerInstance(), GetSessionInstance(), GiveADataScopeCalled(), SALOME_Launcher.init(), SALOME_NamingService_Abstract_Decorator.init_orb(), Param_Double_Port_provides_i.init_port(), IORToObject(), main(), NOTIFICATION_channel(), SALOMEDS::Notifier.Notifier(), ObjectToIOR(), Param_Double_Port_uses_i.Param_Double_Port_uses_i(), RegisterCompoInternal(), SALOME_Fake_NamingService.ReprOfContainersIORS_NoThreadSafe(), SALOMESDS::RequestSwitcherBase.RequestSwitcherBase(), RetrieveCompoInternal(), KERNEL.retrieveNewStudyServantSA(), SALOME_ContainerManager.SALOME_ContainerManager(), SALOME_ExternalServerLauncher.SALOME_ExternalServerLauncher(), SALOME_Launcher.SALOME_Launcher(), SALOME_ResourcesManager.SALOME_ResourcesManager(), SALOMEDS_ChildIterator_i.SALOMEDS_ChildIterator_i(), SALOMEDS_SComponentIterator_i.SALOMEDS_SComponentIterator_i(), SALOMEDS_SObject_i.SALOMEDS_SObject_i(), SALOMEDS_Study_i.SALOMEDS_Study_i(), SALOMEDS_StudyBuilder_i.SALOMEDS_StudyBuilder_i(), SALOMEDS_UseCaseBuilder_i.SALOMEDS_UseCaseBuilder_i(), SALOMEDS_UseCaseIterator_i.SALOMEDS_UseCaseIterator_i(), SalomeTestComponentEngine_factory(), Logger.SetOrb(), RegistryService.SetOrb(), TEST_corba(), KernelHelpersUnitTests.TEST_corba(), TestMPIComponentEngine_factory(), and TraceCollector_WaitForServerReadiness().

rm

salome.rm

Referenced by RetrieveInternalInstanceOfLocalCppResourcesManager(), and Launcher_cpp.SetResourcesManager().

ROOT_PYTHONPACKAGE_NAME

string salome.ROOT_PYTHONPACKAGE_NAME = "salome"

salome_initial

bool salome.salome_initial = True

sg

salome.sg