ExerciseSegment
class ExerciseSegment
| kotlin.Any | |
| ↳ | android.health.connect.datatypes.ExerciseSegment |
Represents particular exercise within exercise session (see ExerciseSessionRecord).
Each record contains start and end time of the exercise, exercise type and optional number of repetitions, weight, set index and rate of perceived exertion.
Summary
| Nested classes | |
|---|---|
|
Builder class for |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Instant | |
| Float |
Gets the rate of perceived exertion (RPE) for this exercise segment. |
| Int | |
| Int | |
| Int |
Gets the set index for this exercise segment. |
| Instant | |
| Mass? |
Gets the weight associated with this exercise segment. |
| Boolean |
Returns true if this segment has an associated rate of perceived exertion. |
| Boolean |
Returns true if this segment has an associated set index. |
| Int |
hashCode()Returns a hash code value for the object. |
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getRateOfPerceivedExertion
fun getRateOfPerceivedExertion(): Float
Gets the rate of perceived exertion (RPE) for this exercise segment.
Values correspond to the Borg CR10 RPE scale and must be in the range 0 to 10 inclusive. 0: No exertion (at rest) 1: Very light 2-3: Light 4-5: Moderate 6-7: Hard 8-9: Very hard 10: Maximum effort
Use hasRateOfPerceivedExertion to check whether RPE exists for this segment.
| Return | |
|---|---|
Float |
Value is between 0.0f and 10.0f inclusive |
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if rate of perceived exertion is not set. |
getSegmentType
fun getSegmentType(): Int
getSetIndex
fun getSetIndex(): Int
Gets the set index for this exercise segment.
The set index is a non-negative integer starting at zero.
A set is a group of consecutive repetitions (reps) of a specific exercise performed without a break, e.g. 10 push-ups in a row without stopping.
A set index represents the position of this set relative to other sets in the session. For instance, if an exercise has three sets, they will have setIndex values of 0, 1, and 2 respectively.
Multiple segments may be part of a single set, for example if a collection of activities are considered to be a single set, in which case those segments would have the same set index.
The set index is may also go back to zero in a single ExerciseSession. For example, if three sets of one activity are completed followed by three sets of another, setIndex values of 0, 1, 2, 0, 1, 2 would be expected for those segments.
Use hasSetIndex to check whether a set index exists for this segment. Multiple segments can share the same set index.
| Return | |
|---|---|
Int |
Value is 0 or greater |
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
if set index is not set. |
getWeight
fun getWeight(): Mass?
Gets the weight associated with this exercise segment.
Returns null if weight is not set.
hasRateOfPerceivedExertion
fun hasRateOfPerceivedExertion(): Boolean
Returns true if this segment has an associated rate of perceived exertion.
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |