Distance.kt
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.health.connect.client.records
import androidx.health.connect.client.aggregate.AggregateMetric
import androidx.health.connect.client.metadata.Metadata
import java.time.Instant
import java.time.ZoneOffset
/**
* Captures distance travelled by the user since the last reading, in meters. The total distance
* over an interval can be calculated by adding together all the values during the interval. The
* start time of each record should represent the start of the interval in which the distance was
* covered.
*
* If break downs are preferred in scenario of a long workout, consider writing multiple distance
* records. The start time of each record should be equal to or greater than the end time of the
* previous record.
*/
public class Distance(
/** Distance in meters. Required field. Valid range: 0-1000000. */
public val distanceMeters: Double,
override val startTime: Instant,
override val startZoneOffset: ZoneOffset?,
override val endTime: Instant,
override val endZoneOffset: ZoneOffset?,
override val metadata: Metadata = Metadata.EMPTY,
) : IntervalRecord {
init {
requireNonNegative(value = distanceMeters, name = "massKg")
}
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (other !is Distance) return false
if (distanceMeters != other.distanceMeters) return false
if (startTime != other.startTime) return false
if (startZoneOffset != other.startZoneOffset) return false
if (endTime != other.endTime) return false
if (endZoneOffset != other.endZoneOffset) return false
if (metadata != other.metadata) return false
return true
}
override fun hashCode(): Int {
var result = 0
result = 31 * result + distanceMeters.hashCode()
result = 31 * result + (startZoneOffset?.hashCode() ?: 0)
result = 31 * result + endTime.hashCode()
result = 31 * result + (endZoneOffset?.hashCode() ?: 0)
result = 31 * result + metadata.hashCode()
return result
}
companion object {
/**
* Metric identifier to retrieve the total distance from
* [androidx.health.connect.client.aggregate.AggregationResult].
*/
@JvmField
val DISTANCE_TOTAL: AggregateMetric<Double> =
AggregateMetric.doubleMetric(
"Distance",
AggregateMetric.AggregationType.TOTAL,
"distance"
)
}
}