ProgressLogger

class pyopenms.ProgressLogger

Bases: object

Cython implementation of _ProgressLogger

Original C++ documentation is available here

Base class for all classes that want to report their progress

Per default the progress log is disabled. Use setLogType to enable it

Use startProgress, setProgress and endProgress for the actual logging

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: ProgressLogger) → None

Methods

__init__	Overload:
endProgress(self)	Ends the progress display
getLogType(self)	Returns the type of progress log being used
nextProgress(self)	Increment progress by 1 (according to range begin-end)
setLogType(self, in_0)	Sets the progress log that should be used.
setProgress(self, value)	Sets the current progress
startProgress(self, begin, end, label)

endProgress(self) → None

Ends the progress display

getLogType(self) → int

Returns the type of progress log being used

nextProgress(self) → None

Increment progress by 1 (according to range begin-end)

setLogType(self, in_0: int) → None

Sets the progress log that should be used. The default type is NONE!

setProgress(self, value: int) → None

Sets the current progress

startProgress(self, begin: int, end: int, label: bytes | str | String) → None