@stadiamaps/api
Version:
Stadia Maps Geospatial APIs
99 lines • 4.52 kB
TypeScript
/**
* 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.1.2
* 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 BaseCostingOptions
*/
export interface BaseCostingOptions {
/**
* A penalty (in seconds) applied when transitioning between roads (determined by name).
* @type {number}
* @memberof BaseCostingOptions
*/
maneuverPenalty?: number;
/**
* The estimated cost (in seconds) when a gate is encountered.
* @type {number}
* @memberof BaseCostingOptions
*/
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 BaseCostingOptions
*/
gatePenalty?: number;
/**
* The estimated cost (in seconds) when encountering an international border.
* @type {number}
* @memberof BaseCostingOptions
*/
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 BaseCostingOptions
*/
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 BaseCostingOptions
*/
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 BaseCostingOptions
*/
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 BaseCostingOptions
*/
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 BaseCostingOptions
*/
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 BaseCostingOptions
*/
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 BaseCostingOptions
*/
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 BaseCostingOptions
*/
ignoreOneways?: boolean;
}
/**
* Check if a given object implements the BaseCostingOptions interface.
*/
export declare function instanceOfBaseCostingOptions(value: object): value is BaseCostingOptions;
export declare function BaseCostingOptionsFromJSON(json: any): BaseCostingOptions;
export declare function BaseCostingOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): BaseCostingOptions;
export declare function BaseCostingOptionsToJSON(json: any): BaseCostingOptions;
export declare function BaseCostingOptionsToJSONTyped(value?: BaseCostingOptions | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=BaseCostingOptions.d.ts.map