com.pb.routing.gra.matrix

Class RouteCost

java.lang.Object

com.pb.routing.gra.matrix.RouteCost

All Implemented Interfaces:

Serializable

public final class RouteCost
extends Object
implements Serializable

Represents the route cost matrix object generated after processing of GetRouteCostMatrixRequest.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RouteCost(Time time, Length distance, IPoint startPoint, IPoint endPoint) Creates the RouteCost class object.

Method Summary

Modifier and Type	Method and Description
Length	getDistance() Returns distance to travel in the generated route.
IPoint	getEndPoint() Returns the end point for which this route cost was calculated.
IPoint	getStartPoint() Returns the start point for which this route cost was calculated.
Time	getTime() Returns time taken to travel the generated route.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteCost

public RouteCost(Time time,
                 Length distance,
                 IPoint startPoint,
                 IPoint endPoint)

Creates the RouteCost class object.

Parameters:

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

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

startPoint - The origin for which this route cost was calculated.

endPoint - The destination for which this route cost was calculated.

Method Detail

getStartPoint

public IPoint getStartPoint()

Returns the start point for which this route cost was calculated.

Returns:

IPoint, the origin for which this route cost was calculated.

getEndPoint

public IPoint getEndPoint()

Returns the end point for which this route cost was calculated.

Returns:

IPoint, the destination for which this route cost was calculated.

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 the generated route.