Trio/LoopKit/LoopKit/CarbKit/AbsorbedCarbValue.swift

//
//  AbsorbedCarbValue.swift
//  LoopKit
//
//  Copyright © 2017 LoopKit Authors. All rights reserved.
//

import Foundation
import HealthKit


/// A quantity of carbs absorbed over a given date interval
public struct AbsorbedCarbValue: SampleValue {
    /// The quantity of carbs absorbed
    public let observed: HKQuantity
    /// The quantity of carbs absorbed, clamped to the original prediction
    public let clamped: HKQuantity
    /// The quantity of carbs entered as eaten
    public let total: HKQuantity
    /// The quantity of carbs expected to still absorb
    public let remaining: HKQuantity
    /// The dates over which absorption was observed
    public let observedDate: DateInterval

    /// The predicted time for the remaining carbs to absorb
    public let estimatedTimeRemaining: TimeInterval

    // Total predicted absorption time for this carb entry
    public var estimatedDate: DateInterval {
        return DateInterval(start: observedDate.start, duration: observedDate.duration + estimatedTimeRemaining)
    }
    
    /// The amount of time required to absorb observed carbs
    public let timeToAbsorbObservedCarbs: TimeInterval

    /// Whether absorption is still in-progress
    public var isActive: Bool {
        return estimatedTimeRemaining > 0
    }

    public var observedProgress: HKQuantity {
        let gram = HKUnit.gram()
        let totalGrams = total.doubleValue(for: gram)
        let percent = HKUnit.percent()

        guard totalGrams > 0 else {
            return HKQuantity(unit: percent, doubleValue: 0)
        }

        return HKQuantity(
            unit: percent,
            doubleValue: observed.doubleValue(for: gram) / totalGrams
        )
    }

    public var clampedProgress: HKQuantity {
        let gram = HKUnit.gram()
        let totalGrams = total.doubleValue(for: gram)
        let percent = HKUnit.percent()

        guard totalGrams > 0 else {
            return HKQuantity(unit: percent, doubleValue: 0)
        }

        return HKQuantity(
            unit: percent,
            doubleValue: clamped.doubleValue(for: gram) / totalGrams
        )
    }

    // MARK: SampleValue

    public var quantity: HKQuantity {
        return clamped
    }

    public var startDate: Date {
        return estimatedDate.start
    }
}