sProcess.containerAbs.Container Class Reference

[ ABSTRACT CLASS ] - Abstract container class. More...

Inheritance diagram for sProcess.containerAbs.Container:

Public Member Functions
def	__init__ (self, parent=None, data=None, dataFile=None, kwargs)
	Constructor. More...
def	__str__ (self)
	String representation. More...
def	asStr (self)
	String representation. More...
def	shouldInitialize (self)
	Whether this container should be initialized. More...
def	run (self)
	Run the container meaning running all processes and their dependencies. More...
def	runInCommandLine (cls)
	Class method which can be used to run child classes of this class in command line. More...
Properties
def	data (self)
	Data. More...
def	dataFile (self)
	Class instance that operates on data file. More...
def	setDataFile (self, dataFile)
	Set data file. More...
def	kwargs (self)
	Keyword arguments. More...
def	processList (self)
	Process list. More...
def	hasInitialized (self)
	Whether this class has been initialized. More...
def	setInitialized (self)
	Set this class initialized. More...
def	haveProcessesInitialized (self)
	Whether process classes have been initialized. More...
def	setProcessesInitialized (self)
	Set process classes initialized. 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	name (self)
	Name of the container. More...
def	description (self)
	Description about the container. More...
def	processListModule (self)
	Process list module. More...
def	requiresUserDescription (self)
	Whether this container requires user description to run. More...

Static Public Attributes
	signalInfoOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setInfo method. More...
	signalSuccessOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setSuccess method. More...
	signalWarningOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setWarning method. More...
	signalFailureOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setFailure method. More...
	signalDisplayHeader = QtCore.Signal(str)
	[ Signal ] - Signal should be used when a header needs to be displayed. More...

Detailed Description

[ ABSTRACT CLASS ] - Abstract container class.

Constructor & Destructor Documentation

__init__()

def sProcess.containerAbs.Container.__init__	(		self,
			parent = None,
			data = None,
			dataFile = None,
			kwargs
	)

Constructor.

Parameters

parent	[ QObject | None | in ] - Parent.
data	[ sProcess.dataLib.Data | None | in ] - Data.
dataFile	[ str | None | in ] - Absolute path of data file (JSON).
kwargs	[ dict | None | in ] - Keyword arguments.

Exceptions

N/A

Returns

None - None.

Member Function Documentation

__str__()

def sProcess.containerAbs.Container.__str__

(

self

)

String representation.

Exceptions

N/A

Returns

str - String representation.

data()

def sProcess.containerAbs.Container.data

(

self

)

Data.

Exceptions

N/A

Returns

sProcess.dataLib.Data - Data.

dataFile()

def sProcess.containerAbs.Container.dataFile

(

self

)

Class instance that operates on data file.

Exceptions

N/A

Returns

sFileSystem.jsonFileLib.JSONFile - Data file class instance.

setDataFile()

def sProcess.containerAbs.Container.setDataFile	(		self,
			dataFile
	)

Set data file.

Parameters

dataFile

[ str | None | in ] - Absolute path of data file (JSON).

Exceptions

sProcess.exceptionLib.DataFileDoesNotExist

- If given dataFile does not exist.

Returns

bool - Result.

kwargs()

def sProcess.containerAbs.Container.kwargs

(

self

)

Keyword arguments.

Exceptions

N/A

Returns

dict - Keyword arguments.

processList()

def sProcess.containerAbs.Container.processList

(

self

)

Process list.

Exceptions

N/A

Returns

list of sProcess.processAbs.Process - Processes.

hasInitialized()

def sProcess.containerAbs.Container.hasInitialized

(

self

)

Whether this class has been initialized.

Exceptions

N/A

Returns

bool - Result.

setInitialized()

def sProcess.containerAbs.Container.setInitialized

(

self

)

Set this class initialized.

Exceptions

N/A

Returns

None - None.

haveProcessesInitialized()

def sProcess.containerAbs.Container.haveProcessesInitialized

(

self

)

Whether process classes have been initialized.

Exceptions

N/A

Returns

bool - Result.

setProcessesInitialized()

def sProcess.containerAbs.Container.setProcessesInitialized

(

self

)

Set process classes initialized.

Exceptions

N/A

Returns

None - None.

userDescription()

def sProcess.containerAbs.Container.userDescription

(

self

)

User description.

Exceptions

N/A

Returns

str - User description.

setUserDescription()

def sProcess.containerAbs.Container.setUserDescription	(		self,
			userDescription
	)

Set user description.

Parameters

userDescription

[ str | None | in ] - User description.

Exceptions

N/A

Returns

None - None.

ignoreDescription()

def sProcess.containerAbs.Container.ignoreDescription

(

self

)

Ignore description.

Exceptions

N/A

Returns

str - Ignore description.

setIgnoreDescription()

def sProcess.containerAbs.Container.setIgnoreDescription	(		self,
			ignoreDescription
	)

Set ignore description.

Parameters

ignoreDescription

[ str | None | in ] - Ignore description.

Exceptions

N/A

Returns

None - None.

name()

def sProcess.containerAbs.Container.name

(

self

)

Name of the container.

Exceptions

N/A

Returns

str - Name.

description()

def sProcess.containerAbs.Container.description

(

self

)

Description about the container.

Exceptions

N/A

Returns

str - Description.

processListModule()

def sProcess.containerAbs.Container.processListModule

(

self

)

Process list module.

Exceptions

N/A

Returns

str - Process list module.

requiresUserDescription()

def sProcess.containerAbs.Container.requiresUserDescription

(

self

)

Whether this container requires user description to run.

Exceptions

N/A

Returns

bool - Result.

asStr()

def sProcess.containerAbs.Container.asStr

(

self

)

String representation.

Exceptions

N/A

Returns

str - String representation.

shouldInitialize()

def sProcess.containerAbs.Container.shouldInitialize

(

self

)

Whether this container should be initialized.

Implement this method to prevent child class instance from being initialized by raising sProcess.exceptionLib.ContainerError exception. Method must return True explicitly otherwise.

Exceptions

N/A

Returns

bool - Result.

run()

def sProcess.containerAbs.Container.run

(

self

)

Run the container meaning running all processes and their dependencies.

Exceptions

N/A

Returns

bool - Result.

runInCommandLine()

def sProcess.containerAbs.Container.runInCommandLine

(

cls

)

Class method which can be used to run child classes of this class in command line.

Parameters

cls	[ object | None | in ] - Class object.

Exceptions

N/A

Returns

None - None.

Member Data Documentation

signalInfoOccurred

sProcess.containerAbs.Container.signalInfoOccurred = QtCore.Signal(str)

static

[ Signal ] - Signal emitted by _setInfo method.

signalSuccessOccurred

sProcess.containerAbs.Container.signalSuccessOccurred = QtCore.Signal(str)

static

[ Signal ] - Signal emitted by _setSuccess method.

signalWarningOccurred

sProcess.containerAbs.Container.signalWarningOccurred = QtCore.Signal(str)

static

[ Signal ] - Signal emitted by _setWarning method.

signalFailureOccurred

sProcess.containerAbs.Container.signalFailureOccurred = QtCore.Signal(str)

static

[ Signal ] - Signal emitted by _setFailure method.

signalDisplayHeader

sProcess.containerAbs.Container.signalDisplayHeader = QtCore.Signal(str)

static

[ Signal ] - Signal should be used when a header needs to be displayed.

---

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

• sProcess/python/sProcess/containerAbs.py