

Classes | |
| interface | ADRTunnelType |
| interface | EuropeanEmissionStandard |
| interface | HazardousMaterialsClass |
| interface | RouteAvoid |
| interface | RoutingAlternatives |
| interface | RoutingService |
| interface | RoutingType |
| interface | TransportMode |
| interface | VehicleFuelType |
| interface | VehicleRestrictions |
Public Member Functions | |
| RoutingOptions () | |
| void | setRoutingType (@RoutingOptions.RoutingType final int routingType) |
| .RoutingType int | getRoutingType () |
| .TransportMode int | getTransportMode () |
| void | setTransportMode (@RoutingOptions.TransportMode final int transportMode) |
| boolean | areDetoursSuppressed () |
| void | suppressDetours (final boolean suppress) |
| void | setRoutingService (@RoutingService final int routingService) |
| .RoutingService int | getRoutingService () |
| void | setRoutingAlternatives (@NonNull final List< Integer > routingAlternatives) |
| List< Integer > | getRoutingAlternatives () |
| void | setBoatFerryAvoided (final @NonNull String countryIso, final boolean avoid) |
| void | setBoatFerryAvoided (final boolean avoid) |
| boolean | isBoatFerryAvoided (final String countryIso) |
| boolean | isBoatFerryAvoidable (final String countryIso) |
| boolean | isBoatFerryAvoided () |
| void | setUnpavedRoadAvoided (final @NonNull String countryIso, final boolean avoid) |
| void | setUnpavedRoadAvoided (final boolean avoid) |
| boolean | isUnpavedRoadAvoidable (final @NonNull String countryIso) |
| boolean | isUnpavedRoadAvoided (final @NonNull String countryIso) |
| boolean | isUnpavedRoadAvoided () |
| void | setHighwayAvoided (final @NonNull String countryIso, final boolean avoid) |
| void | setHighwayAvoided (final boolean avoid) |
| boolean | isHighwayAvoidable (final @NonNull String countryIso) |
| boolean | isHighwayAvoided (final @NonNull String countryIso) |
| boolean | isHighwayAvoided () |
| void | setTollRoadAvoided (final @NonNull String countryIso, final boolean avoid) |
| void | setTollRoadAvoided (final boolean avoid) |
| boolean | isTollRoadAvoidable (final @NonNull String countryIso) |
| boolean | isTollRoadAvoided (final @NonNull String countryIso) |
| boolean | isTollRoadAvoided () |
| void | setSpecialAreaAvoided (final @NonNull String countryIso, final boolean avoid) |
| void | setSpecialAreaAvoided (final boolean avoid) |
| boolean | isSpecialAreaAvoidable (final @NonNull String countryIso) |
| boolean | isSpecialAreaAvoided (final @NonNull String countryIso) |
| boolean | isSpecialAreaAvoided () |
| void | setCountryAvoided (final @NonNull String countryIso, final boolean avoid) |
| boolean | isCountryAvoidable (final @NonNull String countryIso) |
| boolean | isCountryAvoided (final @NonNull String countryIso) |
| List< String > | getAvoidedCountries () |
| Map< String, Set< Integer > > | getRouteAvoids () |
| Set< String > | getAvoidableCountries () |
| void | addRoadElementAvoid (final RoadElement element) |
| void | removeRoadElementAvoid (final RoadElement element) |
| Set< RoadElement > | getRoadElementsAvoids () |
| void | addTrafficAvoid (final TrafficInfo traffic) |
| void | removeTrafficAvoid (final TrafficInfo traffic) |
| Set< TrafficInfo > | getTrafficAvoids () |
| boolean | generateExtendedInfo () |
| void | setGenerateExtendedInfo (final boolean generateExtendedInfo) |
| boolean | useSpeedProfiles () |
| void | setUseSpeedProfiles (final boolean useSpeedProfiles) |
| Date | getDepartureTime () |
| void | setDepartureTime (@Nullable final Date departureTime) |
| void | setTunnelRestriction (@ADRTunnelType final int tunnelType) |
| int | getTunnelRestriction () |
| void | setHazardousMaterialsClass (@HazardousMaterialsClass final int hazMatClass) |
| int | getHazardousMaterialsClass () |
| void | setVehicleFuelType (@VehicleFuelType final int fuelType) |
| int | getVehicleFuelType () |
| void | setEmissionStandard (@EuropeanEmissionStandard final int emissionStandard) |
| int | getEmissionStandard () |
| void | setVehicleManufacturingYear (final int yearManufactured) |
| int | getVehicleManufacturingYear () |
| void | addDimensionalRestriction (@VehicleRestrictions final int restriction, final int dimension) |
| int | getDimensionalRestriction (@VehicleRestrictions final int restriction) |
| boolean | equals (final Object o) |
| int | hashCode () |
| int | describeContents () |
| void | writeToParcel (final Parcel dest, final int flags) |
| RoutingOptions (@NonNull final RoutingOptions original) | |
Public Member Functions inherited from com.sygic.sdk.BaseNativeParcelable | |
| boolean | isValidParcelable () |
Static Public Attributes | |
| static final Parcelable.Creator< RoutingOptions > | CREATOR |
Protected Member Functions | |
| RoutingOptions (final Parcel in) | |
Additional Inherited Members | |
Protected Attributes inherited from com.sygic.sdk.BaseNativeParcelable | |
| boolean | mIsValidParcelable = true |
Class representing complex options available to route calculation.
| com.sygic.sdk.route.RoutingOptions.RoutingOptions | ( | ) |
Default constructor.
|
protected |
| com.sygic.sdk.route.RoutingOptions.RoutingOptions | ( | @NonNull final RoutingOptions | original | ) |
Copy constructor
| original | RoutingOptions to create copy from |
| void com.sygic.sdk.route.RoutingOptions.addDimensionalRestriction | ( | @VehicleRestrictions final int | restriction, |
| final int | dimension | ||
| ) |
| void com.sygic.sdk.route.RoutingOptions.addRoadElementAvoid | ( | final RoadElement | element | ) |
Set to avoid specific RoadElement.
| void com.sygic.sdk.route.RoutingOptions.addTrafficAvoid | ( | final TrafficInfo | traffic | ) |
Set to avoid some traffic events.
| boolean com.sygic.sdk.route.RoutingOptions.areDetoursSuppressed | ( | ) |
Returns whether detours due to temporary closed roads are suppressed or not
true if detours are suppressed, false otherwise | int com.sygic.sdk.route.RoutingOptions.describeContents | ( | ) |
| boolean com.sygic.sdk.route.RoutingOptions.equals | ( | final Object | o | ) |
| boolean com.sygic.sdk.route.RoutingOptions.generateExtendedInfo | ( | ) |
Returns whether extended info should be generated
| Set<String> com.sygic.sdk.route.RoutingOptions.getAvoidableCountries | ( | ) |
Returns avoidable countries.
| List<String> com.sygic.sdk.route.RoutingOptions.getAvoidedCountries | ( | ) |
Returns countries which are avoided
| Date com.sygic.sdk.route.RoutingOptions.getDepartureTime | ( | ) |
Returns the desired departure timer
| int com.sygic.sdk.route.RoutingOptions.getDimensionalRestriction | ( | @VehicleRestrictions final int | restriction | ) |
| int com.sygic.sdk.route.RoutingOptions.getEmissionStandard | ( | ) |
| int com.sygic.sdk.route.RoutingOptions.getHazardousMaterialsClass | ( | ) |
| Set<RoadElement> com.sygic.sdk.route.RoutingOptions.getRoadElementsAvoids | ( | ) |
Get road elements to be avoided. This set is unmodifiable.
| Map<String, Set<Integer> > com.sygic.sdk.route.RoutingOptions.getRouteAvoids | ( | ) |
Returns all avoid for all countries.
| List<Integer> com.sygic.sdk.route.RoutingOptions.getRoutingAlternatives | ( | ) |
Returns which alternative types of routes should be also calculated.
| .RoutingService int com.sygic.sdk.route.RoutingOptions.getRoutingService | ( | ) |
Returns the type of routing service for computing the route.
| .RoutingType int com.sygic.sdk.route.RoutingOptions.getRoutingType | ( | ) |
Returns the route computing type.
| Set<TrafficInfo> com.sygic.sdk.route.RoutingOptions.getTrafficAvoids | ( | ) |
Get traffic events to be avoided. This set is unmodifiable.
| .TransportMode int com.sygic.sdk.route.RoutingOptions.getTransportMode | ( | ) |
Returns the type of transport for computing the route.
| int com.sygic.sdk.route.RoutingOptions.getTunnelRestriction | ( | ) |
| int com.sygic.sdk.route.RoutingOptions.getVehicleFuelType | ( | ) |
| int com.sygic.sdk.route.RoutingOptions.getVehicleManufacturingYear | ( | ) |
Get the year when the vehicle was manufactured
| int com.sygic.sdk.route.RoutingOptions.hashCode | ( | ) |
| boolean com.sygic.sdk.route.RoutingOptions.isBoatFerryAvoidable | ( | final String | countryIso | ) |
Returns if the boat ferry can be avoided.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isBoatFerryAvoided | ( | ) |
Returns if the boat ferry should be avoided when computing the route.
| boolean com.sygic.sdk.route.RoutingOptions.isBoatFerryAvoided | ( | final String | countryIso | ) |
Returns if the boat ferry should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isCountryAvoidable | ( | final @NonNull String | countryIso | ) |
Returns if a country can be avoided.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isCountryAvoided | ( | final @NonNull String | countryIso | ) |
Returns if a country should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isHighwayAvoidable | ( | final @NonNull String | countryIso | ) |
Returns if the highway can be avoided.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isHighwayAvoided | ( | ) |
Returns if the highway should be avoided when computing the route.
| boolean com.sygic.sdk.route.RoutingOptions.isHighwayAvoided | ( | final @NonNull String | countryIso | ) |
Returns if the highway should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isSpecialAreaAvoidable | ( | final @NonNull String | countryIso | ) |
Returns if the special area can be avoided.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isSpecialAreaAvoided | ( | ) |
Returns if the special area should be avoided when computing the route.
| boolean com.sygic.sdk.route.RoutingOptions.isSpecialAreaAvoided | ( | final @NonNull String | countryIso | ) |
Returns if the special area should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isTollRoadAvoidable | ( | final @NonNull String | countryIso | ) |
Returns if the toll roads can be avoided.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isTollRoadAvoided | ( | ) |
Returns if the toll roads should be avoided when computing the route.
| boolean com.sygic.sdk.route.RoutingOptions.isTollRoadAvoided | ( | final @NonNull String | countryIso | ) |
Returns if the toll roads should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isUnpavedRoadAvoidable | ( | final @NonNull String | countryIso | ) |
Returns if the unpaved roads can be avoided.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| boolean com.sygic.sdk.route.RoutingOptions.isUnpavedRoadAvoided | ( | ) |
Returns if the unpaved roads should be avoided when computing the route.
| boolean com.sygic.sdk.route.RoutingOptions.isUnpavedRoadAvoided | ( | final @NonNull String | countryIso | ) |
Returns if the unpaved roads should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| void com.sygic.sdk.route.RoutingOptions.removeRoadElementAvoid | ( | final RoadElement | element | ) |
Removes the avoid of the specific road elements.
| void com.sygic.sdk.route.RoutingOptions.removeTrafficAvoid | ( | final TrafficInfo | traffic | ) |
Removes the avoid of some traffic events.
| void com.sygic.sdk.route.RoutingOptions.setBoatFerryAvoided | ( | final @NonNull String | countryIso, |
| final boolean | avoid | ||
| ) |
Sets the flag indicates whether boat ferry should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| avoid | If to avoid or not to avoid boat ferry |
| void com.sygic.sdk.route.RoutingOptions.setBoatFerryAvoided | ( | final boolean | avoid | ) |
Sets the flag indicates whether boat ferry should be avoided when computing the route.
| avoid | If to avoid or not to avoid boat ferry |
| void com.sygic.sdk.route.RoutingOptions.setCountryAvoided | ( | final @NonNull String | countryIso, |
| final boolean | avoid | ||
| ) |
Sets the flag indicates whether country should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| avoid | If to avoid or not to avoid the country |
| void com.sygic.sdk.route.RoutingOptions.setDepartureTime | ( | @Nullable final Date | departureTime | ) |
Sets the desired departure time Set to null to user current time
| departureTime | The desired departure timer |
| void com.sygic.sdk.route.RoutingOptions.setEmissionStandard | ( | @EuropeanEmissionStandard final int | emissionStandard | ) |
| void com.sygic.sdk.route.RoutingOptions.setGenerateExtendedInfo | ( | final boolean | generateExtendedInfo | ) |
Sets whether extended info should be generated
| generateExtendedInfo | If extended info should be generated or not |
| void com.sygic.sdk.route.RoutingOptions.setHazardousMaterialsClass | ( | @HazardousMaterialsClass final int | hazMatClass | ) |
| void com.sygic.sdk.route.RoutingOptions.setHighwayAvoided | ( | final @NonNull String | countryIso, |
| final boolean | avoid | ||
| ) |
Sets the flag indicates whether highway should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| avoid | If to avoid or not to avoid highway |
| void com.sygic.sdk.route.RoutingOptions.setHighwayAvoided | ( | final boolean | avoid | ) |
Sets the flag indicates whether highway should be avoided when computing the route.
| avoid | If to avoid or not to avoid highway |
| void com.sygic.sdk.route.RoutingOptions.setRoutingAlternatives | ( | @NonNull final List< Integer > | routingAlternatives | ) |
Sets which alternative types of routes should be also calculated.
| routingAlternatives | which alternative types should be calculated |
| void com.sygic.sdk.route.RoutingOptions.setRoutingService | ( | @RoutingService final int | routingService | ) |
Sets the type of routing service for computing the route.
| routingService | RoutingOptions.RoutingService |
| void com.sygic.sdk.route.RoutingOptions.setRoutingType | ( | @RoutingOptions.RoutingType final int | routingType | ) |
Sets the route computing type.
| routingType | RoutingOptions.RoutingType |
| void com.sygic.sdk.route.RoutingOptions.setSpecialAreaAvoided | ( | final @NonNull String | countryIso, |
| final boolean | avoid | ||
| ) |
Sets the flag indicates whether special area should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| avoid | If to avoid or not to avoid special area |
| void com.sygic.sdk.route.RoutingOptions.setSpecialAreaAvoided | ( | final boolean | avoid | ) |
Sets the flag indicates whether special area should be avoided when computing the route.
| avoid | If to avoid or not to avoid special area |
| void com.sygic.sdk.route.RoutingOptions.setTollRoadAvoided | ( | final @NonNull String | countryIso, |
| final boolean | avoid | ||
| ) |
Sets the flag indicates whether toll roads should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| avoid | If to avoid or not to avoid toll roads |
| void com.sygic.sdk.route.RoutingOptions.setTollRoadAvoided | ( | final boolean | avoid | ) |
Sets the flag indicates whether toll roads should be avoided when computing the route.
| avoid | If to avoid or not to avoid toll roads |
| void com.sygic.sdk.route.RoutingOptions.setTransportMode | ( | @RoutingOptions.TransportMode final int | transportMode | ) |
Sets the type of transport for computing the route.
| transportMode | RoutingOptions.TransportMode |
| void com.sygic.sdk.route.RoutingOptions.setTunnelRestriction | ( | @ADRTunnelType final int | tunnelType | ) |
| void com.sygic.sdk.route.RoutingOptions.setUnpavedRoadAvoided | ( | final @NonNull String | countryIso, |
| final boolean | avoid | ||
| ) |
Sets the flag indicates whether unpaved roads should be avoided when computing the route.
| countryIso | Iso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries() |
| avoid | If to avoid or not to avoid unpaved roads |
| void com.sygic.sdk.route.RoutingOptions.setUnpavedRoadAvoided | ( | final boolean | avoid | ) |
Sets the flag indicates whether unpaved roads should be avoided when computing the route.
| avoid | If to avoid or not to avoid unpaved roads |
| void com.sygic.sdk.route.RoutingOptions.setUseSpeedProfiles | ( | final boolean | useSpeedProfiles | ) |
Sets whether speed profiles should be used when computing route
| useSpeedProfiles | If speed profiles should be used |
| void com.sygic.sdk.route.RoutingOptions.setVehicleFuelType | ( | @VehicleFuelType final int | fuelType | ) |
| void com.sygic.sdk.route.RoutingOptions.setVehicleManufacturingYear | ( | final int | yearManufactured | ) |
Set the year when the vehicle was manufactured
| yearManufactured | year when vehicle was manufactured |
| void com.sygic.sdk.route.RoutingOptions.suppressDetours | ( | final boolean | suppress | ) |
Suppress unnecessary detours on temporary closed roads when waiting for road to open is shorter than potential detour.
| suppress | true to suppress detours caused by temporary closed roads, false to allow detours |
| boolean com.sygic.sdk.route.RoutingOptions.useSpeedProfiles | ( | ) |
Returns whether speed profiles are used when computing route
| void com.sygic.sdk.route.RoutingOptions.writeToParcel | ( | final Parcel | dest, |
| final int | flags | ||
| ) |
|
static |