org.opentripplanner.standalone.config.buildconfig.TransferConfig Maven / Gradle / Ivy

Go to download

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

The newest version!

package org.opentripplanner.standalone.config.buildconfig;

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

import java.util.EnumMap;
import java.util.Map;
import org.opentripplanner.graph_builder.module.TransferParameters;
import org.opentripplanner.routing.api.request.StreetMode;
import org.opentripplanner.standalone.config.framework.json.NodeAdapter;

public class TransferConfig {

  public static Map map(NodeAdapter root, String parameterName) {
    return root
      .of(parameterName)
      .since(V2_7)
      .summary("Configures mode-specific properties for transfer calculations.")
      .description(
        """
        This field enables configuring mode-specific parameters for transfer calculations.
        To configure mode-specific parameters, the modes should also be used in the `transferRequests` field in the build config.

        **Example**

        ```JSON
        // build-config.json
        {
          "transferParametersForMode": {
            "CAR": {
              "disableDefaultTransfers": true,
              "carsAllowedStopMaxTransferDuration": "3h"
            },
            "BIKE": {
              "maxTransferDuration": "30m",
              "carsAllowedStopMaxTransferDuration": "3h"
            }
          }
        }
        ```
        """
      )
      .asEnumMap(StreetMode.class, TransferParametersMapper::map, new EnumMap<>(StreetMode.class));
  }
}