salomeContext.SalomeContext Class Reference

Public Member Functions
def	__init__ (self, Optional[List[str]] configFileNames=None, str name="salome")
Tuple[bytes, bytes, Union[int, Any]]	runSalome (self, List[str] args)
None	addToPath (self, str value)
None	addToLdLibraryPath (self, str value)
None	addToDyldLibraryPath (self, str value)
None	addToPythonPath (self, str value)
None	addToTestsPath (self, str value)
None	setVariable (self, name, str value, bool overwrite=False)
None	setDefaultValue (self, str name, Any value)
None	unsetVariable (self, str name)
None	addToVariable (self, str name, Any value, str separator=os.pathsep)
def	appendVariable (self, name, value, separator=os.pathsep)
def	removeFromVariable (self, name, value, separator=os.pathsep)
def	__getstate__ (self)
def	__setstate__ (self, d)
def	getLogger (self)

Data Fields
	configFileNames
	name

Private Member Functions
None	__setContextFromConfigFiles (self)
None	__loadEnvModules (self, List[str] env_modules)
Tuple[Optional[str], List[str]]	__parseArguments (self, List[str] args)
	This begins the private section #. More...
int	_startSalome (self, List[str] args)
int	__setContextFromConfigFile (self, str filename, Optional[List[str]] reserved=None)
int	_runAppli (self, Optional[List[str]] args=None)
int	_sessionless (self, Optional[List[str]] args=None)
int	_setContext (self, Optional[List[str]] args=None)
int	_runSession (self, Optional[List[str]] args=None)
int	_runRemote (self, Optional[List[str]] args=None)
int	_runConsole (self, Optional[List[str]] args=None)
int	_kill (self, Optional[List[str]] args=None)
int	_killAll (self, Optional[List[str]] args=None)
int	_runTests (self, Optional[List[str]] args=None)
None	_showSoftwareVersions (self, Optional[List[str]] softwares=None)
int	_showInfo (self, Optional[List[str]] args=None)
int	_showDoc (self, Optional[List[str]] args=None)
None	_usage (self, Optional[List[str]] unused=None)
None	_makeCoffee (self, Optional[List[str]] unused=None)
None	_getCar (self, Optional[List[str]] unused=None)

Private Attributes
	_logger

Detailed Description

The SalomeContext class in an API to configure SALOME context then
start SALOME using a single python command.

Initialize context from a list of configuration files
identified by their names.
These files should be in appropriate .cfg format.

Constructor & Destructor Documentation

__init__()

def salomeContext.SalomeContext.__init__	(		self,
		Optional[List[str]]	configFileNames = None,
		str	name = "salome"
	)

References salomeContext.SalomeContext.getLogger().

Member Function Documentation

__getstate__()

def salomeContext.SalomeContext.__getstate__

(

self

)

__loadEnvModules()

None salomeContext.SalomeContext.__loadEnvModules (   self, List[str]  env_modules  )

private

Referenced by salomeContext.SalomeContext.runSalome().

__parseArguments()

Tuple[Optional[str], List[str]] salomeContext.SalomeContext.__parseArguments (   self, List[str]  args  )

private

This begins the private section #.

Referenced by salomeContext.SalomeContext._startSalome().

__setContextFromConfigFile()

int salomeContext.SalomeContext.__setContextFromConfigFile (   self, str  filename, Optional[List[str]]   reserved = None  )

private

References salomeContext.SalomeContext.addToVariable(), IDLparser.error(), salomeContext.SalomeContext.getLogger(), salomeContext.SalomeContext.setDefaultValue(), salomeContext.SalomeContext.setVariable(), and salomeContext.SalomeContext.unsetVariable().

Referenced by salomeContext.SalomeContext.__setContextFromConfigFiles().

__setContextFromConfigFiles()

None salomeContext.SalomeContext.__setContextFromConfigFiles (   self )

private

References salomeContext.SalomeContext.__setContextFromConfigFile(), salomeContext.SalomeContext.configFileNames, IDLparser.error(), and salomeContext.SalomeContext.getLogger().

Referenced by salomeContext.SalomeContext.runSalome().

__setstate__()

