nxtomomill.utils.progress.Progress#

class nxtomomill.utils.progress.Progress(name)[source]#

Bases: object

Simple interface for defining advancement on a 100 percentage base

__init__(name)[source]#

Methods

__init__(name)

end_process()

Set advancement to 100 %

increase_advancement([i])

param int i

increase the advancement of n step

reset([max_])

reset the advancement to n and max advancement to max_ :type max_: Optional[int] :param max_: max progress value

set_advancement(value)

param int value

set advancement to value

set_max_advancement(n)

param int n

number of steps contained by the advancement. When

set_name(name)

start_process()

rtype

None

Attributes

progress

end_process()[source]#

Set advancement to 100 %

Return type

None

increase_advancement(i=1)[source]#
Parameters

i (int) – increase the advancement of n step

Return type

None

reset(max_=None)[source]#

reset the advancement to n and max advancement to max_ :type max_: Optional[int] :param max_: max progress value

Return type

None

set_advancement(value)[source]#
Parameters

value (int) – set advancement to value

Return type

None

set_max_advancement(n)[source]#
Parameters

n (int) – number of steps contained by the advancement. When advancement reach this value, advancement will be 100 %

Return type

None