com.pb.routing.gra.route

Class RouteInstruction

java.lang.Object

com.pb.routing.gra.route.RouteInstruction

All Implemented Interfaces:

Serializable

public final class RouteInstruction
extends Object
implements Serializable

Represents the object containing turn by turn direction detail for a particular road segment. GetRouteResponse contains list of this instruction.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RouteInstruction(Time time, Length distance, String instruction) Creates RouteInstruction class object.
RouteInstruction(Time time, Length distance, String instruction, IGeometry directionGeometry) Creates RouteInstruction class object.

Method Summary

Modifier and Type	Method and Description
IGeometry	getDirectionGeometry() Returns geometry for this road segment.
Length	getDistance() Returns the distance traveled in this road segment.
String	getInstruction() Returns turn direction for this road segment.
Time	getTime() Returns the time taken to travel this road segment.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteInstruction

public RouteInstruction(Time time,
                        Length distance,
                        String instruction)

Creates RouteInstruction class object.

Parameters:

time - Value and unit of time taken to travel this road segment.

distance - Value and unit of distance traveled in this road segment.

instruction - Turn direction for this road segment.

RouteInstruction

public RouteInstruction(Time time,
                        Length distance,
                        String instruction,
                        IGeometry directionGeometry)

Creates RouteInstruction class object.

Parameters:

time - Value and unit of time taken to travel this road segment.

distance - Value and unit of distance traveled in this road segment.

instruction - Turn direction for this road segment.

directionGeometry - Geometry for this road segment.

Method Detail

getTime

public Time getTime()

Returns the time taken to travel this road segment.

Returns:

Time, value and unit of time taken to travel this road segment.

getDistance

public Length getDistance()

Returns the distance traveled in this road segment.

Returns:

Length, value and unit of distance traveled in this road segment.

getInstruction

public String getInstruction()

Returns turn direction for this road segment.

Returns:

String turn direction for this road segment.

getDirectionGeometry

public IGeometry getDirectionGeometry()

Returns geometry for this road segment.

Returns:

IGeometry, geometry associated with this road segment.