def salomeContext.SalomeContext.__setstate__	(		self,
			d
	)

_getCar()

None salomeContext.SalomeContext._getCar (   self, Optional[List[str]]   unused = None  )

private

_kill()

int salomeContext.SalomeContext._kill (   self, Optional[List[str]]   args = None  )

private

References setenv.main().

_killAll()

int salomeContext.SalomeContext._killAll (   self, Optional[List[str]]   args = None  )

private

References PortManager.getBusyPorts(), killSalome.killAllPorts(), addToKillList.killList(), and setenv.main().

_makeCoffee()

None salomeContext.SalomeContext._makeCoffee (   self, Optional[List[str]]   unused = None  )

private

_runAppli()

int salomeContext.SalomeContext._runAppli (   self, Optional[List[str]]   args = None  )

private

References setenv.main(), and runSalomeOld.runSalome().

_runConsole()

int salomeContext.SalomeContext._runConsole (   self, Optional[List[str]]   args = None  )

private

References runConsole.connect(), and setenv.main().

_runRemote()

int salomeContext.SalomeContext._runRemote (   self, Optional[List[str]]   args = None  )

private

References setenv.main(), and runRemote.runRemote().

_runSession()

int salomeContext.SalomeContext._runSession (   self, Optional[List[str]]   args = None  )

private

References runSession.configureSession(), setenv.main(), and runSession.runSession().

_runTests()

int salomeContext.SalomeContext._runTests (   self, Optional[List[str]]   args = None  )

private

References setenv.main(), and runTests.runTests().

_sessionless()

int salomeContext.SalomeContext._sessionless (   self, Optional[List[str]]   args = None  )

private

References setenv.main().

Referenced by salomeContext.SalomeContext._showInfo().

_setContext()

int salomeContext.SalomeContext._setContext (   self, Optional[List[str]]   args = None  )

private

_showDoc()

int salomeContext.SalomeContext._showDoc (   self, Optional[List[str]]   args = None  )

private

_showInfo()

int salomeContext.SalomeContext._showInfo (   self, Optional[List[str]]   args = None  )

private

References salomeContext.SalomeContext._sessionless(), salomeContext.SalomeContext._showSoftwareVersions(), and PortManager.getBusyPorts().

_showSoftwareVersions()

None salomeContext.SalomeContext._showSoftwareVersions (   self, Optional[List[str]]   softwares = None  )

private

Referenced by salomeContext.SalomeContext._showInfo().

_startSalome()

int salomeContext.SalomeContext._startSalome (   self, List[str]  args  )

private

Run SALOME!
Args consist in a mandatory command followed by optional parameters.
See usage for details on commands.

References salomeContext.SalomeContext.__parseArguments(), setenv.add_path(), IDLparser.error(), salomeContext.SalomeContext.getLogger(), study_exchange_vars.Variable.name, salomeContext.SalomeContext.name, Engines::Superv_Component::multiple_param.name, Engines::Container.name, Engines::SfState.name, Engines::Parameter.name, SALOME_ModuleCatalog::MemberDefinition.name, SALOME_ModuleCatalog::TypeDefinition.name, SALOME_ModuleCatalog::ComponentDef.name, SALOME_TYPES::Parameter.name, Registry::Infos.name, Engines::ResourceParameters.name, Engines::ResourceDefinition.name, Abstract_Engines_Container_i.name(), KERNEL_PY.kernel.parametric.study_exchange_vars.Variable.name, ResourceDefinition_cpp.name, ParserParameter.name, ParserDataStreamParameter.name, ParserService.name, ParserInterface.name, ParserComponent.name, ParserType.name, IDLparser.Tree.name, Engines_Parallel_Container_i.name(), SALOME_ContainerScriptPerfLog.name(), resourceParams.name, Identity.name(), and salomeContext.usage().

_usage()

None salomeContext.SalomeContext._usage (   self, Optional[List[str]]   unused = None  )

private

References salomeContext.usage().

addToDyldLibraryPath()

None salomeContext.SalomeContext.addToDyldLibraryPath	(		self,
		str	value
	)

Append value to DYLD_LIBRARY_PATH environment variable

