Builder
class Builder
| kotlin.Any | |
| ↳ | android.health.connect.datatypes.ExerciseSegment.Builder |
Builder class for ExerciseSegment
Summary
| Public constructors | |
|---|---|
| Public methods | |
|---|---|
| ExerciseSegment |
build()Sets the number repetitions to the current segment. |
| ExerciseSegment.Builder |
Clears the rate of perceived exertion for this exercise segment. |
| ExerciseSegment.Builder |
Clears the set index for this exercise segment. |
| ExerciseSegment.Builder |
Clears the weight for this exercise segment. |
| ExerciseSegment.Builder |
setRateOfPerceivedExertion(rateOfPerceivedExertion: Float)Sets rate of perceived exertion (RPE) used during the exercise segment. |
| ExerciseSegment.Builder |
setRepetitionsCount(repetitionsCount: Int)Sets the number of repetitions to the current segment. |
| ExerciseSegment.Builder |
setSetIndex(setIndex: Int)Sets the set index for this exercise segment. |
| ExerciseSegment.Builder |
Sets the weight associated with this exercise segment. |
Public constructors
Builder
Builder(
startTime: Instant,
endTime: Instant,
segmentType: Int)
Public methods
build
fun build(): ExerciseSegment
Sets the number repetitions to the current segment. Returns ExerciseSegment instance.
| Return | |
|---|---|
ExerciseSegment |
This value cannot be null. |
clearRateOfPerceivedExertion
fun clearRateOfPerceivedExertion(): ExerciseSegment.Builder
Clears the rate of perceived exertion for this exercise segment.
Returns builder instance with rate of perceived exertion unset.
| Return | |
|---|---|
ExerciseSegment.Builder |
This value cannot be null. |
clearSetIndex
fun clearSetIndex(): ExerciseSegment.Builder
Clears the set index for this exercise segment.
Returns builder instance with set index unset.
| Return | |
|---|---|
ExerciseSegment.Builder |
This value cannot be null. |
clearWeight
fun clearWeight(): ExerciseSegment.Builder
Clears the weight for this exercise segment.
Returns builder instance with weight unset.
| Return | |
|---|---|
ExerciseSegment.Builder |
This value cannot be null. |
setRateOfPerceivedExertion
fun setRateOfPerceivedExertion(rateOfPerceivedExertion: Float): ExerciseSegment.Builder
Sets rate of perceived exertion (RPE) used during the 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
Returns builder instance with rate of perceived exertion set.
| Parameters | |
|---|---|
rateOfPerceivedExertion |
Float: Value is between 0.0f and 10.0f inclusive |
| Return | |
|---|---|
ExerciseSegment.Builder |
This value cannot be null. |
setRepetitionsCount
fun setRepetitionsCount(repetitionsCount: Int): ExerciseSegment.Builder
Sets the number of repetitions to the current segment. Returns builder instance with repetitions count set.
| Parameters | |
|---|---|
repetitionsCount |
Int: Value is 0 or greater |
| Return | |
|---|---|
ExerciseSegment.Builder |
This value cannot be null. |
setSetIndex
fun setSetIndex(setIndex: Int): ExerciseSegment.Builder
Sets the set index for this exercise segment.
The set index must be a non-negative integer, and should start at zero.
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.
Returns builder instance with set index set.
| Parameters | |
|---|---|
setIndex |
Int: Value is 0 or greater |
| Return | |
|---|---|
ExerciseSegment.Builder |
This value cannot be null. |
setWeight
fun setWeight(weight: Mass): ExerciseSegment.Builder
Sets the weight associated with this exercise segment.
Weight must be at least zero and not more than 2500kg.
Returns builder instance with weight set.
| Parameters | |
|---|---|
weight |
Mass: This value cannot be null. |
| Return | |
|---|---|
ExerciseSegment.Builder |
This value cannot be null. |