com.sygic.sdk.route.Waypoint Class Reference

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

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

Classes
interface	Status
interface	Type

Public Member Functions
GeoCoordinates	getOriginalPosition ()
GeoCoordinates	getNavigablePosition ()
long	getDelay ()
int	getType ()
int	getStatus ()
int	getDistanceFromStart ()
String	getPayload ()
boolean	equals (final Object o)
int	hashCode ()
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< Waypoint >	CREATOR

Protected Member Functions
	Waypoint (@NonNull final GeoCoordinates originalPosition, @NonNull final GeoCoordinates navigablePosition, final long delay, final int type, final int status, final int distanceFromStart, @Nullable final String payload)
	Waypoint (final Parcel in)

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

Detailed Description

Waypoints define a route's stopovers, including its start point it's destination point and any points in between.

Constructor & Destructor Documentation

Waypoint() [1/2]

com.sygic.sdk.route.Waypoint.Waypoint ( @NonNull final GeoCoordinates  originalPosition, @NonNull final GeoCoordinates  navigablePosition, final long  delay, final int  type, final int  status, final int  distanceFromStart, @Nullable final String  payload  )

protected

Default constructor.

Waypoint() [2/2]

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

protected

Member Function Documentation

describeContents()

int com.sygic.sdk.route.Waypoint.describeContents

(

)

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

equals()

boolean com.sygic.sdk.route.Waypoint.equals

(

final Object

o

)

getDelay()

long com.sygic.sdk.route.Waypoint.getDelay

(

)

Returns the time spent at waypoint.

Returns

value representing delay in seconds

getDistanceFromStart()

int com.sygic.sdk.route.Waypoint.getDistanceFromStart

(

)

Returns the waypoint's distance from the start position

Returns

distance from start in meters or 0 if unknown

getNavigablePosition()

GeoCoordinates com.sygic.sdk.route.Waypoint.getNavigablePosition

(

)

Represents the suggested navigable position of the Waypoint - typically the coordinates on the road closest to the original position - to be used in a route calculation. Working together with the navigable position, the original position is used by the Sygic SDK for determining the side of street during arrival, and to let the calculated route approach the correct side of street, especially when there there is a physical or logical lane divider on the road. return GeoCoordinates of suggested navigable position

getOriginalPosition()

GeoCoordinates com.sygic.sdk.route.Waypoint.getOriginalPosition

(

)

Returns the original position for flag/pin. The original position is required for a route calculation.

Returns

GeoCoordinates of original position

getPayload()

String com.sygic.sdk.route.Waypoint.getPayload

(

)

Returns custom name of the waypoint.

Returns

custom name

getStatus()

int com.sygic.sdk.route.Waypoint.getStatus

(

)

Returns the waypoint Status.

Returns

Waypoint Status

getType()

int com.sygic.sdk.route.Waypoint.getType

(

)

Returns the waypoint Type.

Returns

Waypoint Type

hashCode()

int com.sygic.sdk.route.Waypoint.hashCode

(

)

writeToParcel()

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

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

Member Data Documentation

CREATOR

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

static

Initial value:

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

---

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

• Waypoint.java