com.pb.routing.gra.route

Class GetRouteResponse

java.lang.Object

com.pb.routing.gra.route.GetRouteResponse

All Implemented Interfaces:

Serializable

public final class GetRouteResponse
extends Object
implements Serializable

Response object generated after route calculation for GetRouteRequest

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetRouteResponse(Time time, Length distance, List<RouteInstruction> routeDirections, IGeometry geometry, IGeometry intermediatePoints, List<String> warnings) Creates GetRouteResponse class object.

Method Summary

Modifier and Type	Method and Description
Length	getDistance() Returns distance to travel in the generated route.
IGeometry	getGeometry() Returns geometry of generated route.
IGeometry	getIntermediatePoints() Returns intermediate points of generated route.
List<RouteInstruction>	getRouteDirections() Returns turn by turn direction list of generated route.
Time	getTime() Returns time taken to travel the generated route.
List<String>	getWarnings() Returns warnings for qaulity of the generated route.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetRouteResponse

public GetRouteResponse(Time time,
                        Length distance,
                        List<RouteInstruction> routeDirections,
                        IGeometry geometry,
                        IGeometry intermediatePoints,
                        List<String> warnings)

Creates GetRouteResponse class object.

Parameters:

time - Value and unit of time taken to travel the generated route.

distance - Value and unit of distance to travel in the generated route.

routeDirections - List of RouteInstruction i.e. turn by turn direction list of generated route.

geometry - The geometry of generated route.

intermediatePoints - The intermediate points of generated route.

warnings - warnings for quality of generated route.

Method Detail

getWarnings

public List<String> getWarnings()

Returns warnings for qaulity of the generated route.

getTime

public Time getTime()

Returns time taken to travel the generated route.

Returns:

Time, value and unit of time taken to travel the generated route.

getDistance

public Length getDistance()

Returns distance to travel in the generated route.

Returns:

Length, value and unit of distance to travel in the generated route.

getRouteDirections

public List<RouteInstruction> getRouteDirections()

Returns turn by turn direction list of generated route.

Returns:

List of RouteInstruction of generated route.

getGeometry

public IGeometry getGeometry()

Returns geometry of generated route.

Returns:

LineString of generated route.

getIntermediatePoints

public IGeometry getIntermediatePoints()

Returns intermediate points of generated route.

Returns:

MultiPoint of generated route.