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=1)
def	currentStepPercentage (self)
def	increaseCurrentStep (self, arg1)

Static Public Member Functions
def	currentStep (self, *args, **kwargs)
def	stepCount (self, *args, **kwargs)

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 = 1
	)

  @param self (type: object) self pointer
  @param clearAfterFinish (type: bool) optional parameter
  @param updatePrecision  (type: int) optional parameter
  @return (type: object)

Member Function Documentation

currentStep()

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

static

  possible calls:
  currentStep(self, arg1: int)
  currentStep(self)

  @param self (type: object) self pointer
  @param *args  (type: list) mandatory parameter
  @param ** kwargs  (type: dict) mandatory parameter
  @return (type: int)

currentStepPercentage()

def currentStepPercentage

(

self

)

  @param self (type: ControlObject) self pointer
  @return (type: float)

increaseCurrentStep()

def increaseCurrentStep	(		self,
			arg1
	)

  @param self (type: ControlObject) self pointer
  @param arg1 (type: int) mandatory parameter

stepCount()

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

static

  possible calls:
  stepCount(self, arg1: int)
  stepCount(self)

  @param self (type: object) self pointer
  @param *args  (type: list) mandatory parameter
  @param ** kwargs  (type: dict) mandatory parameter
  @return (type: int)