ControlObject Class Reference
Control object are used to get status information of extensive processing step and/or to interrupt those processing steps. More...
Public Member Functions | |
| def | __init__ |
| def | currentStep |
| def | currentStep |
| def | currentStepPercentage |
| def | increaseCurrentStep |
| def | stepCount |
| def | stepCount |
Detailed Description
Control object are used to get status information of extensive processing step and/or to interrupt those processing steps.
Constructor & Destructor Documentation
| def __init__ | ( | self, | |
clearAfterFinish = False, |
|||
updatePrecision = 1 |
|||
| ) |
- Parameters
-
self (type: object) self pointer clearAfterFinish (type: bool) optional parameter updatePrecision (type: int) optional parameter
- Returns
- (type: object)
Member Function Documentation
| def currentStep | ( | self, | |
| arg1 | |||
| ) |
- Parameters
-
self (type: ControlObject) self pointer arg1 (type: long) mandatory parameter
Referenced by ControlObject.currentStep().
| def currentStep | ( | self | ) |
- Parameters
-
self (type: ControlObject) self pointer
- Returns
- (type: int)
References ControlObject.currentStep().
| def currentStepPercentage | ( | self | ) |
- Parameters
-
self (type: ControlObject) self pointer
- Returns
- (type: float)
| def increaseCurrentStep | ( | self, | |
| arg1 | |||
| ) |
- Parameters
-
self (type: ControlObject) self pointer arg1 (type: long) mandatory parameter
| def stepCount | ( | self, | |
| arg1 | |||
| ) |
- Parameters
-
self (type: ControlObject) self pointer arg1 (type: long) mandatory parameter
Referenced by ControlObject.stepCount().
| def stepCount | ( | self | ) |
- Parameters
-
self (type: ControlObject) self pointer
- Returns
- (type: int)
References ControlObject.stepCount().
