/*
 * Copyright (c) 2022-2023 nosqlbench
 *
 * 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 io.nosqlbench.engine.api.activityapi.core.progress;

import java.time.Instant;
import java.util.Locale;

public interface MetricProgressMeter {
    String getProgressName();

    Instant getStartTime();

    double getTargetValue();

    double getCurrentValue();


    default double getRatioComplete() {
        return getCurrentValue() / getTargetValue();
    }

    default double getPendingCount() {
        return getTargetValue() - getCurrentValue();
    }

    default String getRatioSummary() {
        double progress = getRatioComplete();
        if (Double.isNaN(progress)) {
            return "Unknown";
        }
        return String.format(Locale.US, "%3.2f%%", (100.0 * progress));
    }

}

