RoutingInstruction

java.lang.Object
- com.nutiteq.routing.RoutingInstruction

```
public class RoutingInstruction
extends java.lang.Object
```
A class that defines a routing instruction at specified position in the path.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean swigCMemOwn

Fields
Modifier and Type	Field and Description
`protected boolean`	`swigCMemOwn`

Constructor Summary

Constructors
Constructor and Description
`RoutingInstruction()` Constructs a new RoutingInstruction instance with all values set to default.
`RoutingInstruction(long cPtr, boolean cMemoryOwn)`
`RoutingInstruction(RoutingAction action, int pointIndex, java.lang.String streetName, float turnAngle, float azimuth, double distance, double time)` Constructs a new RoutingInstruction instance given all instruction attributes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()`
`boolean`	`equals(java.lang.Object obj)` Checks if this object is equal to the specified object.
`protected void`	`finalize()`
`RoutingAction`	`getAction()` Returns the action of the instruction.
`float`	`getAzimuth()` Returns the azimuth of the initial position.
`static long`	`getCPtr(RoutingInstruction obj)`
`double`	`getDistance()` Returns the distance to move along the given street.
`int`	`getPointIndex()` Returns the index of the first geometry point in external point array.
`java.lang.String`	`getStreetName()` Returns the name of street.
`double`	`getTime()` Returns the time approximate duration of the instruction.
`float`	`getTurnAngle()` Returns the turn angle of the action.
`int`	`hashCode()` Returns the hash value of this object.
`java.lang.String`	`toString()` Creates a string representation of this instruction, useful for logging.

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

- Field Detail
  - swigCMemOwn
```
protected boolean swigCMemOwn
```
- Constructor Detail
  - RoutingInstruction
```
public RoutingInstruction(long cPtr,
                          boolean cMemoryOwn)
```
  - RoutingInstruction
```
public RoutingInstruction()
```
    Constructs a new RoutingInstruction instance with all values set to default.
  - RoutingInstruction
```
public RoutingInstruction(RoutingAction action,
                          int pointIndex,
                          java.lang.String streetName,
                          float turnAngle,
                          float azimuth,
                          double distance,
                          double time)
```
    Constructs a new RoutingInstruction instance given all instruction attributes.
    
    Parameters:
    
    action - Action to take.
    
    pointIndex - Instruction starting point index in the point list.
    
    streetName - Street name.
    
    turnAngle - Turn angle in degrees.
    
    azimuth - Azimuth in degrees.
    
    distance - The distance to move along the given street in meters.
    
    time - The approximate duration of the instruction in seconds.
- Method Detail
  - getCPtr
```
public static long getCPtr(RoutingInstruction obj)
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object
  - delete
```
public void delete()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks if this object is equal to the specified object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    True when objects are equal, false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the hash value of this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The hash value of this object.
  - getAction
```
public RoutingAction getAction()
```
    Returns the action of the instruction.
    
    Returns:
    
    The action to take.
  - getPointIndex
```
public int getPointIndex()
```
    Returns the index of the first geometry point in external point array.
    
    Returns:
    
    The point index.
  - getStreetName
```
public java.lang.String getStreetName()
```
    Returns the name of street.
    
    Returns:
    
    The name of the street.
  - getTurnAngle
```
public float getTurnAngle()
```
    Returns the turn angle of the action.
    
    Returns:
    
    The turn angle in degrees.
  - getAzimuth
```
public float getAzimuth()
```
    Returns the azimuth of the initial position.
    
    Returns:
    
    The azimuth in degrees.
  - getDistance
```
public double getDistance()
```
    Returns the distance to move along the given street.
    
    Returns:
    
    The distance to move in meters.
  - getTime
```
public double getTime()
```
    Returns the time approximate duration of the instruction.
    
    Returns:
    
    The approximate duration of the instruction in seconds.
  - toString
```
public java.lang.String toString()
```
    Creates a string representation of this instruction, useful for logging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The string representation of this instruction.

Class RoutingInstruction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

swigCMemOwn

Constructor Detail

RoutingInstruction

RoutingInstruction

RoutingInstruction

Method Detail

getCPtr

finalize

delete

equals

hashCode

getAction

getPointIndex

getStreetName

getTurnAngle

getAzimuth

getDistance

getTime

toString