MilestoneMarkerSummary
class MilestoneMarkerSummary
The summary of metrics and state from the previously achieved milestone marker ExerciseGoal.
Summary
Public constructors |
|---|
MilestoneMarkerSummary( |
Public properties |
|
|---|---|
ExerciseGoal<Number> |
The |
Duration |
Returns the total elapsed time for which the exercise was active during this milestone, i.e. started but not paused. |
Instant |
Returns the time at which this milestone marker was reached. |
Instant |
Returns the time at which this milestone marker started being tracked. |
DataPointContainer |
Returns the |
Public constructors
MilestoneMarkerSummary
MilestoneMarkerSummary(
startTime: Instant,
endTime: Instant,
activeDuration: Duration,
achievedGoal: ExerciseGoal<Number>,
summaryMetrics: DataPointContainer
)
Public properties
achievedGoal
val achievedGoal: ExerciseGoal<Number>
The ExerciseGoal that triggered this milestone summary.
activeDuration
val activeDuration: Duration
Returns the total elapsed time for which the exercise was active during this milestone, i.e. started but not paused.
endTime
val endTime: Instant
Returns the time at which this milestone marker was reached.
startTime
val startTime: Instant
Returns the time at which this milestone marker started being tracked.
summaryMetrics
val summaryMetrics: DataPointContainer
Returns the DataPointContainer for aggregated metrics tracked between startTime and endTime i.e. during the duration of this milestone. This summary will only contain DataPoints for AggregateDataTypes.