com.sygic.sdk.route.RoutingOptions Class Reference
Inheritance diagram for com.sygic.sdk.route.RoutingOptions:
Collaboration diagram for com.sygic.sdk.route.RoutingOptions:

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< RoadElementgetRoadElementsAvoids ()
 
void addTrafficAvoid (final TrafficInfo traffic)
 
void removeTrafficAvoid (final TrafficInfo traffic)
 
Set< TrafficInfogetTrafficAvoids ()
 
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< RoutingOptionsCREATOR
 

Protected Member Functions

 RoutingOptions (final Parcel in)
 

Additional Inherited Members

- Protected Attributes inherited from com.sygic.sdk.BaseNativeParcelable
boolean mIsValidParcelable = true
 

Detailed Description

Class representing complex options available to route calculation.

Constructor & Destructor Documentation

◆ RoutingOptions() [1/3]

com.sygic.sdk.route.RoutingOptions.RoutingOptions ( )

Default constructor.

◆ RoutingOptions() [2/3]

com.sygic.sdk.route.RoutingOptions.RoutingOptions ( final Parcel  in)
protected

◆ RoutingOptions() [3/3]

com.sygic.sdk.route.RoutingOptions.RoutingOptions ( @NonNull final RoutingOptions  original)

Copy constructor

Parameters
originalRoutingOptions to create copy from

Member Function Documentation

◆ addDimensionalRestriction()

void com.sygic.sdk.route.RoutingOptions.addDimensionalRestriction ( @VehicleRestrictions final int  restriction,
final int  dimension 
)

◆ addRoadElementAvoid()

void com.sygic.sdk.route.RoutingOptions.addRoadElementAvoid ( final RoadElement  element)

Set to avoid specific RoadElement.

◆ addTrafficAvoid()

void com.sygic.sdk.route.RoutingOptions.addTrafficAvoid ( final TrafficInfo  traffic)

Set to avoid some traffic events.

◆ areDetoursSuppressed()

boolean com.sygic.sdk.route.RoutingOptions.areDetoursSuppressed ( )

Returns whether detours due to temporary closed roads are suppressed or not

Returns
true if detours are suppressed, false otherwise

◆ describeContents()

int com.sygic.sdk.route.RoutingOptions.describeContents ( )

◆ equals()

boolean com.sygic.sdk.route.RoutingOptions.equals ( final Object  o)

◆ generateExtendedInfo()

boolean com.sygic.sdk.route.RoutingOptions.generateExtendedInfo ( )

Returns whether extended info should be generated

Returns
Whether extended info should be generated

◆ getAvoidableCountries()

Set<String> com.sygic.sdk.route.RoutingOptions.getAvoidableCountries ( )

Returns avoidable countries.

Returns
Set of iso codes of all avoidable countries

◆ getAvoidedCountries()

List<String> com.sygic.sdk.route.RoutingOptions.getAvoidedCountries ( )

Returns countries which are avoided

Returns
List of countries which are avoided

◆ getDepartureTime()

Date com.sygic.sdk.route.RoutingOptions.getDepartureTime ( )

Returns the desired departure timer

Returns
The desired departure timer

◆ getDimensionalRestriction()

int com.sygic.sdk.route.RoutingOptions.getDimensionalRestriction ( @VehicleRestrictions final int  restriction)

◆ getEmissionStandard()

int com.sygic.sdk.route.RoutingOptions.getEmissionStandard ( )

◆ getHazardousMaterialsClass()

int com.sygic.sdk.route.RoutingOptions.getHazardousMaterialsClass ( )

◆ getRoadElementsAvoids()

Set<RoadElement> com.sygic.sdk.route.RoutingOptions.getRoadElementsAvoids ( )

Get road elements to be avoided. This set is unmodifiable.

◆ getRouteAvoids()

Map<String, Set<Integer> > com.sygic.sdk.route.RoutingOptions.getRouteAvoids ( )

Returns all avoid for all countries.

Returns
Map of all avoids

◆ getRoutingAlternatives()

