Instruction (GraphHopper API 0.13.0-pre8 API)

java.lang.Object
- com.graphhopper.util.Instruction

Direct Known Subclasses:

FinishInstruction, RoundaboutInstruction, ViaInstruction
```
public class Instruction
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected InstructionAnnotation`	`annotation`
`static int`	`CONTINUE_ON_STREET`
`protected double`	`distance`
`protected Map<String,Object>`	`extraInfo`
`static int`	`FINISH`
`static int`	`IGNORE`
`static int`	`KEEP_LEFT`
`static int`	`KEEP_RIGHT`
`static int`	`LEAVE_ROUNDABOUT`
`protected String`	`name`
`protected PointList`	`points`
`static int`	`PT_END_TRIP`
`static int`	`PT_START_TRIP`
`static int`	`PT_TRANSFER`
`protected boolean`	`rawName`
`static int`	`REACHED_VIA`
`protected int`	`sign`
`protected long`	`time`
`static int`	`TURN_LEFT`
`static int`	`TURN_RIGHT`
`static int`	`TURN_SHARP_LEFT`
`static int`	`TURN_SHARP_RIGHT`
`static int`	`TURN_SLIGHT_LEFT`
`static int`	`TURN_SLIGHT_RIGHT`
`static int`	`U_TURN_LEFT`
`static int`	`U_TURN_RIGHT`
`static int`	`U_TURN_UNKNOWN`
`static int`	`UNKNOWN`
`static int`	`USE_ROUNDABOUT`

Constructor Summary

Constructors
Constructor and Description
`Instruction(int sign, String name, InstructionAnnotation ia, PointList pl)` The points, distances and times have exactly the same count.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`calcAzimuth(Instruction nextI)` Return the azimuth in degree based on the first tracksegment of this instruction.
`String`	`calcDirection(Instruction nextI)` Return the direction like 'NE' based on the first tracksegment of the instruction.
`InstructionAnnotation`	`getAnnotation()`
`double`	`getDistance()` Distance in meter until no new instruction
`Map<String,Object>`	`getExtraInfoJSON()`
`int`	`getLength()` This method returns the length of an Instruction.
`String`	`getName()`
`PointList`	`getPoints()`
`int`	`getSign()` The instruction for the person/driver to execute.
`long`	`getTime()` Duration until the next instruction, in milliseconds
`String`	`getTurnDescription(Translation tr)`
`Instruction`	`setDistance(double distance)`
`void`	`setExtraInfo(String key, Object value)`
`void`	`setName(String name)`
`void`	`setPoints(PointList points)`
`void`	`setSign(int sign)`
`Instruction`	`setTime(long time)`
`void`	`setUseRawName()` This method does not perform translation or combination with the sign - it just uses the provided name as instruction.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNKNOWN
```
public static final int UNKNOWN
```
    See Also:
    
    Constant Field Values
  - U_TURN_UNKNOWN
