ManeuverDescription (navigationSDK API)

java.lang.Object
- com.ptvag.navigation.sdk.ManeuverDescription

public class ManeuverDescription
extends java.lang.Object

Description of a maneuver point.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean jniCMemOwn

protected long jniCPtr

com.ptvag.navigation.sdk.NativeObject parent

Fields
Modifier and Type	Field and Description
`protected boolean`	`jniCMemOwn`
`protected long`	`jniCPtr`
`com.ptvag.navigation.sdk.NativeObject`	`parent`

Constructor Summary

Constructors
Constructor and Description
`ManeuverDescription()` Constructor
`ManeuverDescription(long cPtr, boolean cMemoryOwn)` Only for internal use - don't try to call this from Java.
`ManeuverDescription(long cPtr, com.ptvag.navigation.sdk.NativeObject parent)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Kills rubbish if owning the object.
`protected void`	`finalize()`
`boolean`	`getBorder()` Returns true if maneuver is a border.
`int`	`getCategory()` Returns the road category of road after maneuver [0..4].
`int`	`getCountryId()` Returns the country id.
`static long`	`getCPtr(com.ptvag.navigation.sdk.NativeObject obj)`
`int`	`getDistFromStart()` Returns the distance from start [m].
`int`	`getDrivingDirection()` Returns the driving direction - [0..360[, 0 is East.
`boolean`	`getEnterFerry()` Is maneuver entering a ferry.
`short`	`getExitNr()` Returns the exit number in a round-about.
`GuidanceKind`	`getGuidanceKind()` Returns the kind of current guidance as of next menoeuvre.
`short`	`getJunctionType()` Returns the type of junction this maneuver belongs to.
`boolean`	`getLeaveFerry()` Is maneuver leaving a ferry.
`ManeuverType`	`getManeuverType()` Returns the type of the maneuver - @link ManeuverType.
`GuidanceKind`	`getNextGuidanceKind()` Returns the kind of next guidance as after next maneuver.
`Position`	`getPos()` Returns the coordinates of the maneuver.
`int`	`getRoadType()` Returns the road type of road after maneuver [0..14]
`boolean`	`getRoundaboutManeuver()` Returns the information if it's a maneuver related to a round-about.
`SignPostInfo`	`getSignPostInfo()` Delivers the SignPostInfo of the ManeuverDescription.
`java.lang.String`	`getStreetName()` Returns the street name of segment after passing the maneuver.
`boolean`	`getTBaseCrossing()` Returns if the maneuver is at a T-like crossing (i.e. two streets leaving the current street, one about 90° left, one about 90° right).
`int`	`getTimeFromStart()` Returns the time from start [s].
`int`	`getTunnelMode()` Returns the tunnel mode.
`ManeuverDirection`	`getTurnOrient()` Returns the a turn orientation - `ManeuverDirection`.
`ManeuverWeight`	`getTurnWeight()` Returns the weight of the maneuver - `ManeuverWeight`.
`boolean`	`hasSignPostInfo()` Delivers the information, wether the ManeuverDesrciption has a SignPostInfo or not.
`void`	`setBorder(boolean border)` Sets if the maneuver is a border.
`void`	`setCategory(int category)` Sets the road category of road after maneuver [0..4].
`void`	`setCountryId(int countryId)` Sets the country id.
`void`	`setDistFromStart(int distFromStart)` Sets the distance from start [m].
`void`	`setDrivingDirection(int drivingDirection)` Sets the driving direction - [0..360[, 0 is East.
`void`	`setEnterFerry(boolean enterFerry)` Sets the switch if the maneuver is entering a ferry.
`void`	`setExitNr(short exitNr)` Sets the exit number in a round-about.
`void`	`setGuidanceKind(GuidanceKind guidanceKind)` Sets the kind of current guidance as of next menoeuvre.
`void`	`setHasSignPostInfo(boolean available)` Sets the flag, that signs if the ManeuverDescription has a SignPostInfo or not.
`void`	`setJunctionType(short junctionType)` Sets the type of junction this maneuver belongs to.
`void`	`setLeaveFerry(boolean leaveFerry)` Sets the switch if the maneuver is leaving a ferry.
`void`	`setManeuverType(ManeuverType maneuverType)` Sets the type of the maneuver - @link ManeuverType.
`void`	`setNextGuidanceKind(GuidanceKind nextGuidanceKind)` Sets the kind of next guidance as after next maneuver.
`void`	`setPos(Position position)` Sets the coordinates of the maneuver.
`void`	`setRoadType(int roadType)` Sets the road type of road after maneuver [0..14].
`void`	`setRoundaboutManeuver(boolean roundaboutManeuver)` Sets if it's a maneuver related to a round-about.
`void`	`setSignPostInfo(SignPostInfo signPost)` Assigns the SignPostInfo to the ManeuverDescription.
`void`	`setStreetName(java.lang.String streetName)` Sets the street name of segment after passing the maneuver.
`void`	`setTBaseCrossing(boolean tBaseCrossing)` Sets if the maneuver is at a T-like crossing (i.e. two streets leaving the current street, one about 90° left, one about 90° right).
`void`	`setTimeFromStart(int timeFromStart)` Sets the time from start [s].
`void`	`setTunnelMode(int tunnelMode)` Sets the tunnel mode.
`void`	`setTurnOrient(ManeuverDirection maneuverDirection)` Sets the a turn orientation - `ManeuverDirection`.
`void`	`setTurnWeight(ManeuverWeight maneuverWeight)` Sets the weight of the maneuver - `ManeuverWeight`.

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

- Field Detail
  - jniCPtr
```
protected long jniCPtr
```
  - jniCMemOwn
```
protected boolean jniCMemOwn
```
  - parent
```
public com.ptvag.navigation.sdk.NativeObject parent
```
- Constructor Detail
  - ManeuverDescription
```
public ManeuverDescription()
```
    Constructor
  - ManeuverDescription
```
public ManeuverDescription(long cPtr,
                           boolean cMemoryOwn)