List<Integer> com.sygic.sdk.route.RoutingOptions.getRoutingAlternatives ( )

Returns which alternative types of routes should be also calculated.

Returns
list of alternative types

◆ getRoutingService()

.RoutingService int com.sygic.sdk.route.RoutingOptions.getRoutingService ( )

Returns the type of routing service for computing the route.

Returns
routingService RoutingOptions.RoutingService

◆ getRoutingType()

.RoutingType int com.sygic.sdk.route.RoutingOptions.getRoutingType ( )

Returns the route computing type.

Returns
RoutingOptions.RoutingType

◆ getTrafficAvoids()

Set<TrafficInfo> com.sygic.sdk.route.RoutingOptions.getTrafficAvoids ( )

Get traffic events to be avoided. This set is unmodifiable.

◆ getTransportMode()

.TransportMode int com.sygic.sdk.route.RoutingOptions.getTransportMode ( )

Returns the type of transport for computing the route.

Returns
RoutingOptions.TransportMode

◆ getTunnelRestriction()

int com.sygic.sdk.route.RoutingOptions.getTunnelRestriction ( )

◆ getVehicleFuelType()

int com.sygic.sdk.route.RoutingOptions.getVehicleFuelType ( )

◆ getVehicleManufacturingYear()

int com.sygic.sdk.route.RoutingOptions.getVehicleManufacturingYear ( )

Get the year when the vehicle was manufactured

Returns
year of manufacture

◆ hashCode()

int com.sygic.sdk.route.RoutingOptions.hashCode ( )

◆ isBoatFerryAvoidable()

boolean com.sygic.sdk.route.RoutingOptions.isBoatFerryAvoidable ( final String  countryIso)

Returns if the boat ferry can be avoided.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If boat ferry can be avoided

◆ isBoatFerryAvoided() [1/2]

boolean com.sygic.sdk.route.RoutingOptions.isBoatFerryAvoided ( )

Returns if the boat ferry should be avoided when computing the route.

Returns
If boat ferry is avoided

◆ isBoatFerryAvoided() [2/2]

boolean com.sygic.sdk.route.RoutingOptions.isBoatFerryAvoided ( final String  countryIso)

Returns if the boat ferry should be avoided when computing the route.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If boat ferry is avoided

◆ isCountryAvoidable()

boolean com.sygic.sdk.route.RoutingOptions.isCountryAvoidable ( final @NonNull String  countryIso)

Returns if a country can be avoided.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If country can be avoided

◆ isCountryAvoided()

boolean com.sygic.sdk.route.RoutingOptions.isCountryAvoided ( final @NonNull String  countryIso)

Returns if a country should be avoided when computing the route.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If country is avoided

◆ isHighwayAvoidable()

boolean com.sygic.sdk.route.RoutingOptions.isHighwayAvoidable ( final @NonNull String  countryIso)

Returns if the highway can be avoided.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If highway can be avoided

◆ isHighwayAvoided() [1/2]

boolean com.sygic.sdk.route.RoutingOptions.isHighwayAvoided ( )

Returns if the highway should be avoided when computing the route.

Returns
If highway is avoided

◆ isHighwayAvoided() [2/2]

boolean com.sygic.sdk.route.RoutingOptions.isHighwayAvoided ( final @NonNull String  countryIso)

Returns if the highway should be avoided when computing the route.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If highway is avoided

◆ isSpecialAreaAvoidable()

boolean com.sygic.sdk.route.RoutingOptions.isSpecialAreaAvoidable ( final @NonNull String  countryIso)

Returns if the special area can be avoided.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If special area can be avoided

◆ isSpecialAreaAvoided() [1/2]

boolean com.sygic.sdk.route.RoutingOptions.isSpecialAreaAvoided ( )

Returns if the special area should be avoided when computing the route.

Returns
If special area is avoided

◆ isSpecialAreaAvoided() [2/2]

boolean com.sygic.sdk.route.RoutingOptions.isSpecialAreaAvoided ( final @NonNull String  countryIso)