```
public static final int U_TURN_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - U_TURN_LEFT
```
public static final int U_TURN_LEFT
```
    See Also:
    
    Constant Field Values
  - KEEP_LEFT
```
public static final int KEEP_LEFT
```
    See Also:
    
    Constant Field Values
  - LEAVE_ROUNDABOUT
```
public static final int LEAVE_ROUNDABOUT
```
    See Also:
    
    Constant Field Values
  - TURN_SHARP_LEFT
```
public static final int TURN_SHARP_LEFT
```
    See Also:
    
    Constant Field Values
  - TURN_LEFT
```
public static final int TURN_LEFT
```
    See Also:
    
    Constant Field Values
  - TURN_SLIGHT_LEFT
```
public static final int TURN_SLIGHT_LEFT
```
    See Also:
    
    Constant Field Values
  - CONTINUE_ON_STREET
```
public static final int CONTINUE_ON_STREET
```
    See Also:
    
    Constant Field Values
  - TURN_SLIGHT_RIGHT
```
public static final int TURN_SLIGHT_RIGHT
```
    See Also:
    
    Constant Field Values
  - TURN_RIGHT
```
public static final int TURN_RIGHT
```
    See Also:
    
    Constant Field Values
  - TURN_SHARP_RIGHT
```
public static final int TURN_SHARP_RIGHT
```
    See Also:
    
    Constant Field Values
  - FINISH
```
public static final int FINISH
```
    See Also:
    
    Constant Field Values
  - REACHED_VIA
```
public static final int REACHED_VIA
```
    See Also:
    
    Constant Field Values
  - USE_ROUNDABOUT
```
public static final int USE_ROUNDABOUT
```
    See Also:
    
    Constant Field Values
  - IGNORE
```
public static final int IGNORE
```
    See Also:
    
    Constant Field Values
  - KEEP_RIGHT
```
public static final int KEEP_RIGHT
```
    See Also:
    
    Constant Field Values
  - U_TURN_RIGHT
```
public static final int U_TURN_RIGHT
```
    See Also:
    
    Constant Field Values
  - PT_START_TRIP
```
public static final int PT_START_TRIP
```
    See Also:
    
    Constant Field Values
  - PT_TRANSFER
```
public static final int PT_TRANSFER
```
    See Also:
    
    Constant Field Values
  - PT_END_TRIP
```
public static final int PT_END_TRIP
```
    See Also:
    
    Constant Field Values
  - points
```
protected PointList points
```
  - annotation
```
protected final InstructionAnnotation annotation
```
  - rawName
```
protected boolean rawName
```
  - sign
```
protected int sign
```
  - name
```
protected String name
```
  - distance
```
protected double distance
```
  - time
```
protected long time
```
  - extraInfo
```
protected Map<String,Object> extraInfo
```
- Constructor Detail
  - Instruction
```
public Instruction(int sign,
                   String name,
                   InstructionAnnotation ia,
                   PointList pl)
```
    The points, distances and times have exactly the same count. The last point of this instruction is not duplicated here and should be in the next one.
- Method Detail
  - setUseRawName
```
public void setUseRawName()
```
    This method does not perform translation or combination with the sign - it just uses the provided name as instruction.
  - getAnnotation
```
public InstructionAnnotation getAnnotation()
```
  - getSign
```
public int getSign()
```
    The instruction for the person/driver to execute.
  - setSign
```
public void setSign(int sign)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getExtraInfoJSON
```
public Map<String,Object> getExtraInfoJSON()
```
  - setExtraInfo
```
public void setExtraInfo(String key,
                         Object value)
```
  - getDistance
```
public double getDistance()
```
    Distance in meter until no new instruction
  - setDistance
```
public Instruction setDistance(double distance)
```
  - getTime
```
public long getTime()
```
    Duration until the next instruction, in milliseconds
  - setTime
```
public Instruction setTime(long time)
```
  - getPoints
```
public PointList getPoints()
```
  - setPoints
```
public void setPoints(PointList points)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - calcDirection
```
public String calcDirection(Instruction nextI)
```
    Return the direction like 'NE' based on the first tracksegment of the instruction. If Instruction does not contain enough coordinate points, an empty string will be returned.
  - calcAzimuth
```
public double calcAzimuth(Instruction nextI)
```
    Return the azimuth in degree based on the first tracksegment of this instruction. If this instruction contains less than 2 points then NaN will be returned or the specified instruction will be used if that is the finish instruction.
  - getLength
```
public int getLength()
```
    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
  - getTurnDescription
```
public String getTurnDescription(Translation tr)
```

Class Instruction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN

U_TURN_UNKNOWN

U_TURN_LEFT

KEEP_LEFT

LEAVE_ROUNDABOUT

TURN_SHARP_LEFT

TURN_LEFT

TURN_SLIGHT_LEFT

CONTINUE_ON_STREET

TURN_SLIGHT_RIGHT

TURN_RIGHT

TURN_SHARP_RIGHT

FINISH

REACHED_VIA

USE_ROUNDABOUT

IGNORE

KEEP_RIGHT

U_TURN_RIGHT

PT_START_TRIP

PT_TRANSFER

PT_END_TRIP

points

annotation

rawName

sign

name

distance

time

extraInfo

Constructor Detail

Instruction

Method Detail

setUseRawName

getAnnotation

getSign

setSign

getName

setName

getExtraInfoJSON

setExtraInfo

getDistance

setDistance

getTime

setTime

getPoints

setPoints

toString

calcDirection

calcAzimuth

getLength

getTurnDescription