KERNEL_PY Namespace Reference

Namespaces
	batchmode_salome
	Help
	iparameters
	kernel
	kernel_test
	omnipatch
	PyInterp
	salome_ComponentGUI
	salome_genericobj
	salome_iapp
	salome_kernel
	salome_notebook
	salome_psutil
	salome_pynode
	salome_study
	salome_test
	salome_version

Data Structures
class	SessionContextManager
class	LogManagerLaunchMonitoringFileCtxMgr
class	Barrier
class	LockGuardCM
class	ContainerLauncherCM

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	get_all_containers ()
def	salome_shutdown_containers_without_session ()
def	salome_shutdown_containers ()
def	ContainerManagerSetOverrideEnvForContainersSimple (self, env)
def	LogManagerNaiveFetch (self)
def	LogManagerFetch (self, clearMemory=False)
def	LogManagerDumpInFile (self, fileName, clearMemory=False)
def	LogManagerLaunchMonitoringDumpFile (self, intervalInMs, outFileName)
def	LogManagerDumpIORInFile (self, iorFileName)
def	LogManagerLoadFromFile (fileName)
def	LogManagerLoadFromIORFile (iorFile)
def	LogManagerFinalFetchBeforeDying (self)
def	LogManagerGetLatestMonitoringDumpFile (self)

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
	logm
	modulcat
	rm
	lm
	myStudy
	myStudyName
bool	salome_initial = True
string	CM_NAME_IN_NS = "/ContainerManager"
string	RM_NAME_IN_NS = "/ResourcesManager"
string	DSM_NAME_IN_NS = "/DataServerManager"
string	ESM_NAME_IN_NS = "/ExternalServers"
string	LOGM_NAME_IN_NS = "/LogManager"
	__all__ = dir()

Function Documentation

ContainerManagerSetOverrideEnvForContainersSimple()

def KERNEL_PY.ContainerManagerSetOverrideEnvForContainersSimple	(		self,
			env
	)

extend_path()

def KERNEL_PY.extend_path

(

pname

)

References virtual_salome.verbose.

get_all_containers()

def KERNEL_PY.get_all_containers

(

)

References retrieve_containers_in_ns().

Referenced by salome_shutdown_containers_without_session().

LogManagerDumpInFile()

def KERNEL_PY.LogManagerDumpInFile	(		self,
			fileName,
			clearMemory = False
	)

LogManagerDumpIORInFile()

def KERNEL_PY.LogManagerDumpIORInFile	(		self,
			iorFileName
	)

LogManagerFetch()

def KERNEL_PY.LogManagerFetch	(		self,
			clearMemory = False
	)

Fetch data from server in one shot mode.

References SALOME_ContainerHelper.unserializeLogManager().

LogManagerFinalFetchBeforeDying()

def KERNEL_PY.LogManagerFinalFetchBeforeDying

(

self

)

LogManagerGetLatestMonitoringDumpFile()

def KERNEL_PY.LogManagerGetLatestMonitoringDumpFile

(

self

)

LogManagerLaunchMonitoringDumpFile()

def KERNEL_PY.LogManagerLaunchMonitoringDumpFile	(		self,
			intervalInMs,
			outFileName
	)

This method loops indefinitely every intervalInMs milliseconds to dump the singleton 
content of perf log stored in salome.logm.
This method runs in a dedicated subprocess that can be killed at any time.
So subprocess code must deal with.

See also LogManagerGetLatestMonitoringDumpFile

References SalomeOnDemandTK.extension_utilities.format.

LogManagerLoadFromFile()

def KERNEL_PY.LogManagerLoadFromFile

(

fileName

)

References SALOME_ContainerHelper.unserializeLogManager().

Referenced by LogManagerLoadFromIORFile().

LogManagerLoadFromIORFile()

def KERNEL_PY.LogManagerLoadFromIORFile

(

iorFile

)

References LogManagerLoadFromFile(), and salome_init_without_session().

LogManagerNaiveFetch()

def KERNEL_PY.LogManagerNaiveFetch

(

self

)

Fetch data from server with multiple CORBA invokations.

retrieve_containers_in_ns()

def KERNEL_PY.retrieve_containers_in_ns

(

)

Referenced by get_all_containers().

salome_close()

def KERNEL_PY.salome_close