References salomeContext.SalomeContext.addToVariable().

addToLdLibraryPath()

None salomeContext.SalomeContext.addToLdLibraryPath	(		self,
		str	value
	)

Append value to LD_LIBRARY_PATH environment variable

References salomeContext.SalomeContext.addToVariable().

addToPath()

None salomeContext.SalomeContext.addToPath	(		self,
		str	value
	)

Append value to PATH environment variable

References salomeContext.SalomeContext.addToVariable().

addToPythonPath()

None salomeContext.SalomeContext.addToPythonPath	(		self,
		str	value
	)

Append value to PYTHONPATH environment variable

References salomeContext.SalomeContext.addToVariable().

addToTestsPath()

None salomeContext.SalomeContext.addToTestsPath	(		self,
		str	value
	)

Append value to SALOME_TESTS_PATH environnement variable

References salomeContext.SalomeContext.appendVariable().

addToVariable()

None salomeContext.SalomeContext.addToVariable	(		self,
		str	name,
		Any	value,
		str	separator = os.pathsep
	)

Prepend value to environment variable

References salomeContext.SalomeContext.getLogger().

Referenced by salomeContext.SalomeContext.__setContextFromConfigFile(), salomeContext.SalomeContext.addToDyldLibraryPath(), salomeContext.SalomeContext.addToLdLibraryPath(), salomeContext.SalomeContext.addToPath(), and salomeContext.SalomeContext.addToPythonPath().

appendVariable()

def salomeContext.SalomeContext.appendVariable	(		self,
			name,
			value,
			separator = os.pathsep
	)

Append a variable

References salomeContext.SalomeContext.getLogger().

Referenced by salomeContext.SalomeContext.addToTestsPath().

getLogger()

def salomeContext.SalomeContext.getLogger

(

self

)

Referenced by salomeContext.SalomeContext.__init__(), salomeContext.SalomeContext.__setContextFromConfigFile(), salomeContext.SalomeContext.__setContextFromConfigFiles(), salomeContext.SalomeContext._startSalome(), salomeContext.SalomeContext.addToVariable(), salomeContext.SalomeContext.appendVariable(), salomeContext.SalomeContext.removeFromVariable(), salomeContext.SalomeContext.setDefaultValue(), salomeContext.SalomeContext.setVariable(), and salomeContext.SalomeContext.unsetVariable().

removeFromVariable()

def salomeContext.SalomeContext.removeFromVariable	(		self,
			name,
			value,
			separator = os.pathsep
	)

Remove value from environment variable

References salomeContext.SalomeContext.getLogger().

runSalome()

Tuple[bytes, bytes, Union[int, Any]] salomeContext.SalomeContext.runSalome	(		self,
		List[str]	args
	)

References salomeContext.SalomeContext.__loadEnvModules(), and salomeContext.SalomeContext.__setContextFromConfigFiles().

setDefaultValue()

None salomeContext.SalomeContext.setDefaultValue	(		self,
		str	name,
		Any	value
	)

Set environment variable only if it is undefined.

References salomeContext.SalomeContext.getLogger().

Referenced by salomeContext.SalomeContext.__setContextFromConfigFile().

setVariable()

None salomeContext.SalomeContext.setVariable	(		self,
			name,
		str	value,
		bool	overwrite = False
	)

Set environment variable to value

References IDLparser.error(), and salomeContext.SalomeContext.getLogger().

Referenced by salomeContext.SalomeContext.__setContextFromConfigFile().

unsetVariable()

None salomeContext.SalomeContext.unsetVariable	(		self,
		str	name
	)

Unset environment variable

References salomeContext.SalomeContext.getLogger().

Referenced by salomeContext.SalomeContext.__setContextFromConfigFile().

Field Documentation

_logger

salomeContext.SalomeContext._logger

private

configFileNames

salomeContext.SalomeContext.configFileNames

Referenced by salomeContext.SalomeContext.__setContextFromConfigFiles().

name

salomeContext.SalomeContext.name

Referenced by IDLparser.Tree.__repr__(), salomeContext.SalomeContext._startSalome(), IDLparser.Tree.getNode(), and IDLparser.Tree.output_xml().