sProcess.dataLib.Data Class Reference

[ CLASS ] - Data class used by all the classes. More...

Inheritance diagram for sProcess.dataLib.Data:

Public Member Functions
def	__init__ (self, runMode=RunMode.kTerminal, runLevel=RunLevel.kAll, processesToRun=[], processesToIgnore=[], ignoreFailedPreDependencies=False, ignoreFailedPostDependencies=False, raiseExceptions=False, displayMessages=DisplayMessage.kAll, userDescription=None, ignoreDescription=None)
	Constructor. More...
def	__getitem__ (self, key)
	Get item from data member. More...
def	__setitem__ (self, key, value)
	Set item of data member. More...
Properties
def	runMode (self)
	Run mode. More...
def	runLevel (self)
	Run level. More...
def	processesToRun (self)
	Processes to run. More...
def	processesToIgnore (self)
	Processes to ignore. More...
def	ignoreFailedPreDependencies (self)
	Whether to ignore failed pre dependencies. More...
def	ignoreFailedPostDependencies (self)
	Whether to ignore failed post dependencies. More...
def	raiseExceptions (self)
	Raise exceptions. More...
def	displayMessages (self)
	Display messages. More...
def	userDescription (self)
	User description. More...
def	setUserDescription (self, userDescription)
	Set user description. More...
def	ignoreDescription (self)
	Ignore description. More...
def	setIgnoreDescription (self, ignoreDescription)
	Set ignore description. More...
def	data (self)
	Data. More...

Detailed Description

[ CLASS ] - Data class used by all the classes.

Constructor & Destructor Documentation

__init__()

def sProcess.dataLib.Data.__init__	(		self,
			runMode = RunMode.kTerminal,
			runLevel = RunLevel.kAll,
			processesToRun = [],
			processesToIgnore = [],
			ignoreFailedPreDependencies = False,
			ignoreFailedPostDependencies = False,
			raiseExceptions = False,
			displayMessages = DisplayMessage.kAll,
			userDescription = None,
			ignoreDescription = None
	)

Constructor.

Parameters

runMode	[ enum | sProcess.dataLib.RunMode.kTerminal | in ] - Run mode from sProcess.dataLib.RunMode enum class.
runLevel	[ enum | sProcess.dataLib.RunLevel.kAll | in ] - Run level from sProcess.dataLib.RunLevel enum class.
processesToRun	[ list of str | [] | in ] - Processes to run.
processesToIgnore	[ list of str | [] | in ] - Processes to ignore.
ignoreFailedPreDependencies	[ bool | False | in ] - Whether to ignore failed pre dependencies.
ignoreFailedPostDependencies	[ bool | False | in ] - Whether to ignore failed post dependencies.
raiseExceptions	[ bool | False | in ] - Raise exceptions.
displayMessages	[ enum | sProcess.dataLib.DisplayMessage.kAll | in ] - Display messages from sProcess.dataLib.DisplayMessage enum class.
userDescription	[ str | None | in ] - User description.
ignoreDescription	[ str | None | in ] - Ignore description.

Exceptions

N/A

Returns

None - None.

Member Function Documentation

__getitem__()

def sProcess.dataLib.Data.__getitem__	(		self,
			key
	)

Get item from data member.

Parameters

key	[ str | None | in ] - Key.

Exceptions

N/A

Returns

variant - Value.

__setitem__()

def sProcess.dataLib.Data.__setitem__	(		self,
			key,
			value
	)

Set item of data member.

Parameters

key	[ str | None | in ] - Key.
value	[ str | None | in ] - Value.

Exceptions

N/A

Returns

None - None.

runMode()

def sProcess.dataLib.Data.runMode

(

self

)

Run mode.

Exceptions

N/A

Returns

enum - Result from sProcess.dataLib.RunMode enum class.

runLevel()

def sProcess.dataLib.Data.runLevel

(

self

)

Run level.

Exceptions

N/A

Returns

enum - Result from sProcess.dataLib.RunLevel enum class.

processesToRun()

def sProcess.dataLib.Data.processesToRun

(

self

)

Processes to run.

Exceptions

N/A

Returns

list of str - Processes.

processesToIgnore()

def sProcess.dataLib.Data.processesToIgnore

(

self

)

Processes to ignore.

Exceptions

N/A

Returns

list of str - Processes.

ignoreFailedPreDependencies()

def sProcess.dataLib.Data.ignoreFailedPreDependencies

(

self

)

Whether to ignore failed pre dependencies.

Exceptions

N/A

Returns

bool - Result.

ignoreFailedPostDependencies()

def sProcess.dataLib.Data.ignoreFailedPostDependencies

(

self

)

Whether to ignore failed post dependencies.

Exceptions

N/A

Returns

bool - Result.

raiseExceptions()

def sProcess.dataLib.Data.raiseExceptions

(

self

)

Raise exceptions.

Exceptions

N/A

Returns

bool - Result.

displayMessages()

def sProcess.dataLib.Data.displayMessages

(

self

)

Display messages.

Exceptions

N/A

Returns

enum - Result from sProcess.dataLib.DisplayMessage enum class.

userDescription()

def sProcess.dataLib.Data.userDescription

(

self

)

User description.

Exceptions

N/A

Returns

str - User description.

setUserDescription()

def sProcess.dataLib.Data.setUserDescription	(		self,
			userDescription
	)

Set user description.

Parameters

userDescription

[ str | None | in ] - User description.

Exceptions

N/A

Returns

None - None.

ignoreDescription()

def sProcess.dataLib.Data.ignoreDescription

(

self

)

Ignore description.

Exceptions

N/A

Returns

str - Ignore description.

setIgnoreDescription()

def sProcess.dataLib.Data.setIgnoreDescription	(		self,
			ignoreDescription
	)

Set ignore description.

Parameters

ignoreDescription

[ str | None | in ] - Ignore description.

Exceptions

N/A

Returns

None - None.

data()

def sProcess.dataLib.Data.data

(

self

)

Data.

Exceptions

N/A

Returns

dict - Data.

---

The documentation for this class was generated from the following file:

• sProcess/python/sProcess/dataLib.py