Returns if the special area should be avoided when computing the route.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If special area is avoided

◆ isTollRoadAvoidable()

boolean com.sygic.sdk.route.RoutingOptions.isTollRoadAvoidable ( final @NonNull String  countryIso)

Returns if the toll roads can be avoided.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If toll roads can be avoided

◆ isTollRoadAvoided() [1/2]

boolean com.sygic.sdk.route.RoutingOptions.isTollRoadAvoided ( )

Returns if the toll roads should be avoided when computing the route.

Returns
If toll roads is avoided

◆ isTollRoadAvoided() [2/2]

boolean com.sygic.sdk.route.RoutingOptions.isTollRoadAvoided ( final @NonNull String  countryIso)

Returns if the toll roads should be avoided when computing the route.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If toll roads is avoided

◆ isUnpavedRoadAvoidable()

boolean com.sygic.sdk.route.RoutingOptions.isUnpavedRoadAvoidable ( final @NonNull String  countryIso)

Returns if the unpaved roads can be avoided.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If unpaved roads can be avoided

◆ isUnpavedRoadAvoided() [1/2]

boolean com.sygic.sdk.route.RoutingOptions.isUnpavedRoadAvoided ( )

Returns if the unpaved roads should be avoided when computing the route.

Returns
If unpaved roads is avoided

◆ isUnpavedRoadAvoided() [2/2]

boolean com.sygic.sdk.route.RoutingOptions.isUnpavedRoadAvoided ( final @NonNull String  countryIso)

Returns if the unpaved roads should be avoided when computing the route.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
Returns
If unpaved roads is avoided

◆ removeRoadElementAvoid()

void com.sygic.sdk.route.RoutingOptions.removeRoadElementAvoid ( final RoadElement  element)

Removes the avoid of the specific road elements.

◆ removeTrafficAvoid()

void com.sygic.sdk.route.RoutingOptions.removeTrafficAvoid ( final TrafficInfo  traffic)

Removes the avoid of some traffic events.

◆ setBoatFerryAvoided() [1/2]

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.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
avoidIf to avoid or not to avoid boat ferry

◆ setBoatFerryAvoided() [2/2]

void com.sygic.sdk.route.RoutingOptions.setBoatFerryAvoided ( final boolean  avoid)

Sets the flag indicates whether boat ferry should be avoided when computing the route.

Parameters
avoidIf to avoid or not to avoid boat ferry

◆ setCountryAvoided()

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.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
avoidIf to avoid or not to avoid the country

◆ setDepartureTime()

void com.sygic.sdk.route.RoutingOptions.setDepartureTime ( @Nullable final Date  departureTime)

Sets the desired departure time Set to null to user current time

Parameters
departureTimeThe desired departure timer

◆ setEmissionStandard()

void com.sygic.sdk.route.RoutingOptions.setEmissionStandard ( @EuropeanEmissionStandard final int  emissionStandard)

◆ setGenerateExtendedInfo()

void com.sygic.sdk.route.RoutingOptions.setGenerateExtendedInfo ( final boolean  generateExtendedInfo)

Sets whether extended info should be generated

Parameters
generateExtendedInfoIf extended info should be generated or not

◆ setHazardousMaterialsClass()

void com.sygic.sdk.route.RoutingOptions.setHazardousMaterialsClass ( @HazardousMaterialsClass final int  hazMatClass)

◆ setHighwayAvoided() [1/2]

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.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
avoidIf to avoid or not to avoid highway

◆ setHighwayAvoided() [2/2]

void com.sygic.sdk.route.RoutingOptions.setHighwayAvoided ( final boolean  avoid)

Sets the flag indicates whether highway should be avoided when computing the route.

Parameters
avoidIf to avoid or not to avoid highway

◆ setRoutingAlternatives()

void com.sygic.sdk.route.RoutingOptions.setRoutingAlternatives ( @NonNull final List< Integer >  routingAlternatives)

Sets which alternative types of routes should be also calculated.

Parameters
routingAlternativeswhich alternative types should be calculated

◆ setRoutingService()

