org.opentripplanner.ext.emissions.EmissionsConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

The newest version!

package org.opentripplanner.ext.emissions;

import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_5;

import org.opentripplanner.standalone.config.framework.json.NodeAdapter;

/**
 * This class is responsible for mapping emissions configuration into emissions parameters.
 */
public class EmissionsConfig {

  private int carAvgCo2PerKm;
  private double carAvgOccupancy;

  public EmissionsConfig(String parameterName, NodeAdapter root) {
    var c = root
      .of(parameterName)
      .since(V2_5)
      .summary("Emissions configuration.")
      .description(
        """
        By specifying the average CO₂ emissions of a car in grams per kilometer as well as
        the average number of passengers in a car the program is able to to perform emission
        calculations for car travel.
        """
      )
      .asObject();

    this.carAvgCo2PerKm =
      c
        .of("carAvgCo2PerKm")
        .since(V2_5)
        .summary("The average CO₂ emissions of a car in grams per kilometer.")
        .asInt(170);

    this.carAvgOccupancy =
      c
        .of("carAvgOccupancy")
        .since(V2_5)
        .summary("The average number of passengers in a car.")
        .asDouble(1.3);
  }

  public int getCarAvgCo2PerKm() {
    return carAvgCo2PerKm;
  }

  public double getCarAvgOccupancy() {
    return carAvgOccupancy;
  }
}