@stadiamaps/api/dist/generated/models/TruckCostingOptions.d.ts

Stadia Maps Geospatial APIs

/**
 * Stadia Maps Geospatial APIs
 * The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 *
 * The version of the OpenAPI document: 10.0.1
 * Contact: support@stadiamaps.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/**
 *
 * @export
 * @interface TruckCostingOptions
 */
export interface TruckCostingOptions {
    /**
     * A penalty (in seconds) applied when transitioning between roads (determined by name).
     * @type {number}
     * @memberof TruckCostingOptions
     */
    maneuverPenalty?: number;
    /**
     * The estimated cost (in seconds) when a gate is encountered.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    gateCost?: number;
    /**
     * A penalty (in seconds) applied to the route cost when a gate is encountered. This penalty can be used to reduce the likelihood of suggesting a route with gates unless absolutely necessary.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    gatePenalty?: number;
    /**
     * The estimated cost (in seconds) when encountering an international border.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    countryCrossingCost?: number;
    /**
     * A penalty applied to transitions to international border crossings. This penalty can be used to reduce the likelihood of suggesting a route with border crossings unless absolutely necessary.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    countryCrossingPenalty?: number;
    /**
     * A penalty applied to transitions to service roads. This penalty can be used to reduce the likelihood of suggesting a route with service roads unless absolutely necessary. The default penalty is 15 for cars, busses, motor scooters, and motorcycles; and zero for others.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    servicePenalty?: number;
    /**
     * A factor that multiplies the cost when service roads are encountered. The default is 1.2 for cars and busses, and 1 for trucks, motor scooters, and motorcycles.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    serviceFactor?: number;
    /**
     * A measure of willingness to take living streets. Values near 0 attempt to avoid them, and values near 1 will favour them. Note that as some routes may be impossible without living streets, 0 does not guarantee avoidance of them. The default value is 0 for trucks; 0.1 for other motor vehicles; 0.5 for bicycles; and 0.6 for pedestrians.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    useLivingStreets?: number;
    /**
     * A measure of willingness to take ferries. Values near 0 attempt to avoid ferries, and values near 1 will favour them. Note that as some routes may be impossible without ferries, 0 does not guarantee avoidance of them.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    useFerry?: number;
    /**
     * If set to true, ignores any restrictions (eg: turn and conditional restrictions). Useful for matching GPS traces to the road network regardless of restrictions.
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    ignoreRestrictions?: boolean;
    /**
     * If set to true, ignores most restrictions (eg: turn and conditional restrictions), but still respects restrictions that impact vehicle safety such as weight and size.
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    ignoreNonVehicularRestrictions?: boolean;
    /**
     * If set to true, ignores directional restrictions on roads. Useful for matching GPS traces to the road network regardless of restrictions.
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    ignoreOneways?: boolean;
    /**
     * The height of the truck (in meters).
     * @type {number}
     * @memberof TruckCostingOptions
     */
    height?: number;
    /**
     * The width of the truck (in meters).
     * @type {number}
     * @memberof TruckCostingOptions
     */
    width?: number;
    /**
     * The estimated cost (in seconds) when a toll booth is encountered.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    tollBoothCost?: number;
    /**
     * A penalty (in seconds) applied to the route cost when a toll booth is encountered. This penalty can be used to reduce the likelihood of suggesting a route with toll booths unless absolutely necessary.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    tollBoothPenalty?: number;
    /**
     * The estimated cost (in seconds) when a ferry is encountered.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    ferryCost?: number;
    /**
     * A measure of willingness to take highways. Values near 0 attempt to avoid highways, and values near 1 will favour them. Note that as some routes may be impossible without highways, 0 does not guarantee avoidance of them.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    useHighways?: number;
    /**
     * A measure of willingness to take toll roads. Values near 0 attempt to avoid tolls, and values near 1 will favour them. Note that as some routes may be impossible without tolls, 0 does not guarantee avoidance of them.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    useTolls?: number;
    /**
     * A measure of willingness to take track roads. Values near 0 attempt to avoid them, and values near 1 will favour them. Note that as some routes may be impossible without track roads, 0 does not guarantee avoidance of them. The default value is 0 for automobiles, busses, and trucks; and 0.5 for all other costing modes.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    useTracks?: number;
    /**
     * The top speed (in kph) that the vehicle is capable of travelling.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    topSpeed?: number;
    /**
     * If true changes the cost metric to be quasi-shortest (pure distance-based) costing. This will disable ALL other costing factors.
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    shortest?: boolean;
    /**
     * If true, ignores all known closures. This option cannot be set if `location.search_filter.exclude_closures` is also specified.
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    ignoreClosures?: boolean;
    /**
     * If true, indicates the desire to include HOV roads with a 2-occupant requirement in the route when advantageous.
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    includeHov2?: boolean;
    /**
     * If true, indicates the desire to include HOV roads with a 3-occupant requirement in the route when advantageous.
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    includeHov3?: boolean;
    /**
     * If true, indicates the desire to include toll roads which require the driver to pay a toll if the occupant requirement isn't met
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    includeHot?: boolean;
    /**
     * A factor that multiplies the cost when alleys are encountered.
     * @type {number}
     * @memberof TruckCostingOptions
     */
    alleyFactor?: number;
    /**
     * The length of the truck (in meters).
     * @type {number}
     * @memberof TruckCostingOptions
     */
    length?: number;
    /**
     * The weight of the truck (in tonnes).
     * @type {number}
     * @memberof TruckCostingOptions
     */
    weight?: number;
    /**
     * The axle load of the truck (in tonnes).
     * @type {number}
     * @memberof TruckCostingOptions
     */
    axleLoad?: number;
    /**
     * Whether or not the truck is carrying hazardous materials.
     * @type {boolean}
     * @memberof TruckCostingOptions
     */
    hazmat?: boolean;
}
/**
 * Check if a given object implements the TruckCostingOptions interface.
 */
export declare function instanceOfTruckCostingOptions(value: object): value is TruckCostingOptions;
export declare function TruckCostingOptionsFromJSON(json: any): TruckCostingOptions;
export declare function TruckCostingOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): TruckCostingOptions;
export declare function TruckCostingOptionsToJSON(json: any): TruckCostingOptions;
export declare function TruckCostingOptionsToJSONTyped(value?: TruckCostingOptions | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=TruckCostingOptions.d.ts.map