com.graphhopper.routing.util.FlagEncoder Maven / Gradle / Ivy

Go to download
/*
 *  Licensed to GraphHopper GmbH under one or more contributor
 *  license agreements. See the NOTICE file distributed with this work for
 *  additional information regarding copyright ownership.
 *
 *  GraphHopper GmbH licenses this file to you 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 com.graphhopper.routing.util;

import com.graphhopper.routing.ev.BooleanEncodedValue;
import com.graphhopper.routing.ev.DecimalEncodedValue;
import com.graphhopper.routing.ev.EncodedValueLookup;

/**
 * This class provides methods to define how a value (like speed or direction) converts to a flag
 * (currently an integer value), which is stored in an edge.
 *
 * @author Peter Karich
 */
public interface FlagEncoder extends EncodedValueLookup {

    /**
     * @return the version of this FlagEncoder to enforce none-compatibility when new attributes are
     * introduced
     */
    int getVersion();

    TransportationMode getTransportationMode();

    /**
     * @return the maximum speed in km/h
     */
    double getMaxSpeed();

    /**
     * This method returns the EncodedValue used for the direction-dependent access properties of this encoder.
     */
    BooleanEncodedValue getAccessEnc();

    /**
     * This method returns the EncodedValue used for the average speed of this encoder.
     */
    DecimalEncodedValue getAverageSpeedEnc();

    boolean supportsTurnCosts();

    /**
     * Returns true if the feature class is supported like TurnWeighting or PriorityWeighting.
     * Use support(String) instead.
     */
    boolean supports(Class feature);

    /**
     * @return true if already registered in an EncodingManager
     */
    boolean isRegistered();
}