OpenTracks/src/main/java/de/dennisguse/opentracks/stats/TrackStatistics.java

/*
 * Copyright 2010 Google Inc.
 *
 * 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 de.dennisguse.opentracks.stats;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

/**
 * Statistical data about a {@link de.dennisguse.opentracks.content.data.Track}.
 * The data in this class should be filled out by {@link TrackStatisticsUpdater}.
 *
 * @author Rodrigo Damazio
 */
//TODO Use null instead of Double.isInfinite
public class TrackStatistics {

    // The min and max elevation (meters) seen on this track.
    private final ExtremityMonitor elevationExtremities = new ExtremityMonitor();

    // The track start time. This is the system time, might not match the GPs time.
    private long startTime_ms = -1L;
    // The track stop time. This is the system time, might not match the GPS time.
    private long stopTime_ms = -1L;

    private double totalDistance_m;
    // Updated when new points are received, may be stale.
    private long totalTime_ms;
    // Based on when we believe the user is traveling.
    private long movingTime_ms;
    // The maximum speed (meters/second) that we believe is valid.
    private double maxSpeed_mps;
    // The total elevation gained (meters).
    private Float totalElevationGain_m = null;

    public TrackStatistics() {
    }

    /**
     * Copy constructor.
     *
     * @param other another statistics data object to copy from
     */
    public TrackStatistics(TrackStatistics other) {
        startTime_ms = other.startTime_ms;
        stopTime_ms = other.stopTime_ms;
        totalDistance_m = other.totalDistance_m;
        totalTime_ms = other.totalTime_ms;
        movingTime_ms = other.movingTime_ms;
        maxSpeed_mps = other.maxSpeed_mps;
        elevationExtremities.set(other.elevationExtremities.getMin(), other.elevationExtremities.getMax());
        totalElevationGain_m = other.totalElevationGain_m;
    }

    /**
     * Combines these statistics with those from another object.
     * This assumes that the time periods covered by each do not intersect.
     *
     * @param other another statistics data object
     */
    public void merge(TrackStatistics other) {
        startTime_ms = Math.min(startTime_ms, other.startTime_ms);
        stopTime_ms = Math.max(stopTime_ms, other.stopTime_ms);
        totalDistance_m += other.totalDistance_m;
        totalTime_ms += other.totalTime_ms;
        movingTime_ms += other.movingTime_ms;
        maxSpeed_mps = Math.max(maxSpeed_mps, other.maxSpeed_mps);
        if (other.elevationExtremities.hasData()) {
            elevationExtremities.update(other.elevationExtremities.getMin());
            elevationExtremities.update(other.elevationExtremities.getMax());
        }
        if (totalElevationGain_m == null) {
            if (other.totalElevationGain_m != null) {
                totalElevationGain_m = other.totalElevationGain_m;
            }
        } else {
            if (other.totalElevationGain_m != null) {
                totalElevationGain_m += other.totalElevationGain_m;
            }
        }
    }

    /**
     * Gets the track start time. The number of milliseconds since epoch.
     */
    public long getStartTime_ms() {
        return startTime_ms;
    }

    public void setStartTime_ms(long startTime_ms) {
        this.startTime_ms = startTime_ms;
    }

    public long getStopTime_ms() {
        return stopTime_ms;
    }

    public void setStopTime_ms(long stopTime_ms) {
        this.stopTime_ms = stopTime_ms;
    }

    public double getTotalDistance() {
        return totalDistance_m;
    }

    public void setTotalDistance(double totalDistance_m) {
        this.totalDistance_m = totalDistance_m;
    }

    public void addTotalDistance(double distance_m) {
        totalDistance_m += distance_m;
    }

    /**
     * Gets the total time in milliseconds that this track has been active.
     * This statistic is only updated when a new point is added to the statistics, so it may be off.
     * If you need to calculate the proper total time, use {@link #getStartTime_ms} with the current time.
     */
    public long getTotalTime() {
        return totalTime_ms;
    }

    public void setTotalTime(long totalTime_ms) {
        this.totalTime_ms = totalTime_ms;
    }

    public long getMovingTime() {
        return movingTime_ms;
    }

    public void setMovingTime(long movingTime_ms) {
        this.movingTime_ms = movingTime_ms;
    }

    public void addMovingTime(long time_ms) {
        movingTime_ms += time_ms;
    }

    /**
     * Gets the average speed in meters/second.
     * This calculation only takes into account the displacement until the last point that was accounted for in statistics.
     */
    public double getAverageSpeed() {
        if (totalTime_ms == 0L) {
            return 0.0;
        }
        return totalDistance_m / ((double) totalTime_ms / 1000.0);
    }

    /**
     * Gets the average moving speed in meters/second.
     */
    public double getAverageMovingSpeed() {
        if (movingTime_ms == 0L) {
            return 0.0;
        }
        return totalDistance_m / ((double) movingTime_ms / 1000.0);
    }

    /**
     * Gets the maximum speed in meters/second.
     */
    public double getMaxSpeed() {
        return Math.max(maxSpeed_mps, getAverageMovingSpeed());
    }

    /**
     * Sets the maximum speed.
     *
     * @param maxSpeed the maximum speed in meters/second
     */
    public void setMaxSpeed(double maxSpeed) {
        this.maxSpeed_mps = maxSpeed;
    }

    public boolean hasElevationMin() {
        return !Double.isInfinite(getMinElevation());
    }

    /**
     * Gets the minimum elevation.
     * This is calculated from the smoothed elevation, so this can actually be more than the current elevation.
     */
    public double getMinElevation() {
        return elevationExtremities.getMin();
    }

    /**
     * Sets the minimum elevation.
     *
     * @param elevation the minimum elevation in meters
     */
    public void setMinElevation(double elevation) {
        elevationExtremities.setMin(elevation);
    }

    public boolean hasElevationMax() {
        return !Double.isInfinite(getMaxElevation());
    }

    /**
     * Gets the maximum elevation.
     * This is calculated from the smoothed elevation, so this can actually be less than the current elevation.
     */
    public double getMaxElevation() {
        return elevationExtremities.getMax();
    }

    /**
     * Sets the maximum elevation.
     *
     * @param elevation_m the maximum elevation in meters
     */
    public void setMaxElevation(double elevation_m) {
        elevationExtremities.setMax(elevation_m);
    }

    /**
     * Updates a new elevation.
     *
     * @param elevation_m the elevation value in meters
     */
    public void updateElevationExtremities(double elevation_m) {
        elevationExtremities.update(elevation_m);
    }

    public boolean hasTotalElevationGain() {
        return totalElevationGain_m != null;
    }

    public @Nullable
    Float getTotalElevationGain() {
        return totalElevationGain_m;
    }

    public void setTotalElevationGain(float totalElevationGain_m) {
        this.totalElevationGain_m = totalElevationGain_m;
    }

    public void addTotalElevationGain(float gain_m) {
        if (totalElevationGain_m == null) {
            totalElevationGain_m = 0f;
        }
        totalElevationGain_m += gain_m;
    }

    @NonNull
    @Override
    public String toString() {
        return "TrackStatistics { Start Time: " + getStartTime_ms() + "; Stop Time: " + getStopTime_ms()
                + "; Total Distance: " + getTotalDistance() + "; Total Time: " + getTotalTime()
                + "; Moving Time: " + getMovingTime() + "; Max Speed: " + getMaxSpeed()
                + "; Min Elevation: " + getMinElevation() + "; Max Elevation: " + getMaxElevation()
                + "; Elevation Gain: " + getTotalElevationGain() + "}";
    }
}