com.graphhopper.util

Class ViaInstruction

java.lang.Object

com.graphhopper.util.Instruction

com.graphhopper.util.ViaInstruction

public class ViaInstruction
extends Instruction

Author:

Peter Karich

Field Summary

Fields inherited from class com.graphhopper.util.Instruction

annotation, CONTINUE_ON_STREET, distance, extraInfo, FINISH, IGNORE, KEEP_LEFT, KEEP_RIGHT, LEAVE_ROUNDABOUT, name, points, PT_END_TRIP, PT_START_TRIP, PT_TRANSFER, rawName, REACHED_VIA, sign, time, TURN_LEFT, TURN_RIGHT, TURN_SHARP_LEFT, TURN_SHARP_RIGHT, TURN_SLIGHT_LEFT, TURN_SLIGHT_RIGHT, U_TURN_LEFT, U_TURN_RIGHT, U_TURN_UNKNOWN, UNKNOWN, USE_ROUNDABOUT

Constructor Summary

Constructors

Constructor and Description
ViaInstruction(Instruction instr)
ViaInstruction(String name, InstructionAnnotation ia, PointList pl)

Method Summary

Modifier and Type	Method and Description
int	getLength() This method returns the length of an Instruction.
String	getTurnDescription(Translation tr)
int	getViaCount()
void	setViaCount(int count)

Methods inherited from class com.graphhopper.util.Instruction

calcAzimuth, getAnnotation, getDistance, getExtraInfoJSON, getName, getPoints, getSign, getTime, setDistance, setExtraInfo, setName, setPoints, setSign, setTime, setUseRawName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ViaInstruction

public ViaInstruction(String name,
                      InstructionAnnotation ia,
                      PointList pl)

ViaInstruction

public ViaInstruction(Instruction instr)

Method Detail

getLength

public int getLength()

Description copied from class: Instruction

This method returns the length of an Instruction. The length of an instruction is defined by [the index of the first point of the next instruction] - [the index of the first point of this instruction].

In general this will just resolve to the size of the PointList, except for ViaInstruction and FinishInstruction, which are only virtual instructions, in a sense that they don't provide a turn instruction, but only an info ("reached via point or destination").

See #1216 and #1138

Overrides:

getLength in class Instruction

getViaCount

public int getViaCount()

setViaCount

public void setViaCount(int count)

getTurnDescription

public String getTurnDescription(Translation tr)

Overrides:

getTurnDescription in class Instruction