com.sygic.sdk.route.RoutePlan Class Reference

Inheritance diagram for com.sygic.sdk.route.RoutePlan:

Collaboration diagram for com.sygic.sdk.route.RoutePlan:

Public Member Functions
	RoutePlan ()
void	setStart (final GeoCoordinates start)
void	setStart (final GeoCoordinates start, final @Nullable String customName)
void	setStart (final Waypoint waypoint)
Waypoint	getStart ()
void	setDestination (final GeoCoordinates destination)
void	setDestination (final GeoCoordinates destination, final @Nullable String customName)
void	setDestination (final Waypoint waypoint)
Waypoint	getDestination ()
void	addViaPoint (final GeoCoordinates viaPoint)
void	addViaPoint (final GeoCoordinates viaPoint, final @Nullable String customName)
void	addViaPoint (final Waypoint waypoint)
List< Waypoint >	getViaPoints ()
void	setRoutingOptions (final RoutingOptions options)
RoutingOptions	getRoutingOptions ()
int	describeContents ()
void	writeToParcel (final Parcel dest, final int flags)
Public Member Functions inherited from com.sygic.sdk.BaseNativeParcelable
boolean	isValidParcelable ()

Static Public Attributes
static final Parcelable.Creator< RoutePlan >	CREATOR

Protected Member Functions
	RoutePlan (final Parcel in)

Additional Inherited Members
Protected Attributes inherited from com.sygic.sdk.BaseNativeParcelable
boolean	mIsValidParcelable = true

Detailed Description

RoutePlan contains all information needed to calculate a route. It contains start, destination and waypoints.

Constructor & Destructor Documentation

RoutePlan() [1/2]

com.sygic.sdk.route.RoutePlan.RoutePlan

(

)

Default constructor.

RoutePlan() [2/2]

com.sygic.sdk.route.RoutePlan.RoutePlan ( final Parcel  in )

protected

Member Function Documentation

addViaPoint() [1/3]

void com.sygic.sdk.route.RoutePlan.addViaPoint

(

final GeoCoordinates

viaPoint

)

Adds a waypoint location to the route plan.

Parameters

viaPoint

Location of viapoint

addViaPoint() [2/3]

void com.sygic.sdk.route.RoutePlan.addViaPoint	(	final GeoCoordinates	viaPoint,
		final @Nullable String	customName
	)

Adds a waypoint location to the route plan.

Parameters

viaPoint	Location of viapoint
customName	Name of waypoint

addViaPoint() [3/3]

void com.sygic.sdk.route.RoutePlan.addViaPoint

(

final Waypoint

waypoint

)

Adds a waypoint location to the route plan.

Parameters

waypoint

Waypoint representing a waypoint location

describeContents()

int com.sygic.sdk.route.RoutePlan.describeContents

(

)

For documentation, see android.os.Parcelable.describeContents()

getDestination()

Waypoint com.sygic.sdk.route.RoutePlan.getDestination

(

)

getRoutingOptions()

RoutingOptions com.sygic.sdk.route.RoutePlan.getRoutingOptions

(

)

Returns the wanted RoutingOptions.

getStart()

Waypoint com.sygic.sdk.route.RoutePlan.getStart

(

)

Returns the GeoCoordinates of starting position.

getViaPoints()

List<Waypoint> com.sygic.sdk.route.RoutePlan.getViaPoints

(

)

Returns all the waypoints on the route.

setDestination() [1/3]

void com.sygic.sdk.route.RoutePlan.setDestination

(

final GeoCoordinates

destination

)

Sets a destination location for calculating a route.

Parameters

destination

Location of destination point

setDestination() [2/3]

void com.sygic.sdk.route.RoutePlan.setDestination	(	final GeoCoordinates	destination,
		final @Nullable String	customName
	)

Sets a destination location for calculating a route.

Parameters

destination	Location of destination point
customName	Name of destination

setDestination() [3/3]

void com.sygic.sdk.route.RoutePlan.setDestination

(

final Waypoint

waypoint

)

Sets a destination location for calculating a route.

Returns

Waypoint representing a destination location

setRoutingOptions()

void com.sygic.sdk.route.RoutePlan.setRoutingOptions

(

final RoutingOptions

options

)

Sets the route options. This method does not retain a reference to options . If the options object is updated, then this method must be called again for the changes to be in effect.

Parameters

options

The RoutingOptions to set.

setStart() [1/3]

void com.sygic.sdk.route.RoutePlan.setStart

(

final GeoCoordinates

start

)

Sets a start location for calculating a route.

Parameters

start

Location of start point

setStart() [2/3]

void com.sygic.sdk.route.RoutePlan.setStart	(	final GeoCoordinates	start,
		final @Nullable String	customName
	)

Sets a start location for calculating a route.

Parameters

start	Location of start point
customName	Name of start

setStart() [3/3]

void com.sygic.sdk.route.RoutePlan.setStart

(

final Waypoint

waypoint

)

Sets a start location for calculating a route.

Parameters

waypoint

Waypoint representing a start location

writeToParcel()

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

For documentation, see android.os.Parcelable.writeToParcel()

Member Data Documentation

CREATOR

final Parcelable.Creator<RoutePlan> com.sygic.sdk.route.RoutePlan.CREATOR

static

Initial value:

= new Parcelable.Creator<RoutePlan>() {
        @Override
        public RoutePlan createFromParcel(final Parcel source) {
            return new RoutePlan(source);
        }
 
        @Override
        public RoutePlan[] newArray(final int size) {
            return new RoutePlan[size];
        }
    }

---

The documentation for this class was generated from the following file:

• RoutePlan.java