```
    Only for internal use - don't try to call this from Java.
  - ManeuverDescription
```
public ManeuverDescription(long cPtr,
                           com.ptvag.navigation.sdk.NativeObject parent)
```
- Method Detail
  - getPos
```
public Position getPos()
```
    Returns the coordinates of the maneuver.
    
    Returns:
    
    the coordinates of the maneuver.
  - setPos
```
public void setPos(Position position)
```
    Sets the coordinates of the maneuver.
    
    Parameters:
    
    position - the coordinates of the maneuver.
  - getDrivingDirection
```
public int getDrivingDirection()
```
    Returns the driving direction - [0..360[, 0 is East.
    
    Returns:
    
    the driving direction
  - setDrivingDirection
```
public void setDrivingDirection(int drivingDirection)
```
    Sets the driving direction - [0..360[, 0 is East.
    
    Parameters:
    
    drivingDirection - the driving direction
  - getRoadType
```
public int getRoadType()
```
    Returns the road type of road after maneuver [0..14]
    
    Returns:
    
    the road type of road after maneuver.
  - setRoadType
```
public void setRoadType(int roadType)
```
    Sets the road type of road after maneuver [0..14].
    
    Parameters:
    
    roadType - the road type of road after maneuver.
  - getCategory
```
public int getCategory()
```
    Returns the road category of road after maneuver [0..4].
    
    Returns:
    
    the road category of road after maneuver.
  - setCategory
```
public void setCategory(int category)
```
    Sets the road category of road after maneuver [0..4].
    
    Parameters:
    
    category - the road category of road after maneuver.
  - getCountryId
```
public int getCountryId()
```
    Returns the country id. Maybe 0 for some roads due to internal limitations.
    
    Returns:
    
    the country id
  - setCountryId
```
public void setCountryId(int countryId)
```
    Sets the country id. Maybe 0 for some roads due to internal limitations.
    
    Parameters:
    
    countryId - the country id.
  - getDistFromStart
```
public int getDistFromStart()
```
    Returns the distance from start [m].
    
    Returns:
    
    the distance from start.
  - setDistFromStart
```
public void setDistFromStart(int distFromStart)
```
    Sets the distance from start [m].
    
    Parameters:
    
    distFromStart - the distance from start.
  - getTimeFromStart
```
public int getTimeFromStart()
```
    Returns the time from start [s].
    
    Returns:
    
    the time from start.
  - setTimeFromStart
```
public void setTimeFromStart(int timeFromStart)
```
    Sets the time from start [s].
    
    Parameters:
    
    timeFromStart - the time from start.
  - getTunnelMode
```
public int getTunnelMode()
```
    Returns the tunnel mode. Usually set to 0. 1 indicates a maneuver inside a tunnel. 2 indicates a maneuver immediately after leaving a tunnel.
    
    Returns:
    
    the tunnel mode.
  - setTunnelMode
```
public void setTunnelMode(int tunnelMode)
```
    Sets the tunnel mode. Usually set to 0. 1 indicates a maneuver inside a tunnel. 2 indicates a maneuver immediately after leaving a tunnel.
    
    Parameters:
    
    tunnelMode - - the tunnel mode to set.
  - getRoundaboutManeuver
```
public boolean getRoundaboutManeuver()
```
    Returns the information if it's a maneuver related to a round-about.
    
    Returns:
    
    is it a maneuver related to a round-about?
  - setRoundaboutManeuver
```
public void setRoundaboutManeuver(boolean roundaboutManeuver)
```
    Sets if it's a maneuver related to a round-about.
    
    Parameters:
    
    roundaboutManeuver - - is the maneuver related to a round-about.
  - getTBaseCrossing
```
public boolean getTBaseCrossing()
```
    Returns if the maneuver is at a T-like crossing (i.e. two streets leaving the current street, one about 90° left, one about 90° right).
    
    Returns:
    
    Is it maneuver at a T-like crossing.
  - setTBaseCrossing
```
public void setTBaseCrossing(boolean tBaseCrossing)
```
    Sets if the maneuver is at a T-like crossing (i.e. two streets leaving the current street, one about 90° left, one about 90° right).
    
    Parameters:
    
    tBaseCrossing - - is the maneuver at a T-like crossing
  - getManeuverType
```
public ManeuverType getManeuverType()
```
    Returns the type of the maneuver - @link ManeuverType.
    
    Returns:
    
    the type of the maneuver.
  - setManeuverType
```
public void setManeuverType(ManeuverType maneuverType)
```
    Sets the type of the maneuver - @link ManeuverType.
    
    Parameters:
    
    maneuverType - the type of the maneuver.
  - getTurnOrient
```
public ManeuverDirection getTurnOrient()
```
    Returns the a turn orientation - ManeuverDirection.
    
    Returns:
    
    the a turn orientation.
  - setTurnOrient
```
public void setTurnOrient(ManeuverDirection maneuverDirection)
```
    Sets the a turn orientation - ManeuverDirection.
    
    Parameters:
    
    maneuverDirection - the a turn orientation to set.
  - getTurnWeight
```
public ManeuverWeight getTurnWeight()
```
    Returns the weight of the maneuver - ManeuverWeight.
    
    Returns:
    
    the weight of the maneuver.
  - setTurnWeight
```
public void setTurnWeight(ManeuverWeight maneuverWeight)
```
    Sets the weight of the maneuver - ManeuverWeight.
    
    Parameters:
    
    maneuverWeight - - the weight of the maneuver to be set.
  - getExitNr
```
public short getExitNr()
```
    Returns the exit number in a round-about. It counts only for valid/legal exits and counting is in driving direction (i.a. counter-clockwise if driving on RHS (most parts of europe, USA, etc.) and clockwise if driving on LHS (GB, AUS, RSA, etc.)
    
    Returns:
    
    the exit number in a round-about
  - setExitNr
```
public void setExitNr(short exitNr)
```
    Sets the exit number in a round-about. It counts only for valid/legal exits and counting is in driving direction (i.a. counter-clockwise if driving on RHS (most parts of europe, USA, etc.) and clockwise if driving on LHS (GB, AUS, RSA, etc.)
    
    Parameters:
    
    exitNr - - the exit number in a round-about to set.
  - getGuidanceKind
```
public GuidanceKind getGuidanceKind()
```
    Returns the kind of current guidance as of next menoeuvre.
    
    Returns:
    
    the kind of current guidance as of next menoeuvre.
  - setGuidanceKind
```
public void setGuidanceKind(GuidanceKind guidanceKind)
```
    Sets the kind of current guidance as of next menoeuvre.
    
    Parameters:
    
    guidanceKind - - the kind of current guidance as of next menoeuvre to set.
  - getNextGuidanceKind
```
public GuidanceKind getNextGuidanceKind()
```
    Returns the kind of next guidance as after next maneuver.
    
    Returns:
    
    the kind of next guidance as after next maneuver.
  - setNextGuidanceKind
```
public void setNextGuidanceKind(GuidanceKind nextGuidanceKind)
```
    Sets the kind of next guidance as after next maneuver.
    
    Parameters:
    
    nextGuidanceKind - - the kind of next guidance as after next maneuver.
  - getBorder
```
public boolean getBorder()
```
    Returns true if maneuver is a border.
    
    Returns:
    
    true if maneuver is a border - else false.
  - setBorder
```
public void setBorder(boolean border)
```
    Sets if the maneuver is a border.
    
    Parameters:
    
    border - - is maneuver a border?
  - getEnterFerry
```
public boolean getEnterFerry()
```
    Is maneuver entering a ferry.
    
    Returns:
    
    true, if maneuver is entering a ferry - else false.
  - setEnterFerry
```
public void setEnterFerry(boolean enterFerry)
```
    Sets the switch if the maneuver is entering a ferry.
    
    Parameters:
    
    enterFerry - - the maneuver is entering a ferry?
  - getLeaveFerry
```
public boolean getLeaveFerry()
```
    Is maneuver leaving a ferry.
    
    Returns:
    
    true, if maneuver is leaving a ferry - else false.
  - setLeaveFerry
```
public void setLeaveFerry(boolean leaveFerry)
```
    Sets the switch if the maneuver is leaving a ferry.
    
    Parameters:
    
    leaveFerry - - the maneuver is leaving a ferry?
  - getJunctionType
```
public short getJunctionType()
```
    Returns the type of junction this maneuver belongs to. Possible values are: 0 -> standard value (no special junction type) 1 -> AS standard junction type 2 -> AS 1st junction type 3 -> AS 2nd junction type 4 -> AK 1st junction type 5 -> AK 2nd junction type 6 -> AD right junction type 7 -> AD left junction type
    
    Returns:
    
    the type of junction
  - setJunctionType
```
public void setJunctionType(short junctionType)
```
    Sets the type of junction this maneuver belongs to. Possible values are: 0 -> standard value (no special junction type) 1 -> AS standard junction type 2 -> AS 1st junction type 3 -> AS 2nd junction type 4 -> AK 1st junction type 5 -> AK 2nd junction type 6 -> AD right junction type 7 -> AD left junction type
    
    Parameters:
    
    junctionType - - the type of junction.
  - getStreetName
```
public java.lang.String getStreetName()
```
    Returns the street name of segment after passing the maneuver.
    
    Returns:
    
    the street name of segment after passing the maneuver.
  - setStreetName
```
public void setStreetName(java.lang.String streetName)
```
    Sets the street name of segment after passing the maneuver. The street name is limited up to 127 signs.
    
    Parameters:
    
    streetName - - the street name of segment after passing the maneuver.
  - hasSignPostInfo
```
public boolean hasSignPostInfo()
```
    Delivers the information, wether the ManeuverDesrciption has a SignPostInfo or not.
    
    Returns:
    
    has the ManeuverDesrciption a SignPostInfo?
  - getSignPostInfo
```
public SignPostInfo getSignPostInfo()
```
    Delivers the SignPostInfo of the ManeuverDescription.
    
    Returns:
    
    the SignPostInfo of the ManeuverDescription.
  - setHasSignPostInfo
```
public void setHasSignPostInfo(boolean available)
```
    Sets the flag, that signs if the ManeuverDescription has a SignPostInfo or not.
    
    Parameters:
    
    available - - true if it has a SignPostInfo - else false.
  - setSignPostInfo
```
public void setSignPostInfo(SignPostInfo signPost)
```
    Assigns the SignPostInfo to the ManeuverDescription.
    
    Parameters:
    
    signPost - the SignPostInfo to assign.
  - getCPtr
```
public static long getCPtr(com.ptvag.navigation.sdk.NativeObject obj)
```
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - delete
```
public void delete()
```
    Kills rubbish if owning the object.

Class ManeuverDescription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jniCPtr

jniCMemOwn

parent

Constructor Detail

ManeuverDescription

ManeuverDescription

ManeuverDescription

Method Detail

getPos

setPos

getDrivingDirection

setDrivingDirection

getRoadType

setRoadType

getCategory

setCategory

getCountryId

setCountryId

getDistFromStart

setDistFromStart

getTimeFromStart

setTimeFromStart

getTunnelMode

setTunnelMode

getRoundaboutManeuver

setRoundaboutManeuver

getTBaseCrossing

setTBaseCrossing

getManeuverType

setManeuverType

getTurnOrient

setTurnOrient

getTurnWeight

setTurnWeight

getExitNr

setExitNr

getGuidanceKind

setGuidanceKind

getNextGuidanceKind

setNextGuidanceKind

getBorder

setBorder

getEnterFerry

setEnterFerry

getLeaveFerry

setLeaveFerry

getJunctionType

setJunctionType

getStreetName

setStreetName

hasSignPostInfo

getSignPostInfo

setHasSignPostInfo

setSignPostInfo

getCPtr

finalize

delete