void com.sygic.sdk.route.RoutingOptions.setRoutingService ( @RoutingService final int  routingService)

Sets the type of routing service for computing the route.

Parameters
routingServiceRoutingOptions.RoutingService

◆ setRoutingType()

void com.sygic.sdk.route.RoutingOptions.setRoutingType ( @RoutingOptions.RoutingType final int  routingType)

Sets the route computing type.

Parameters
routingTypeRoutingOptions.RoutingType

◆ setSpecialAreaAvoided() [1/2]

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.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
avoidIf to avoid or not to avoid special area

◆ setSpecialAreaAvoided() [2/2]

void com.sygic.sdk.route.RoutingOptions.setSpecialAreaAvoided ( final boolean  avoid)

Sets the flag indicates whether special area should be avoided when computing the route.

Parameters
avoidIf to avoid or not to avoid special area

◆ setTollRoadAvoided() [1/2]

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.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
avoidIf to avoid or not to avoid toll roads

◆ setTollRoadAvoided() [2/2]

void com.sygic.sdk.route.RoutingOptions.setTollRoadAvoided ( final boolean  avoid)

Sets the flag indicates whether toll roads should be avoided when computing the route.

Parameters
avoidIf to avoid or not to avoid toll roads

◆ setTransportMode()

void com.sygic.sdk.route.RoutingOptions.setTransportMode ( @RoutingOptions.TransportMode final int  transportMode)

Sets the type of transport for computing the route.

Parameters
transportModeRoutingOptions.TransportMode

◆ setTunnelRestriction()

void com.sygic.sdk.route.RoutingOptions.setTunnelRestriction ( @ADRTunnelType final int  tunnelType)

◆ setUnpavedRoadAvoided() [1/2]

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.

Parameters
countryIsoIso code of country we want to apply restriction. Iso code is can be obtained via Route#getTransitCountries()
avoidIf to avoid or not to avoid unpaved roads

◆ setUnpavedRoadAvoided() [2/2]

void com.sygic.sdk.route.RoutingOptions.setUnpavedRoadAvoided ( final boolean  avoid)

Sets the flag indicates whether unpaved roads should be avoided when computing the route.

Parameters
avoidIf to avoid or not to avoid unpaved roads

◆ setUseSpeedProfiles()

void com.sygic.sdk.route.RoutingOptions.setUseSpeedProfiles ( final boolean  useSpeedProfiles)

Sets whether speed profiles should be used when computing route

Parameters
useSpeedProfilesIf speed profiles should be used

◆ setVehicleFuelType()

void com.sygic.sdk.route.RoutingOptions.setVehicleFuelType ( @VehicleFuelType final int  fuelType)

◆ setVehicleManufacturingYear()

void com.sygic.sdk.route.RoutingOptions.setVehicleManufacturingYear ( final int  yearManufactured)

Set the year when the vehicle was manufactured

Parameters
yearManufacturedyear when vehicle was manufactured

◆ suppressDetours()

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.

Parameters
suppresstrue to suppress detours caused by temporary closed roads, false to allow detours

◆ useSpeedProfiles()

boolean com.sygic.sdk.route.RoutingOptions.useSpeedProfiles ( )

Returns whether speed profiles are used when computing route

Returns
True if speed profiles are used

◆ writeToParcel()

void com.sygic.sdk.route.RoutingOptions.writeToParcel ( final Parcel  dest,
final int  flags 
)

Member Data Documentation

◆ CREATOR

final Parcelable.Creator<RoutingOptions> com.sygic.sdk.route.RoutingOptions.CREATOR
static
Initial value:
= new Parcelable.Creator<RoutingOptions>() {
@Override
public RoutingOptions createFromParcel(final Parcel source) {
return new RoutingOptions(source);
}
@Override
public RoutingOptions[] newArray(final int size) {
return new RoutingOptions[size];
}
}

The documentation for this class was generated from the following file:
com.sygic.sdk.route.RoutingOptions.RoutingOptions
RoutingOptions()
Definition: RoutingOptions.java:348