NSDK_ManeuverDescription

@interface NSDK_ManeuverDescription : NSObject

Description of a maneuver point.

@author PTV AG Karlsruhe

  • Returns the coordinates of the maneuver.

    Declaration

    Objective-C

    - (NSDK_Position *)getPos;

    Swift

    func getPos() -> NSDK_Position!

    Return Value

    the coordinates of the maneuver.

  • Sets the coordinates of the maneuver.

    Declaration

    Objective-C

    - (void)setPos:(NSDK_Position *)nsdk_Position;

    Swift

    func setPos(_ nsdk_Position: NSDK_Position!)

    Parameters

    nsdk_Position

    the coordinates of the maneuver.

  • Returns the driving direction - [0..360[, 0 is East.

    Declaration

    Objective-C

    - (int)getDrivingDirection;

    Swift

    func getDrivingDirection() -> Int32

    Return Value

    the driving direction

  • Sets the driving direction - [0..360[, 0 is East.

    Declaration

    Objective-C

    - (void)setDrivingDirection:(int)drivingDirection;

    Swift

    func setDrivingDirection(_ drivingDirection: Int32)

    Parameters

    drivingDirection

    the driving direction

  • Returns the road type of road after maneuver [0..14]

    Declaration

    Objective-C

    - (int)getRoadType;

    Swift

    func getRoadType() -> Int32

    Return Value

    the road type of road after maneuver.

  • Sets the road type of road after maneuver [0..14].

    Declaration

    Objective-C

    - (void)setRoadType:(int)roadType;

    Swift

    func setRoadType(_ roadType: Int32)

    Parameters

    roadType

    the road type of road after maneuver.

  • Returns the road category of road after maneuver [0..4].

    Declaration

    Objective-C

    - (int)getCategory;

    Swift

    func getCategory() -> Int32

    Return Value

    the road category of road after maneuver.

  • Sets the road category of road after maneuver [0..4].

    Declaration

    Objective-C

    - (void)setCategory:(int)category;

    Swift

    func setCategory(_ category: Int32)

    Parameters

    category

    the road category of road after maneuver.

  • Returns the country id. Maybe 0 for some roads due to internal limitations.

    Declaration

    Objective-C

    - (int)getCountryId;

    Swift

    func getCountryId() -> Int32

    Return Value

    the country id

  • Sets the country id. Maybe 0 for some roads due to internal limitations.

    Declaration

    Objective-C

    - (void)setCountryId:(int)countryId;

    Swift

    func setCountryId(_ countryId: Int32)

    Parameters

    countryId

    the country id.

  • Returns the distance from start [m].

    Declaration

    Objective-C

    - (int)getDistFromStart;

    Swift

    func getDistFromStart() -> Int32

    Return Value

    the distance from start.

  • Sets the distance from start [m].

    Declaration

    Objective-C

    - (void)setDistFromStart:(int)distFromStart;

    Swift

    func setDistFromStart(_ distFromStart: Int32)

    Parameters

    distFromStart

    the distance from start.

  • Returns the time from start [s].

    Declaration

    Objective-C

    - (int)getTimeFromStart;

    Swift

    func getTimeFromStart() -> Int32

    Return Value

    the time from start.

  • Sets the time from start [s].

    Declaration

    Objective-C

    - (void)setTimeFromStart:(int)timeFromStart;

    Swift

    func setTimeFromStart(_ timeFromStart: Int32)

    Parameters

    timeFromStart

    the time from start.

  • Returns the tunnel mode. Usually set to 0. 1 indicates a maneuver inside a tunnel. 2 indicates a maneuver immediately after leaving a tunnel.

    Declaration

    Objective-C

    - (int)getTunnelMode;

    Swift

    func getTunnelMode() -> Int32

    Return Value

    the tunnel mode.

  • Sets the tunnel mode. Usually set to 0. 1 indicates a maneuver inside a tunnel. 2 indicates a maneuver immediately after leaving a tunnel.

    Declaration

    Objective-C

    - (void)setTunnelMode:(int)tunnelMode;

    Swift

    func setTunnelMode(_ tunnelMode: Int32)

    Parameters

    tunnelMode

    the tunnel mode to set.

  • Returns the information if it’s a maneuver related to a round-about.

    Declaration

    Objective-C

    - (BOOL)getRoundaboutManeuver;

    Swift

    func getRoundaboutManeuver() -> Bool

    Return Value

    is it a maneuver related to a round-about?

  • Sets if it’s a maneuver related to a round-about.

    Declaration

    Objective-C

    - (void)setRoundaboutManeuver:(BOOL)roundaboutManeuver;

    Swift

    func setRoundaboutManeuver(_ roundaboutManeuver: Bool)

    Parameters

    roundaboutManeuver

    is the maneuver related to a round-about.

  • 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).

    Declaration

    Objective-C

    - (BOOL)getTBaseCrossing;

    Swift

    func getTBaseCrossing() -> Bool

    Return Value

    Is it maneuver at a T-like crossing.

  • 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).

    Declaration

    Objective-C

    - (void)setTBaseCrossing:(BOOL)tBaseCrossing;

    Swift

    func setTBaseCrossing(_ tBaseCrossing: Bool)

    Parameters

    tBaseCrossing

    is the maneuver at a T-like crossing

  • Returns the type of the maneuver - [NSDK_ManeuverType].

    Declaration

    Objective-C

    - (NSDK_ManeuverType)getManeuverType;

    Swift

    func getManeuverType() -> NSDK_ManeuverType

    Return Value

    the type of the maneuver.

  • Sets the type of the maneuver - [NSDK_ManeuverType].

    Declaration

    Objective-C

    - (void)setManeuverType:(NSDK_ManeuverType)maneuverType;

    Swift

    func setManeuverType(_ maneuverType: NSDK_ManeuverType)

    Parameters

    maneuverType

    the type of the maneuver.

  • Returns the a turn orientation - [NSDK_ManeuverDirection|.

    Declaration

    Objective-C

    - (NSDK_ManeuverDirection)getTurnOrient;

    Swift

    func getTurnOrient() -> NSDK_ManeuverDirection

    Return Value

    the a turn orientation.

  • Sets the a turn orientation - [NSDK_ManeuverDirection|.

    Declaration

    Objective-C

    - (void)setTurnOrient:(NSDK_ManeuverDirection)maneuverDirection;

    Swift

    func setTurnOrient(_ maneuverDirection: NSDK_ManeuverDirection)

    Parameters

    maneuverDirection

    the a turn orientation to set.

  • Returns the weight of the maneuver - [NSDK_ManeuverWeight].

    Declaration

    Objective-C

    - (NSDK_ManeuverWeight)getTurnWeight;

    Swift

    func getTurnWeight() -> NSDK_ManeuverWeight

    Return Value

    the weight of the maneuver.

  • Sets the weight of the maneuver - [NSDK_ManeuverWeight].

    Declaration

    Objective-C

    - (void)setTurnWeight:(NSDK_ManeuverWeight)maneuverWeight;

    Swift

    func setTurn(_ maneuverWeight: NSDK_ManeuverWeight)

    Parameters

    maneuverWeight

    the weight of the maneuver to be set.

  • 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.)

    Declaration

    Objective-C

    - (short)getExitNr;

    Swift

    func getExitNr() -> Int16

    Return Value

    the exit number in a round-about

  • 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.)

    Declaration

    Objective-C

    - (void)setExitNr:(short)exitNr;

    Swift

    func setExitNr(_ exitNr: Int16)

    Parameters

    exitNr

    the exit number in a round-about to set.

  • Returns the kind of current guidance as of next menoeuvre.

    Declaration

    Objective-C

    - (NSDK_GuidanceKind)getGuidanceKind;

    Swift

    func getGuidanceKind() -> NSDK_GuidanceKind

    Return Value

    the kind of current guidance as of next menoeuvre.

  • Sets the kind of current guidance as of next menoeuvre.

    Declaration

    Objective-C

    - (void)setGuidanceKind:(NSDK_GuidanceKind)guidanceKind;

    Swift

    func setGuidanceKind(_ guidanceKind: NSDK_GuidanceKind)

    Parameters

    guidanceKind

    - the kind of current guidance as of next menoeuvre to set.

  • Returns the kind of next guidance as after next maneuver.

    Declaration

    Objective-C

    - (NSDK_GuidanceKind)getNextGuidanceKind;

    Swift

    func getNextGuidanceKind() -> NSDK_GuidanceKind

    Return Value

    the kind of next guidance as after next maneuver.

  • Sets the kind of next guidance as after next maneuver.

    Declaration

    Objective-C

    - (void)setNextGuidanceKind:(NSDK_GuidanceKind)nextGuidanceKind;

    Swift

    func setNextGuidanceKind(_ nextGuidanceKind: NSDK_GuidanceKind)

    Parameters

    nextGuidanceKind

    the kind of next guidance as after next maneuver.

  • Returns true if maneuver is a border.

    Declaration

    Objective-C

    - (BOOL)getBorder;

    Swift

    func getBorder() -> Bool

    Return Value

    true if maneuver is a border - else false.

  • Sets if the maneuver is a border.

    Declaration

    Objective-C

    - (void)setBorder:(BOOL)border;

    Swift

    func setBorder(_ border: Bool)

    Parameters

    border

    is maneuver a border?

  • Is maneuver entering a ferry.

    Declaration

    Objective-C

    - (BOOL)getEnterFerry;

    Swift

    func getEnterFerry() -> Bool

    Return Value

    true, if maneuver is entering a ferry - else false.

  • Sets the switch if the maneuver is entering a ferry.

    Declaration

    Objective-C

    - (void)setEnterFerry:(BOOL)enterFerry;

    Swift

    func setEnterFerry(_ enterFerry: Bool)

    Parameters

    enterFerry

    the maneuver is entering a ferry?

  • Is maneuver leaving a ferry.

    Declaration

    Objective-C

    - (BOOL)getLeaveFerry;

    Swift

    func getLeaveFerry() -> Bool

    Return Value

    true, if maneuver is leaving a ferry - else false.

  • Sets the switch if the maneuver is leaving a ferry.

    Declaration

    Objective-C

    - (void)setLeaveFerry:(BOOL)leaveFerry;

    Swift

    func setLeaveFerry(_ leaveFerry: Bool)

    Parameters

    leaveFerry

    the maneuver is leaving a ferry?

  • 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

    Declaration

    Objective-C

    - (short)getJunctionType;

    Swift

    func getJunctionType() -> Int16

    Return Value

    the type of junction

  • 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

    Declaration

    Objective-C

    - (void)setJunctionType:(short)junctionType;

    Swift

    func setJunctionType(_ junctionType: Int16)

    Parameters

    junctionType

    the type of junction.

  • Returns the street name of segment after passing the maneuver.

    Declaration

    Objective-C

    - (NSString *)getStreetName;

    Swift

    func getStreetName() -> String!

    Return Value

    the street name of segment after passing the maneuver.

  • Sets the street name of segment after passing the maneuver. The street name is limited up to 127 signs.

    Declaration

    Objective-C

    - (void)setStreetName:(NSString *)streetName;

    Swift

    func setStreetName(_ streetName: String!)

    Parameters

    streetName

    the street name of segment after passing the maneuver.

  • Delivers the information, wether the ManeuverDesrciption has a SignPostInfo or not.

    Declaration

    Objective-C

    - (BOOL)hasSignPostInfo;

    Swift

    func hasSignPostInfo() -> Bool

    Return Value

    has the ManeuverDesrciption a SignPostInfo?

  • Delivers the SignPostInfo of the ManeuverDescription.

    Declaration

    Objective-C

    - (NSDK_SignPostInfo *)getSignPostInfo;

    Swift

    func getSignPostInfo() -> NSDK_SignPostInfo!

    Return Value

    the SignPostInfo of the ManeuverDescription.

  • Sets the flag, that signs if the ManeuverDescription has a SignPostInfo or not.

    Declaration

    Objective-C

    - (void)setHasSignPostInfo:(BOOL)available;

    Swift

    func setHasSignPostInfo(_ available: Bool)

    Parameters

    available

    true if it has a SignPostInfo - else false.

  • Assigns the SignPostInfo to the ManeuverDescription.

    Declaration

    Objective-C

    - (void)setSignPostInfo:(NSDK_SignPostInfo *)signPost;

    Swift

    func setSignPostInfo(_ signPost: NSDK_SignPostInfo!)

    Parameters

    signPost

    the SignPostInfo to assign.