KERNEL_PY.salome_version Namespace Reference

Functions
def	getVersion (mod="KERNEL", full=False)
def	getVersionMajor (mod="KERNEL")
def	getVersionMinor (mod="KERNEL")
def	getVersionRelease (mod="KERNEL")
def	getVersions (mod="KERNEL")
def	getXVersion (mod="KERNEL")
def	isDevelopmentVersion (mod="KERNEL")

Variables
list	__ALL__
dictionary	_salome_versions = {}

Function Documentation

getVersion()

def KERNEL_PY.salome_version.getVersion	(		mod = "KERNEL",
			full = False
	)

Get SALOME module version number
Parameters:
- mod  : SALOME module name, default is 'KERNEL'
- full : take into account development marker (in this case 'dev' is added
         to the end of version value for development version), False by default
Returns: version number string or None if VERSION file is not found

Referenced by KERNEL_PY.salome_version.getVersionMajor(), KERNEL_PY.salome_version.getVersionMinor(), KERNEL_PY.salome_version.getVersionRelease(), and KERNEL_PY.salome_version.isDevelopmentVersion().

getVersionMajor()

def KERNEL_PY.salome_version.getVersionMajor

(

mod = "KERNEL"

)

Get SALOME module major version number
Parameters:
- mod  : SALOME module name, default is 'KERNEL'
Returns: version major number string or None if VERSION file is not found

References KERNEL_PY.salome_version.getVersion().

Referenced by KERNEL_PY.salome_version.getVersions().

getVersionMinor()

def KERNEL_PY.salome_version.getVersionMinor

(

mod = "KERNEL"

)

Get SALOME module minor version number
Parameters:
- mod  : SALOME module name, default is 'KERNEL'
Returns: version minor number string or None if VERSION file is not found

References KERNEL_PY.salome_version.getVersion().

Referenced by KERNEL_PY.salome_version.getVersions().

getVersionRelease()

def KERNEL_PY.salome_version.getVersionRelease

(

mod = "KERNEL"

)

Get SALOME module release version number
Parameters:
- mod  : SALOME module name, default is 'KERNEL'
Returns: version release number string or None if VERSION file is not found

References KERNEL_PY.salome_version.getVersion().

Referenced by KERNEL_PY.salome_version.getVersions().

getVersions()

def KERNEL_PY.salome_version.getVersions

(

mod = "KERNEL"

)

Get SALOME module version as list of [major, minor, release] numbers
Parameters:
- mod  : SALOME module name, default is 'KERNEL'
Returns: version numbers list

References KERNEL_PY.salome_version.getVersionMajor(), KERNEL_PY.salome_version.getVersionMinor(), and KERNEL_PY.salome_version.getVersionRelease().

Referenced by KERNEL_PY.salome_version.getXVersion().

getXVersion()

def KERNEL_PY.salome_version.getXVersion

(

mod = "KERNEL"

)

Get SALOME module version as list of [major, minor, release] numbers
Parameters:
- mod  : SALOME module name, default is 'KERNEL'
Returns: version numbers list

References KERNEL_PY.salome_version.getVersions().

isDevelopmentVersion()

def KERNEL_PY.salome_version.isDevelopmentVersion

(

mod = "KERNEL"

)

Checks if the version of SALOME module is marked as development one
Parameters:
- mod  : SALOME module name, default is 'KERNEL'
Returns: Return True for delopment version of module or False otherwise

References KERNEL_PY.salome_version.getVersion().

Variable Documentation

__ALL__

list KERNEL_PY.salome_version.__ALL__

private

Initial value:

=  [
    "getVersion",
    "getVersionMajor",
    "getVersionMinor",
    "getVersionRelease",
    "getVersions",
    "getXVersion",
    "isDevelopmentVersion",
    ]

_salome_versions

dictionary KERNEL_PY.salome_version._salome_versions = {}

private