MilestoneMarkerSummary
public final class MilestoneMarkerSummary
The summary of metrics and state from the previously achieved milestone marker ExerciseGoal.
Summary
Public constructors |
|---|
MilestoneMarkerSummary( |
Public methods |
|
|---|---|
final @NonNull ExerciseGoal<@NonNull Number> |
The |
final @NonNull Duration |
Returns the total elapsed time for which the exercise was active during this milestone, i.e. started but not paused. |
final @NonNull Instant |
Returns the time at which this milestone marker was reached. |
final @NonNull Instant |
Returns the time at which this milestone marker started being tracked. |
final @NonNull DataPointContainer |
Returns the |
@NonNull String |
toString() |
Public constructors
MilestoneMarkerSummary
public MilestoneMarkerSummary(
@NonNull Instant startTime,
@NonNull Instant endTime,
@NonNull Duration activeDuration,
@NonNull ExerciseGoal<@NonNull Number> achievedGoal,
@NonNull DataPointContainer summaryMetrics
)
Public methods
getAchievedGoal
public final @NonNull ExerciseGoal<@NonNull Number> getAchievedGoal()
The ExerciseGoal that triggered this milestone summary.
getActiveDuration
public final @NonNull Duration getActiveDuration()
Returns the total elapsed time for which the exercise was active during this milestone, i.e. started but not paused.
getEndTime
public final @NonNull Instant getEndTime()
Returns the time at which this milestone marker was reached.
getStartTime
public final @NonNull Instant getStartTime()
Returns the time at which this milestone marker started being tracked.
getSummaryMetrics
public final @NonNull DataPointContainer getSummaryMetrics()
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.