Skip to content

Quantified

interface Quantified : Progress.Loading

Work is currently happening, and we have some information on its progression.

By default, the progression is stored as the ratio of how much work has been done so far and the total amount of work expected. This ratio is available in two formats, normalized and percent. If this ratio of work is enough for your usage, see loading.

New implementations of this interface can be provided by downstream users to provide more information (e.g. bandwidth, estimated time of completion…).

Properties

normalized

abstract val normalized: Double

The normalized ratio of the amount of work done to the total amount of work to be done.

Allowed values are between 0.0 and 1.0, both inclusive.

  • 0.0 means the work has not started (nothing was done out of the total),

  • 1.0 means the work has finished (everything was done out of the total).

Although 1.0 is semantically the same as Progress.Done, it is still a legal value to simplify usage.

See also

percent

open val percent: Int

The percentage of the amount of work done and the total amount of work to be done.

Allowed values are between 0 and 100, both inclusive.

  • 0 means the work has not started (nothing was done out of the total),

  • 100 means the work has finished (everything was done out of the total).

Although 100 is semantically the same as Progress.Done, it is still a legal value to simplify usage.

See also