NSDK_NavigationInformation

@interface NSDK_NavigationInformation : NSObject

Contains the status of the navigation.

@author PTV AG Karlsruhe

  • Returns the current position [Mercator].

    Declaration

    Objective-C

    - (NSDK_Position *)getPos;

    Swift

    func getPos() -> NSDK_Position!

    Return Value

    the current position [Mercator]

  • Sets the current position [Mercator].

    Declaration

    Objective-C

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

    Swift

    func setPos(_ nsdk_Position: NSDK_Position!)

    Parameters

    nsdk_Position

    the current position [Mercator].

  • Returns the current position on route [Mercator].

    Declaration

    Objective-C

    - (NSDK_Position *)getPosOnRoute;

    Swift

    func getPosOnRoute() -> NSDK_Position!

    Return Value

    the current position on route [Mercator].

  • Sets the current position on route [Mercator].

    Declaration

    Objective-C

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

    Swift

    func setPosOnRoute(_ nsdk_Position: NSDK_Position!)

    Parameters

    nsdk_Position

    the current position on route [Mercator].

  • Returns the current position on route Mercator

    Declaration

    Objective-C

    - (NSDK_Position *)getCorrectedPosOnRoute;

    Swift

    func getCorrectedPosOnRoute() -> NSDK_Position!

    Return Value

    the current position on route [Mercator]

  • Sets the current position on route Mercator

    Declaration

    Objective-C

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

    Swift

    func setCorrectedPosOnRoute(_ nsdk_Position: NSDK_Position!)

    Parameters

    nsdk_Position

    the current position on route [Mercator]

  • Returns the current course [0..360[, head east, counter-clockwise

    Declaration

    Objective-C

    - (int)getCourse;

    Swift

    func getCourse() -> Int32

    Return Value

    the current course

  • Sets the current course [0..360[, head east, counter-clockwise

    Declaration

    Objective-C

    - (void)setCourse:(int)course;

    Swift

    func setCourse(_ course: Int32)

    Parameters

    course

    the current course

  • Returns the current course on route [0..360[, head east, counter-clockwise

    Declaration

    Objective-C

    - (int)getCourseOnRoute;

    Swift

    func getCourseOnRoute() -> Int32

    Return Value

    the current course on route

  • Sets the current course on route [0..360[, head east, counter-clockwise

    Declaration

    Objective-C

    - (void)setCourseOnRoute:(int)courseOnRoute;

    Swift

    func setCourseOnRoute(_ courseOnRoute: Int32)

    Parameters

    courseOnRoute

    the current course on route

  • Returns the speed limit on the current segment (normal conditions) [km/h].

    Declaration

    Objective-C

    - (int)getSpeedLimit;

    Swift

    func getSpeedLimit() -> Int32

    Return Value

    the speed limit on the current segment

  • Sets the speed limit on the current segment (normal conditions) [km/h].

    Declaration

    Objective-C

    - (void)setSpeedLimit:(int)speedLimit;

    Swift

    func setSpeedLimit(_ speedLimit: Int32)

    Parameters

    speedLimit

    the speed limit on the current segment

  • Returns the truck speed limit on the current segment [km/h]

    Declaration

    Objective-C

    - (int)getSpeedLimitTruck;

    Swift

    func getSpeedLimitTruck() -> Int32

    Return Value

    the speed limit

  • Sets the truck speed limit on the current segment km/h]

    Declaration

    Objective-C

    - (void)setSpeedLimitTruck:(int)speedLimitTruck;

    Swift

    func setSpeedLimitTruck(_ speedLimitTruck: Int32)

    Parameters

    speedLimitTruck

    the speed limit

  • Returns the next changing speed limit from the current position (normal conditions) [km/h].

    Declaration

    Objective-C

    - (int)getNextSpeedLimit;

    Swift

    func getNextSpeedLimit() -> Int32

    Return Value

    the next changing speed limit

  • Sets the the next changing speed limit from the current position (normal conditions) [m].

    Declaration

    Objective-C

    - (void)setNextSpeedLimit:(int)nextSpeedLimit;

    Swift

    func setNextSpeedLimit(_ nextSpeedLimit: Int32)

    Parameters

    nextSpeedLimit

    the next changing speed limit

  • Returns the distance to the next changing speed limit from the current position (normal conditions) [m].

    Declaration

    Objective-C

    - (long)getDistToNextSpeedLimit;

    Swift

    func getDistToNextSpeedLimit() -> Int

    Return Value

    the distance to the next changing speed limit

  • Sets the distance to the next changing speed limit from the current position (normal conditions) [km/h].

    Declaration

    Objective-C

    - (void)setDistToNextSpeedLimit:(long)distToNextSpeedLimit;

    Swift

    func setDistToNextSpeedLimit(_ distToNextSpeedLimit: Int)

    Parameters

    distToNextSpeedLimit

    the distance to the next changing speed limit

  • Returns the road type of the segment of the next changing speed limit from the current position (normal conditions) [km/h].

    Declaration

    Objective-C

    - (int)getRoadTypeOfNextSpeedLimit;

    Swift

    func getRoadTypeOfNextSpeedLimit() -> Int32

    Return Value

    the road type of the next changing speed limit

  • Sets the road type of the next changing speed limit from the current position (normal conditions) [m].

    Declaration

    Objective-C

    - (void)setRoadTypeOfNextSpeedLimit:(int)roadTypeOfNextSpeedLimit;

    Swift

    func setRoadTypeOfNextSpeedLimit(_ roadTypeOfNextSpeedLimit: Int32)

    Parameters

    roadTypeOfNextSpeedLimit

    the road type of the next changing speed limit

  • Returns the category of the current segment [0..4]

    Declaration

    Objective-C

    - (int)getCategory;

    Swift

    func getCategory() -> Int32

    Return Value

    the category

  • Sets the category of the current segment [0..4]

    Declaration

    Objective-C

    - (void)setCategory:(int)category;

    Swift

    func setCategory(_ category: Int32)

    Parameters

    category

    the category

  • Returns the road type of the current segment [0..14]

    Declaration

    Objective-C

    - (int)getRoadType;

    Swift

    func getRoadType() -> Int32

    Return Value

    the road type

  • Sets the road type off the current segment [0..14]

    Declaration

    Objective-C

    - (void)setRoadType:(int)roadType;

    Swift

    func setRoadType(_ roadType: Int32)

    Parameters

    roadType

    the road type

  • Analyzes if a segment border been passed since the last position.

    Declaration

    Objective-C

    - (BOOL)getSegmentBorderPassed;

    Swift

    func getSegmentBorderPassed() -> Bool

    Return Value

    true if passed.

  • Sets if a segment border been passed since the last position.

    Declaration

    Objective-C

    - (void)setSegmentBorderPassed:(BOOL)passed;

    Swift

    func setSegmentBorderPassed(_ passed: Bool)

    Parameters

    passed

    true if passed

  • Analyzes if a maneuver point has been passed since the last position?

    Declaration

    Objective-C

    - (BOOL)getManeuverPointPassed;

    Swift

    func getManeuverPointPassed() -> Bool

    Return Value

    true if passed

  • Sets if a maneuver point has been passed since the last position.

    Declaration

    Objective-C

    - (void)setManeuverPointPassed:(BOOL)passed;

    Swift

    func setManeuverPointPassed(_ passed: Bool)

    Parameters

    passed

    true if passed

  • Checks: Is the next crossing inside a town area?

    Declaration

    Objective-C

    - (BOOL)getNextCrossingInTown;

    Swift

    func getNextCrossingInTown() -> Bool

    Return Value

    true if it is in town

  • Sets if the next crossing is inside a town area?

    Declaration

    Objective-C

    - (void)setNextCrossingInTown:(BOOL)nextCrossingInTown;

    Swift

    func setNextCrossingInTown(_ nextCrossingInTown: Bool)

    Parameters

    nextCrossingInTown

    true if it is inside.

  • Checks: Only Non-City-Roads until next crossing?

    Declaration

    Objective-C

    - (BOOL)getNoTownUntilNextManeuver;

    Swift

    func getNoTownUntilNextManeuver() -> Bool

    Return Value

    true if only non-city-roads.

  • Sets, if only use Non-City-Roads until next crossing.

    Declaration

    Objective-C

    - (void)setNoTownUntilNextManeuver:(BOOL)noTownUntilNextManeuver;

    Swift

    func setNoTownUntilNextManeuver(_ noTownUntilNextManeuver: Bool)

    Parameters

    noTownUntilNextManeuver

    true if only non-city-roads.

  • Returns the distance [m] to next maneuver.

    Declaration

    Objective-C

    - (long)getDistToNextManeuver;

    Swift

    func getDistToNextManeuver() -> Int

    Return Value

    the distance

  • Sets the distance [m] to next maneuver.

    Declaration

    Objective-C

    - (void)setDistToNextManeuver:(long)distance;

    Swift

    func setDistToNextManeuver(_ distance: Int)

    Parameters

    distance

    the distance.

  • Returns the time [s] to next maneuver

    Declaration

    Objective-C

    - (long)getTimeToNextManeuver;

    Swift

    func getTimeToNextManeuver() -> Int

    Return Value

    the time

  • Sets the time [s] to next maneuver.

    Declaration

    Objective-C

    - (void)setTimeToNextManeuver:(long)time;

    Swift

    func setTimeToNextManeuver(_ time: Int)

    Parameters

    time

    the time to set.

  • Returns the distance [m] from previous maneuver to next maneuver.

    Declaration

    Objective-C

    - (long)getRouteLengthToNextManeuver;

    Swift

    func getRouteLengthToNextManeuver() -> Int

    Return Value

    the distance

  • Sets the distance [m] from previous maneuver to next maneuver.

    Declaration

    Objective-C

    - (void)setRouteLengthToNextManeuver:(long)routeLength;

    Swift

    func setRouteLengthToNextManeuver(_ routeLength: Int)

    Parameters

    routeLength

    the distance.

  • Returns the distance [m] to destination.

    Declaration

    Objective-C

    - (long)getDistToDestination;

    Swift

    func getDistToDestination() -> Int

    Return Value

    the distance.

  • Sets the distance [m] to destination.

    Declaration

    Objective-C

    - (void)setDistToDestination:(long)distToDestination;

    Swift

    func setDistToDestination(_ distToDestination: Int)

    Parameters

    distToDestination

    the distance.

  • Returns the crow flight distance [m] from last matched position on route to destination.

    Declaration

    Objective-C

    - (long)getCrowFlightDistToDestination;

    Swift

    func getCrowFlightDistToDestination() -> Int

    Return Value

    the crow flight distance.

  • Sets the crow flight distance [m] from last matched position on route to destination.

    Declaration

    Objective-C

    - (void)setCrowFlightDistToDestination:(long)distance;

    Swift

    func setCrowFlightDistToDestination(_ distance: Int)

    Parameters

    distance

    the crow flight distance .

  • Returns the distance [m] to next station.

    Declaration

    Objective-C

    - (long)getDistToNextStation;

    Swift

    func getDistToNextStation() -> Int

    Return Value

    the distance.

  • Sets the distance [m] to next station.

    Declaration

    Objective-C

    - (void)setDistToNextStation:(long)distance;

    Swift

    func setDistToNextStation(_ distance: Int)

    Parameters

    distance

    the distance.

  • Returns the time [s] to next station.

    Declaration

    Objective-C

    - (long)getTimeToNextStation;

    Swift

    func getTimeToNextStation() -> Int

    Return Value

    the time

  • Sets the time [s] to next station.

    Declaration

    Objective-C

    - (void)setTimeToNextStation:(long)time;

    Swift

    func setTimeToNextStation(_ time: Int)

    Parameters

    time

    the time to the next station.

  • Returns the voice-output information. 0 if no voice output of the next maneuver is suggested. > 0 if voice output is suggested. Value is the amount of suggestions including this up to next maneuver. May be set for a finite period of time, see @link generatemaneuverhints for details.

    Declaration

    Objective-C

    - (short)getVoiceOutputManeuverHint;

    Swift

    func getVoiceOutputManeuverHint() -> Int16

    Return Value

    the voice-output information.

  • Sets the voice-output information. 0 if no voice output of the next maneuver is suggested. > 0 if voice output is suggested. Value is the amount of suggestions including this up to next maneuver. May be set for a finite period of time, see @link generatemaneuverhints for details.

    Declaration

    Objective-C

    - (void)setVoiceOutputManeuverHint:(short)voiceOutputManeuverHint;

    Swift

    func setVoiceOutputManeuverHint(_ voiceOutputManeuverHint: Int16)

  • Returns the name of the current street.

    Declaration

    Objective-C

    - (NSString *)getCurrentStreetName;

    Swift

    func getCurrentStreetName() -> String!

    Return Value

    the name of the current street.

  • Sets the name of the current street. Note: The current street name is limited up to 127 signs.

    Declaration

    Objective-C

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

    Swift

    func setCurrentStreetName(_ streetName: String!)

    Parameters

    streetName

    the name of the current street

  • Returns the description of the next maneuver.

    Declaration

    Objective-C

    - (NSDK_ManeuverDescription *)getNextManeuver;

    Swift

    func getNextManeuver() -> NSDK_ManeuverDescription!

    Return Value

    the description of the next maneuver.

  • Sets the description of the next maneuver.

    Declaration

    Objective-C

    - (void)setNextManeuver:(NSDK_ManeuverDescription *)nextManeuver;

    Swift

    func setNextManeuver(_ nextManeuver: NSDK_ManeuverDescription!)

    Parameters

    nextManeuver

    the description of the next maneuver.

  • Returns the description of the second next maneuver.

    Declaration

    Objective-C

    - (NSDK_ManeuverDescription *)getSecondNextManeuver;

    Swift

    func getSecondNextManeuver() -> NSDK_ManeuverDescription!

    Return Value

    the description of the second next maneuver.

  • Sets the description of the second next maneuver.

    Declaration

    Objective-C

    - (void)setSecondNextManeuver:(NSDK_ManeuverDescription *)maneuver;

    Swift

    func setSecondNextManeuver(_ maneuver: NSDK_ManeuverDescription!)

    Parameters

    maneuver

    the description of the second next maneuver.

  • Returns the information for drawing the crossing view for the next maneuver.

    Declaration

    Objective-C

    - (NSDK_CrossingView *)getNextManeuverCrossingView;

    Swift

    func getNextManeuverCrossingView() -> NSDK_CrossingView!

    Return Value

    the information for drawing the crossing view for the next maneuver.

  • Sets the information for drawing the crossing view for the next maneuver.

    Declaration

    Objective-C

    - (void)setNextManeuverCrossingView:(NSDK_CrossingView *)view;

    Swift

    func setNextManeuverCrossingView(_ view: NSDK_CrossingView!)

    Parameters

    view

    the information for drawing the crossing view for the next maneuver.

  • Returns the information for drawing the crossing view for the second next maneuver.

    Declaration

    Objective-C

    - (NSDK_CrossingView *)getSecondNextManeuverCrossingView;

    Swift

    func getSecondNextManeuverCrossingView() -> NSDK_CrossingView!

    Return Value

    the information for drawing the crossing view for the second next maneuver.

  • Sets the information for drawing the crossing view for the second next maneuver.

    Declaration

    Objective-C

    - (void)setSecondNextManeuverCrossingView:(NSDK_CrossingView *)view;

    Swift

    func setSecondNextManeuverCrossingView(_ view: NSDK_CrossingView!)

    Parameters

    view

    the information for drawing the crossing view for the second next maneuver.

  • Returns the distance to the next maneuver [m].

    Declaration

    Objective-C

    - (int)getRoundedDistToNextManeuver;

    Swift

    func getRoundedDistToNextManeuver() -> Int32

    Return Value

    the distance to the next maneuver [m].

  • Sets the distance to the next maneuver [m].

    Declaration

    Objective-C

    - (void)setRoundedDistToNextManeuver:(int)distance;

    Swift

    func setRoundedDistToNextManeuver(_ distance: Int32)

    Parameters

    distance

    the distance to the next maneuver [m].

  • Returns the distance from the next to the second next maneuver [m]

    Declaration

    Objective-C

    - (int)getRoundedDistFromNextToSecondNextManeuver;

    Swift

    func getRoundedDistFromNextToSecondNextManeuver() -> Int32

    Return Value

    the distance from the next to the second next maneuver [m]

  • Sets the distance from the next to the second next maneuver [m].

    Declaration

    Objective-C

    - (void)setRoundedDistFromNextToSecondNextManeuver:(int)distance;

    Swift

    func setRoundedDistFromNextToSecondNextManeuver(_ distance: Int32)

    Parameters

    distance

    the distance from the next to the second next maneuver [m].

  • Returns: Am I in a tunnel?

    Declaration

    Objective-C

    - (BOOL)getInTunnel;

    Swift

    func getInTunnel() -> Bool

    Return Value

    true if in tunnel.

  • Set: Am I in a tunnel?

    Declaration

    Objective-C

    - (void)setInTunnel:(BOOL)inTunnel;

    Swift

    func setInTunnel(_ inTunnel: Bool)

    Parameters

    inTunnel

    true if in tunnel.

  • NOT IMPLEMENTED

    Declaration

    Objective-C

    - (BOOL)getOnBridge;

    Swift

    func getOnBridge() -> Bool

    Return Value

    not implemented

  • NOT IMPLEMENTED

    Declaration

    Objective-C

    - (void)setOnBridge:(BOOL)onBridge;

    Swift

    func setOnBridge(_ onBridge: Bool)

    Parameters

    onBridge

    not implemented

  • Answers: Am I on the wrong road? Early indicator that the user has left the road.

    Declaration

    Objective-C

    - (BOOL)getWrongRoad;

    Swift

    func getWrongRoad() -> Bool

    Return Value

    true if wrong road.

  • Sets the information: Am I on the wrong road? Early indicator that the user has left the road.

    Declaration

    Objective-C

    - (void)setWrongRoad:(BOOL)wrongRoad;

    Swift

    func setWrongRoad(_ wrongRoad: Bool)

    Parameters

    wrongRoad

    true, if on wrong road

  • Destination reached? Set to true while near the destination. User should stop navigation/calling @link SDKGetGuidanceInformation then!

    Declaration

    Objective-C

    - (BOOL)getDestinationReached;

    Swift

    func getDestinationReached() -> Bool

    Return Value

    true if destination reached

  • Sets Destination reached? Set to SDK_TRUE while near the destination. User should stop navigation/calling @link SDKGetGuidanceInformation then!

    Declaration

    Objective-C

    - (void)setDestinationReached:(BOOL)destinationReached;

    Swift

    func setDestinationReached(_ destinationReached: Bool)

  • Indicates if the vehicle is on forbidden road

    Declaration

    Objective-C

    - (BOOL)getClosedArea;

    Swift

    func getClosedArea() -> Bool

    Return Value

    true if forbidden road.

  • Sets the information, the vehicle is on forbidden road.

    Declaration

    Objective-C

    - (void)setClosedArea:(BOOL)closedArea;

    Swift

    func setClosedArea(_ closedArea: Bool)

    Parameters

    closedArea

    true if forbidden road.

  • Did the ReRoute status change? (see @link ReRoutingModes)

    Declaration

    Objective-C

    - (NSDK_ReRouteMode)getReRouteStatus;

    Swift

    func getReRouteStatus() -> NSDK_ReRouteMode

    Return Value

    the reRouteStatus if ReRouteMode.ERROR: the native return code could not be parsed

  • Sets the ReRoute status.

    Declaration

    Objective-C

    - (void)setReRouteStatus:(NSDK_ReRouteMode)reRouteState;

    Swift

    func setReRouteStatus(_ reRouteState: NSDK_ReRouteMode)

    Parameters

    reRouteState

    the ReRoute status

  • Returns the guidance mode. See @link GuidanceKinds

    Declaration

    Objective-C

    - (NSDK_GuidanceKind)getGuidanceKind;

    Swift

    func getGuidanceKind() -> NSDK_GuidanceKind

    Return Value

    the guidance mode GuidanceKind.ERROR if the native value is not guilty

  • Sets the guidance mode. See @link GuidanceKinds

    Declaration

    Objective-C

    - (void)setGuidanceKind:(NSDK_GuidanceKind)guidanceKind;

    Swift

    func setGuidanceKind(_ guidanceKind: NSDK_GuidanceKind)

  • Returns the guidance mode. See @link GuidanceKinds.

    Declaration

    Objective-C

    - (NSDK_GuidanceKind)getNextGuidanceKind;

    Swift

    func getNextGuidanceKind() -> NSDK_GuidanceKind

    Return Value

    the guidance mode GuidanceKind.ERROR if the native value is not guilty

  • Sets the guidance mode. See @link GuidanceKinds

    Declaration

    Objective-C

    - (void)setNextGuidanceKind:(NSDK_GuidanceKind)guidanceKind;

    Swift

    func setNextGuidanceKind(_ guidanceKind: NSDK_GuidanceKind)

  • Returns the direction to target [0..360[ 0=N, 90=E.

    Declaration

    Objective-C

    - (short)getCrowFlightDirection;

    Swift

    func getCrowFlightDirection() -> Int16

    Return Value

    the direction to target

  • Sets the direction to target [0..360[ 0=N, 90=E.

    Declaration

    Objective-C

    - (void)setCrowFlightDirection:(short)direction;

    Swift

    func setCrowFlightDirection(_ direction: Int16)

    Parameters

    direction

    the direction to target

  • Returns the crow flight distance [m] from current GPS position on route to destination.

    Declaration

    Objective-C

    - (long)getCrowFlightGPSDistToDestination;

    Swift

    func getCrowFlightGPSDistToDestination() -> Int

    Return Value

    the crow flight distance.

  • Sets the crow flight distance [m] from current GPS position on route to destination.

    Declaration

    Objective-C

    - (void)setCrowFlightGPSDistToDestination:(long)distance;

    Swift

    func setCrowFlightGPSDistToDestination(_ distance: Int)

    Parameters

    distance

    the crow flight distance.

  • Returns truck warnings on current segment.

    Declaration

    Objective-C

    - (NSDK_TruckWarnings *)getTruckWarningsCurrentSegment;

    Swift

    func getTruckWarningsCurrentSegment() -> NSDK_TruckWarnings!

    Return Value

    the truck warnings on current segment.

  • Sets truck warnings on current segment.

    Declaration

    Objective-C

    - (void)setTruckWarningsCurrentSegment:(NSDK_TruckWarnings *)truckWarnings;

    Swift

    func setTruckWarningsCurrentSegment(_ truckWarnings: NSDK_TruckWarnings!)

    Parameters

    truckWarnings

    the truck warnings on current segment.

  • Returns the truck warnings on next segment.

    Declaration

    Objective-C

    - (NSDK_TruckWarnings *)getTruckWarningsNextSegment;

    Swift

    func getTruckWarningsNextSegment() -> NSDK_TruckWarnings!

    Return Value

    the truck warnings on next segment

  • Sets truck warnings on the next segment.

    Declaration

    Objective-C

    - (void)setTruckWarningsNextSegment:(NSDK_TruckWarnings *)truckWarnings;

    Swift

    func setTruckWarningsNextSegment(_ truckWarnings: NSDK_TruckWarnings!)

    Parameters

    truckWarnings

    the truck warnings on the next segment.

  • Get the current traffic delay on the complete route.

    Declaration

    Objective-C

    - (int)getTrafficDelayOnRoute:(BOOL)complete;

    Swift

    func getTrafficDelay(onRoute complete: Bool) -> Int32

    Parameters

    complete

    flag whether the delay for the complete route or from the current position should be returned

    Return Value

    the current traffic delay on the complete route

  • Sets the time [s] to destination.

    Declaration

    Objective-C

    - (void)setTimeToDestination:(long)time;

    Swift

    func setTimeToDestination(_ time: Int)

    Parameters

    time

    the time.

  • Returns the time [s] to destination. Use either this function or getEstimatedTimeOfArrival

    Declaration

    Objective-C

    - (long)getTimeToDestination;

    Swift

    func getTimeToDestination() -> Int

    Return Value

    the time.

  • Returns the estimated time when the destination will be reached. this is a convenience function for getTimeToDestination

    Declaration

    Objective-C

    - (NSDate *)getEstimatedTimeOfArrival;

    Swift

    func getEstimatedTimeOfArrival() -> Date!

    Return Value

    the estimated time of arrival.