com.oym.indoor

Class Route

java.lang.Object

com.oym.indoor.Route

public class Route
extends java.lang.Object

This class includes the resulting route.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	arePropsFulfilled Flag telling whether the properties are fulfilled to compute the route
double	distance Route distance in meters
java.util.List<Instruction>	instructions List of Instruction to follow
java.util.ArrayList<RoutePoint>	route List of RoutePoint containing the route
int	time Route time in seconds

Constructor Summary

Constructors

Constructor and Description
Route(java.util.ArrayList<RoutePoint> route, java.util.List<Instruction> instructions, double distance, int time, boolean props) Route constructor.

Method Summary

Modifier and Type	Method and Description
RouteProjectedPoint	getProjectedPoint(LocationResult loc) This method returns the projection of the user position to the route.
RoutingResult	getProjection(LocationResult loc) This method returns a RoutingResult object to be used.
Instruction	getRouteInstruction(LocationResult loc) This method returns the next instruction to be shown according to the user position.
java.lang.String	toJson() This method provides compatibility by returning relevant info into a JSON String.
java.lang.String	toString() This method provides a String that contains a JSON array with the RoutePoint objects for the start and end points, as well as the date when the route was logged, in this order, encoded in a JSON string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

route

public final java.util.ArrayList<RoutePoint> route

List of RoutePoint containing the route

instructions

public final java.util.List<Instruction> instructions

List of Instruction to follow

distance

public final double distance

Route distance in meters

time

public final int time

Route time in seconds

arePropsFulfilled

public final boolean arePropsFulfilled

Flag telling whether the properties are fulfilled to compute the route

Constructor Detail

Route

public Route(java.util.ArrayList<RoutePoint> route,
             java.util.List<Instruction> instructions,
             double distance,
             int time,
             boolean props)

Route constructor.

Parameters:

route - List of RoutePoint containing the list

instructions - List of Instruction

distance - Route distance [meters]

time - Route time [seconds]

Method Detail

toJson

public java.lang.String toJson()

This method provides compatibility by returning relevant info into a JSON String.

Returns:

A JSON String including the encoded info, null if an error occurs

toString

public java.lang.String toString()

This method provides a String that contains a JSON array with the RoutePoint objects for the start and end points, as well as the date when the route was logged, in this order, encoded in a JSON string.

Overrides:

toString in class java.lang.Object

Returns:

The encoded JSON string

getRouteInstruction

public Instruction getRouteInstruction(LocationResult loc)

This method returns the next instruction to be shown according to the user position.

Parameters:

loc - Current user position

Returns:

The next instruction to be shown, null if not available

getProjectedPoint

public RouteProjectedPoint getProjectedPoint(LocationResult loc)

This method returns the projection of the user position to the route.

Parameters:

loc - Current user position

Returns:

The projected point into the route

getProjection

public RoutingResult getProjection(LocationResult loc)

This method returns a RoutingResult object to be used.

Parameters:

loc - Current user position

Returns:

An object including all the relevant information