ControlObject Class Reference

Control object are used to get status information of extensive processing step and/or to interrupt those processing steps. More...

Inheritance diagram for ControlObject:

Public Member Functions
def	__init__ (self, clearAfterFinish=False, updatePrecision=0)
def	currentStepPercentage (self)
def	increaseCurrentStep (self, arg1)

Static Public Member Functions
def	currentStep (self, *args, **kwargs)
	possible calls: More...
def	stepCount (self, *args, **kwargs)
	possible calls: More...

Detailed Description

Control object are used to get status information of extensive processing step and/or to interrupt those processing steps.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			clearAfterFinish = False,
			updatePrecision = 0
	)

Parameters

self	(type: object) self pointer
clearAfterFinish	(type: object) optional parameter
updatePrecision	(type: object) optional parameter

Returns

(type: object)

Member Function Documentation

currentStep()

def currentStep (   self, *  args, **  kwargs  )

static

possible calls:

• currentStep(self, arg1: object)
• currentStep(self)

Parameters

self	(type: object) self pointer
*args	(type: list) mandatory parameter
**kwargs	(type: dict) mandatory parameter

Returns

(type: int)

currentStepPercentage()

def currentStepPercentage

(

self

)

Parameters

self	(type: ControlObject) self pointer

Returns

(type: float)

increaseCurrentStep()

def increaseCurrentStep	(		self,
			arg1
	)

Parameters

self	(type: ControlObject) self pointer
arg1	(type: object) mandatory parameter

stepCount()

def stepCount (   self, *  args, **  kwargs  )

static

possible calls:

• stepCount(self, arg1: object)
• stepCount(self)

Parameters

self	(type: object) self pointer
*args	(type: list) mandatory parameter
**kwargs	(type: dict) mandatory parameter

Returns

(type: int)