DistanceWithVariableRestGoal


class DistanceWithVariableRestGoal : ExerciseCompletionGoal
kotlin.Any
   ↳ android.health.connect.datatypes.ExerciseCompletionGoal
   ↳ android.health.connect.datatypes.ExerciseCompletionGoal.DistanceWithVariableRestGoal

An ExerciseCompletionGoal that requires covering a specified distance. Additionally, the step is not complete until the specified time has elapsed. Time remaining after the specified distance has been completed should be spent resting. In the context of swimming, this is sometimes referred to as 'interval training'.

For example, a swimming coach may specify '100m @ 1min40s'. This implies: complete 100m and if you manage it in 1min30s, you will have 10s of rest prior to the next set.

Summary

Public constructors

Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Length

Returns the total distance that must be covered to complete this goal.

Duration

Returns the total duration that must elapse to complete this goal.

Int

Public constructors

DistanceWithVariableRestGoal

DistanceWithVariableRestGoal(
    distance: Length,
    duration: Duration)
Parameters
distance Length: The total distance that must be covered to complete the goal. This value cannot be null.
duration Duration: The total duration that must elapse to complete the goal. This value cannot be null.

Public methods

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getDistance

fun getDistance(): Length

Returns the total distance that must be covered to complete this goal.

Return
Length This value cannot be null.

getDuration

fun getDuration(): Duration

Returns the total duration that must elapse to complete this goal.

Return
Duration This value cannot be null.

hashCode

fun hashCode(): Int
Return
Int a hash code value for this object.