(

)

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

Referenced by KERNEL_PY.SessionContextManager.__exit__().

salome_init()

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

Initialize SALOME client process (that can also be server).
3 modes of initialization exists:
- SSL mode (see salome_init_without_session)
- SSL mode attached in the context of python execution inside SALOME_Container_No_NS_Serv server (typically YACS)
- Classical mode (see salome_init_with_session)
:param iorfakensfile: filename inside which IOR of fake NS will be written
:param forced: tell if the multi-initialization protection mecanism of salome_init must be skiped of not
               (typically in the context where a path to a study is given whereas a previous initialisation without it was done)

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

Referenced by KERNEL_PY.SessionContextManager.__enter__(), and salome_shutdown_containers_with_session().

salome_init_with_session()

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

Performs only once SALOME general purpose initialisation for scripts.
Provides:
orb             reference to CORBA
lcc             a LifeCycleCorba instance
naming_service  a naming service instance
cm              reference to the container manager
esm             reference to external server manager
dsm             reference to shared dataserver manager
modulcat        reference to modulecatalog instance
sg              access to SALOME GUI (when linked with IAPP GUI)
myStudy         active study itself (CORBA reference)
myStudyName     active study name

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 KERNEL_PY.salome_init_without_session	(		path = None,
			embedded = False,
			iorfakensfile = None
	)

Force creation of all servants needed by SALOME session in the current process.
A Fake NamingService is created storing reference of all servants in the current process.

References salome_init_without_session_common().

Referenced by LogManagerLoadFromIORFile(), and salome_init().

salome_init_without_session_attached()

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

Configuration SSL inside a python interpretor launched in the SALOME_Container_No_NS_Serv.
In this configuration, a local FakeNamingService is created and remote objects are stored in it.
lcc is pointing to the FakeNamingService above.

References salome_init_without_session_common().

Referenced by salome_init().

salome_init_without_session_common()

def KERNEL_PY.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 KERNEL_PY.salome_NS

(

)

Referenced by salome_shutdown_containers_with_session().

salome_shutdown_containers()

def KERNEL_PY.salome_shutdown_containers

(

)

References salome_shutdown_containers_with_session(), and salome_shutdown_containers_without_session().

salome_shutdown_containers_with_session()

def KERNEL_PY.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 KERNEL_PY.salome_shutdown_containers_without_session

(

)

References get_all_containers().

Referenced by salome_shutdown_containers().

salome_walk_on_containers()

def KERNEL_PY.salome_walk_on_containers	(		ns,
			root
	)

Referenced by salome_shutdown_containers_with_session().

standalone()

def KERNEL_PY.standalone

(

)

Referenced by KERNEL_PY.SessionContextManager.__enter__().

withServers()

def KERNEL_PY.withServers

(

)

Variable Documentation

__all__

KERNEL_PY.__all__ = dir()

private

cm

KERNEL_PY.cm

CM_NAME_IN_NS

string KERNEL_PY.CM_NAME_IN_NS = "/ContainerManager"

dsm

KERNEL_PY.dsm

DSM_NAME_IN_NS

string KERNEL_PY.DSM_NAME_IN_NS = "/DataServerManager"

esm

KERNEL_PY.esm

ESM_NAME_IN_NS

string KERNEL_PY.ESM_NAME_IN_NS = "/ExternalServers"

flags

KERNEL_PY.flags = None

lcc

KERNEL_PY.lcc

lm

KERNEL_PY.lm

logm

KERNEL_PY.logm

LOGM_NAME_IN_NS

string KERNEL_PY.LOGM_NAME_IN_NS = "/LogManager"

MATCH_ENDING_PATTERN

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

modulcat

KERNEL_PY.modulcat

myStudy

KERNEL_PY.myStudy

myStudyName

KERNEL_PY.myStudyName

naming_service

KERNEL_PY.naming_service

orb

KERNEL_PY.orb

rm

KERNEL_PY.rm

RM_NAME_IN_NS

string KERNEL_PY.RM_NAME_IN_NS = "/ResourcesManager"

ROOT_PYTHONPACKAGE_NAME

string KERNEL_PY.ROOT_PYTHONPACKAGE_NAME = "salome"

salome_initial

bool KERNEL_PY.salome_initial = True

sg

KERNEL_PY.sg