MilestoneMarkerSummary


class MilestoneMarkerSummary


The summary of metrics and state from the previously achieved milestone marker ExerciseGoal.

Summary

Public constructors

MilestoneMarkerSummary(
    startTime: Instant,
    endTime: Instant,
    activeDuration: Duration,
    achievedGoal: ExerciseGoal<Number>,
    summaryMetrics: DataPointContainer
)

Public functions

open String

Public properties

ExerciseGoal<Number>

The ExerciseGoal that triggered this milestone summary.

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 DataPointContainer for aggregated metrics tracked between startTime and endTime i.e. during the duration of this milestone.

Public constructors

MilestoneMarkerSummary

Added in 1.0.0
MilestoneMarkerSummary(
    startTime: Instant,
    endTime: Instant,
    activeDuration: Duration,
    achievedGoal: ExerciseGoal<Number>,
    summaryMetrics: DataPointContainer
)

Public functions

toString

open fun toString(): String

Public properties

achievedGoal

Added in 1.0.0
val achievedGoalExerciseGoal<Number>

The ExerciseGoal that triggered this milestone summary.

activeDuration

Added in 1.0.0
val activeDurationDuration

Returns the total elapsed time for which the exercise was active during this milestone, i.e. started but not paused.

endTime

Added in 1.0.0
val endTimeInstant

Returns the time at which this milestone marker was reached.

startTime

Added in 1.0.0
val startTimeInstant

Returns the time at which this milestone marker started being tracked.

summaryMetrics

Added in 1.0.0
val summaryMetricsDataPointContainer

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.