mProcess.processAbs.Process Class Reference

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

Inheritance diagram for mProcess.processAbs.Process:

Public Member Functions
def	__init__ (self, parent=None, data=None, **kwargs)
	Constructor. More...
def	shouldInitialize (self)
	Whether this process should be initialized. More...
def	run (self)
	Run the process. More...
def	runPreDependencies (self)
	Run pre dependencies. More...
def	runPostDependencies (self)
	Run post dependencies. More...
PROPERTIES
def	data (self)
	Data. More...
def	kwargs (self)
	Keyword arguments. More...
def	preDependencyList (self)
	Pre dependencies. More...
def	postDependencyList (self)
	Post dependencies. More...
def	name (self)
	Name of the process. More...
def	description (self)
	Description about the process. More...
def	icon (self)
	Icon. More...
def	dependencyListModule (self)
	Dependency list module. More...
def	isActive (self)
	Whether this process is active. More...
def	isIgnorable (self)
	Whether this process is ignorable. More...
def	isIgnored (self)
	Whether this process is ignored. More...
def	setIgnored (self, state)
	Set the process ignored. More...
def	requiresDescriptionWhenIgnored (self)
	Whether this process requires description when ignored. More...
def	isCollapsed (self)
	Whether the process is collapsed on the GUI. More...
def	areDependenciesCollapsed (self)
	Whether dependencies are collapsed on the GUI. More...

Static Public Attributes
	signalInfoOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setInfo method.
	signalSuccessOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setSuccess method.
	signalWarningOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setWarning method.
	signalFailureOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setFailure method.
	signalStepOccurred = QtCore.Signal()
	[ Signal ] - Signal emitted when step occurs (for progress bar).

Detailed Description

[ ABSTRACT CLASS ] - Abstract dependency class.

Constructor & Destructor Documentation

__init__()

def mProcess.processAbs.Process.__init__	(		self,
			parent = None,
			data = None,
		**	kwargs
	)

Constructor.

Parameters

parent	[ QObject | None | in ] - Parent.
data	[ mProcess.dataLib.Data | None | in ] - Data.
kwargs	[ dict | None | in ] - Keyword arguments.

Exceptions

N/A

Returns

None - None.

Reimplemented in mMecoRelease.processes.releasePro.PackageRelease.

Member Function Documentation

data()

def mProcess.processAbs.Process.data

(

self

)

Data.

Exceptions

N/A

Returns

mProcess.dataLib.Data - Data.

kwargs()

def mProcess.processAbs.Process.kwargs

(

self

)

Keyword arguments.

Exceptions

N/A

Returns

dict - Keyword arguments.

preDependencyList()

def mProcess.processAbs.Process.preDependencyList

(

self

)

Pre dependencies.

Exceptions

N/A

Returns

list - Pre dependencies.

postDependencyList()

def mProcess.processAbs.Process.postDependencyList

(

self

)

Post dependencies.

Exceptions

N/A

Returns

list - Post dependencies.

name()

def mProcess.processAbs.Process.name

(

self

)

Name of the process.

Exceptions

N/A

Returns

str - Name.

description()

def mProcess.processAbs.Process.description

(

self

)

Description about the process.

Exceptions

N/A

Returns

str - Description.

icon()

def mProcess.processAbs.Process.icon

(

self

)

Icon.

Exceptions

N/A

Returns

str - Absolute path of the icon.

dependencyListModule()

def mProcess.processAbs.Process.dependencyListModule

(

self

)

Dependency list module.

Exceptions

N/A

Returns

str - Dependency list module.

isActive()

def mProcess.processAbs.Process.isActive

(

self

)

Whether this process is active.

Exceptions

N/A

Returns

bool - Value.

isIgnorable()

def mProcess.processAbs.Process.isIgnorable

(

self

)

Whether this process is ignorable.

Exceptions

N/A

Returns

bool - Value.

isIgnored()

def mProcess.processAbs.Process.isIgnored

(

self

)

Whether this process is ignored.

Exceptions

N/A

Returns

bool - Value.

setIgnored()

def mProcess.processAbs.Process.setIgnored	(		self,
			state
	)

Set the process ignored.

Parameters

state

[ bool | None | in ] - Value to be set.

Exceptions

N/A

Returns

bool - Result.

requiresDescriptionWhenIgnored()

def mProcess.processAbs.Process.requiresDescriptionWhenIgnored

(

self

)

Whether this process requires description when ignored.

Exceptions

N/A

Returns

bool - Value.

isCollapsed()

def mProcess.processAbs.Process.isCollapsed

(

self

)

Whether the process is collapsed on the GUI.

Exceptions

N/A

Returns

bool - Value.

areDependenciesCollapsed()

def mProcess.processAbs.Process.areDependenciesCollapsed

(

self

)

Whether dependencies are collapsed on the GUI.

Exceptions

N/A

Returns

bool - Value.

shouldInitialize()

def mProcess.processAbs.Process.shouldInitialize

(

self

)

Whether this process should be initialized.

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

Exceptions

N/A

Returns

bool - Result.

run()

def mProcess.processAbs.Process.run

(

self

)

Run the process.

Exceptions

mProcess.exceptionLib.ProcessError

- No run method is available for this run mode.

Returns

bool - Result.

runPreDependencies()

def mProcess.processAbs.Process.runPreDependencies

(

self

)

Run pre dependencies.

Exceptions

N/A

Returns

bool - Result.

runPostDependencies()

def mProcess.processAbs.Process.runPostDependencies

(

self

)

Run post dependencies.

Exceptions

N/A

Returns

bool - Result.

---

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

• mProcess/python/mProcess/processAbs.py