MeasurementProgress class

Represents the current state of a measurement recording operation.

Consumers can subscribe to a stream of MeasurementProgress events to track measurement progress and detect completion.

Available extensions
Annotations
  • @freezed

Constructors

MeasurementProgress.completed({required int totalSeconds})
Measurement completed successfully.
const
factory
MeasurementProgress.failed({required String message, int? code, int? elapsedSeconds})
Measurement failed with an error.
const
factory
MeasurementProgress.idle()
Measurement has not started yet or was reset.
const
factory
MeasurementProgress.inProgress({required int elapsedSeconds, required int totalSeconds, double? fraction})
Measurement is in progress, device is recording.
const
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
isActive → bool
Whether the measurement is currently active (in progress).
no setter
isDone → bool
Whether the measurement has completed (successfully or with failure).
no setter
isSuccess → bool
Whether the measurement completed successfully.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

map<TResult extends Object?>({required TResult inProgress(MeasurementProgressInProgress value), required TResult completed(MeasurementProgressCompleted value), required TResult failed(MeasurementProgressFailed value), required TResult idle(MeasurementProgressIdle value)}) → TResult

Available on MeasurementProgress, provided by the MeasurementProgressPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>({TResult? inProgress(MeasurementProgressInProgress value)?, TResult? completed(MeasurementProgressCompleted value)?, TResult? failed(MeasurementProgressFailed value)?, TResult? idle(MeasurementProgressIdle value)?}) → TResult?

Available on MeasurementProgress, provided by the MeasurementProgressPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>({TResult inProgress(MeasurementProgressInProgress value)?, TResult completed(MeasurementProgressCompleted value)?, TResult failed(MeasurementProgressFailed value)?, TResult idle(MeasurementProgressIdle value)?, required TResult orElse()}) → TResult

Available on MeasurementProgress, provided by the MeasurementProgressPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>({TResult inProgress(int elapsedSeconds, int totalSeconds, double? fraction)?, TResult completed(int totalSeconds)?, TResult failed(String message, int? code, int? elapsedSeconds)?, TResult idle()?, required TResult orElse()}) → TResult

Available on MeasurementProgress, provided by the MeasurementProgressPatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
when<TResult extends Object?>({required TResult inProgress(int elapsedSeconds, int totalSeconds, double? fraction), required TResult completed(int totalSeconds), required TResult failed(String message, int? code, int? elapsedSeconds), required TResult idle()}) → TResult

Available on MeasurementProgress, provided by the MeasurementProgressPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>({TResult? inProgress(int elapsedSeconds, int totalSeconds, double? fraction)?, TResult? completed(int totalSeconds)?, TResult? failed(String message, int? code, int? elapsedSeconds)?, TResult? idle()?}) → TResult?

Available on MeasurementProgress, provided by the MeasurementProgressPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool
The equality operator.
inherited