PrivateBusOptions
public struct PrivateBusOptions : Hashable
All the options to specify how a private bus route should be calculated.
-
Specifies the common route calculation options.
Declaration
Swift
public var routeOptions: RouteOptions -
Customize textual content returned from the route calculation, such as localization, format, and unit system.
Declaration
Swift
public var textOptions: RouteTextOptions -
Options to specify restrictions for route calculations. By default no restrictions are applied.
Declaration
Swift
public var avoidanceOptions: AvoidanceOptions -
Options to specify how the tolls should be calculated, such as transponders, vehicle category, and emission type.
Declaration
Swift
public var tollOptions: TollOptions -
The options explicitly allowed by user for route calculations. By default no options are opt in.
Declaration
Swift
public var allowOptions: AllowOptions -
Specifies the number of occupants in the vehicle, including driver, can affect the vehicle’s ability to use HOV/carpool restricted lanes. Shouldn’t be less than 1 or greater than 255. Defaults to 1.
Note: This parameter has no effect unless HOV and/or HOT lane usage is enabled via
PrivateBusOptions.allowOptionsand such lanes are available in the selected country.Declaration
Swift
public var occupantsNumber: Int32 -
Specifies the last character of a vehicle’s license plate, typically used to evaluate traffic restrictions in certain environmental or low-emission zones. In cities like Bogotá, Mexico City, or Jakarta, specific license plate digits may be restricted on certain days or in certain areas to reduce congestion and emissions. When this value is provided, the HERE SDK considers it during route calculation to avoid roads or areas where your vehicle may be restricted based on local regulations. Example usage: “7”, when the license plate of a vehicle looks like “B-ET-182487”.
If this value is not set, such license plate-based restrictions are ignored, and routing is performed without considering them.
Declaration
Swift
public var lastCharacterOfLicensePlate: String? -
Segments with restriction on maximum baseSpeed.
Declaration
Swift
public var maxSpeedOnSegments: [MaxSpeedOnSegment] -
Detailed bus specifications such as dimensions and weight.
Note: Some members of
bus_specificationshave limited value range.BusSpecifications.grossWeightInKilogramsmust not be negative.BusSpecifications.heightInCentimetersmust be in the range [0, 5000].BusSpecifications.widthInCentimetersmust be in the range [0, 5000].BusSpecifications.lengthInCentimetersmust be in the range [0, 30000]. The validation of the range is done in the method that takesPrivateBusOptionsas parameter.
Declaration
Swift
public var busSpecifications: BusSpecifications -
init(routeOptions:textOptions: avoidanceOptions: tollOptions: allowOptions: occupantsNumber: lastCharacterOfLicensePlate: maxSpeedOnSegments: busSpecifications: ) Creates a new instance.
Parameters
- routeOptions: Specifies the common route calculation options.
- textOptions: Customize textual content returned from the route calculation, such as localization, format, and unit system.
- avoidanceOptions: Options to specify restrictions for route calculations. By default no restrictions are applied.
- tollOptions: Options to specify how the tolls should be calculated, such as transponders, vehicle category, and emission type.
- allowOptions: The options explicitly allowed by user for route calculations. By default no options are opt in.
- occupantsNumber: Specifies the number of occupants in the vehicle, including driver, can affect the vehicle’s ability to use HOV/carpool restricted lanes. Shouldn’t be less than 1 or greater than 255. Defaults to 1.
Note: This parameter has no effect unless HOV and/or HOT lane usage is enabled via
PrivateBusOptions.allowOptionsand such lanes are available in the selected country.- lastCharacterOfLicensePlate: Specifies the last character of a vehicle’s license plate, typically used to evaluate traffic restrictions in certain environmental or low-emission zones. In cities like Bogotá, Mexico City, or Jakarta, specific license plate digits may be restricted on certain days or in certain areas to reduce congestion and emissions. When this value is provided, the HERE SDK considers it during route calculation to avoid roads or areas where your vehicle may be restricted based on local regulations. Example usage: “7”, when the license plate of a vehicle looks like “B-ET-182487”.
If this value is not set, such license plate-based restrictions are ignored, and routing is performed without considering them.
- maxSpeedOnSegments: Segments with restriction on maximum baseSpeed.
- busSpecifications: Detailed bus specifications such as dimensions and weight.
Note: Some members of
bus_specificationshave limited value range.BusSpecifications.grossWeightInKilogramsmust not be negative.BusSpecifications.heightInCentimetersmust be in the range [0, 5000].BusSpecifications.widthInCentimetersmust be in the range [0, 5000].BusSpecifications.lengthInCentimetersmust be in the range [0, 30000]. The validation of the range is done in the method that takesPrivateBusOptionsas parameter.
Declaration
Swift
public init(routeOptions: RouteOptions = RouteOptions(), textOptions: RouteTextOptions = RouteTextOptions(), avoidanceOptions: AvoidanceOptions = AvoidanceOptions(), tollOptions: TollOptions = TollOptions(), allowOptions: AllowOptions = AllowOptions(), occupantsNumber: Int32 = 1, lastCharacterOfLicensePlate: String? = nil, maxSpeedOnSegments: [MaxSpeedOnSegment] = [], busSpecifications: BusSpecifications = BusSpecifications())