NSDK_GPSData

@interface NSDK_GPSData : NSObject

Contains information received from a real GPS receiver, data which is generated by parsing an externally provided NMEA data stream or by parsing a recorded GPS track.

@author PTV AG Karlsruhe

  • Undocumented

    Declaration

    Objective-C

    - (id) init;

    Swift

    init!()

  • Returns the current position.

    Declaration

    Objective-C

    - (NSDK_GeoPosition *)getGPSPosition;

    Swift

    func getGPSPosition() -> NSDK_GeoPosition!

    Return Value

    the current position

  • Returns the current position in format ‘NSDK_CoordinateSystem’. .

    Declaration

    Objective-C

    - (NSDK_Position *)getGPSPositionMerc;

    Swift

    func getGPSPositionMerc() -> NSDK_Position!

    Return Value

    the current position in format ‘NSDK_CoordinateSystem’.

  • Returns the altitude [m] as reported from GPS (may or may not include geoid correction).

    Declaration

    Objective-C

    - (int)getAltitude;

    Swift

    func getAltitude() -> Int32

    Return Value

    the altitude [m] as reported from GPS.

  • Returns the velocity [km/h].

    Declaration

    Objective-C

    - (int)getVelocity;

    Swift

    func getVelocity() -> Int32

    Return Value

    the velocity.

  • Returns the navigation direction ([0..360[ 0=East, 90=North).

    Declaration

    Objective-C

    - (int)getCourse;

    Swift

    func getCourse() -> Int32

    Return Value

    the navigation direction.

  • Returns the quality of the signal in percent, i.e. 0 for lowest, 100 for best precision.

    Declaration

    Objective-C

    - (int)getQuality;

    Swift

    func getQuality() -> Int32

    Return Value

    quality of the signal in percent.

  • Returns the number of satellites used for the fix.

    Declaration

    Objective-C

    - (short)getNoSats;

    Swift

    func getNoSats() -> Int16

    Return Value

    the number of satellites used for the fix.

  • Sets the GeoPosition.

    Declaration

    Objective-C

    - (void)setGPSPosition:(NSDK_GeoPosition *)gpsPosition;

    Swift

    func setGPSPosition(_ gpsPosition: NSDK_GeoPosition!)

    Parameters

    gpsPosition

    the GeoPosition to set.

  • Sets the current position (Mercator).

    Declaration

    Objective-C

    - (void)setGPSPositionMerc:(NSDK_Position *)gpsPositionMerc;

    Swift

    func setGPSPositionMerc(_ gpsPositionMerc: NSDK_Position!)

    Parameters

    gpsPositionMerc

    the current position (Mercator) to set.

  • Sets the altitude [m] as reported from GPS.

    Declaration

    Objective-C

    - (void)setAltitude:(int)altitude;

    Swift

    func setAltitude(_ altitude: Int32)

    Parameters

    altitude

    the altitude [m] as reported from GPS to set.

  • Sets the velocity [km/h].

    Declaration

    Objective-C

    - (void)setVelocity:(int)velocity;

    Swift

    func setVelocity(_ velocity: Int32)

    Parameters

    velocity

    to set.

  • Sets the navigation direction ([0..360[ 0=East, 90=North).

    Declaration

    Objective-C

    - (void)setCourse:(int)course;

    Swift

    func setCourse(_ course: Int32)

    Parameters

    course

    the navigation direction to set.

  • Sets the quality of the signal in percent, i.e. 0 for lowest, 100 for best precision.

    Declaration

    Objective-C

    - (void)setQuality:(int)quality;

    Swift

    func setQuality(_ quality: Int32)

    Parameters

    quality

    the quality of the signal

  • Sets the number of satellites used for the fix.

    Declaration

    Objective-C

    - (void)setNoSats:(short)noSats;

    Swift

    func setNoSats(_ noSats: Int16)

    Parameters

    noSats

    the number of satellites.

  • @return 0 if GPS device has no fix, >0 for a valid fix: 1=GPS (inkl. 2d/3d), 2=differential GPS (DGPS), 3= dead reckoning mode (DR), 4=unknown

    Declaration

    Objective-C

    - (short)getFix;

    Swift

    func getFix() -> Int16

  • Sets the fix information. 0 if GPS device has no fix, >0 for a valid fix: 1=GPS (inkl. 2d/3d), 2=differential GPS (DGPS), 3= dead reckoning mode (DR), 4=unknown

    Declaration

    Objective-C

    - (void)setFix:(short)fix;

    Swift

    func setFix(_ fix: Int16)

    Parameters

    fix

    the fix information to set.

  • Sets the date and time of the Gps data by the given NSDate object.

    To set the date and time the methods ‘setDate’ and ‘setTime’ are called.

    Declaration

    Objective-C

    - (void)setDateAndTime:(NSDate *)date;

    Swift

    func setDateAndTime(_ date: Date!)

    Parameters

    date

    The Calendar object which contains the date and time information.

  • Sets the date of the given NSDate as Gps date.

    Declaration

    Objective-C

    - (void)setDate:(NSDate *)date;

    Swift

    func setDate(_ date: Date!)

    Parameters

    date

    The date as NSDate object.

  • Sets the time of the given NSDate as Gps time.

    Declaration

    Objective-C

    - (void)setTime:(NSDate *)date;

    Swift

    func setTime(_ date: Date!)

    Parameters

    date

    The time as Calendar object.

  • Sets the time of the given NSDate as Gps time. The Gps time is calculated by the formula: gps time = hour of day * 1000000 + minute of hour * 10000 + second of minute * 100 + hundreds of a second.

    Declaration

    Objective-C

    - (void)setTimeWithInt:(int)time;

    Swift

    func setTimeWith(_ time: Int32)

    Parameters

    time

    the calculated int value

  • Sets the date of the given NSDate as Gps date. The Gps date is calculated by the formula: gps date = day of month * 10000 + month of year * 100 + (year>=2000) ? (year-2000) : (year-1990).

    Declaration

    Objective-C

    - (void)setDateWithInt:(int)date;

    Swift

    func setDateWith(_ date: Int32)

    Parameters

    date

    the calculated int value

  • Returns the applied Geoid separation [m].

    Declaration

    Objective-C

    - (int)getGeoidSep;

    Swift

    func getGeoidSep() -> Int32

    Return Value

    the applied Geoid separation [m].

  • Sets the applied Geoid separation [m].

    Declaration

    Objective-C

    - (void)setGeoidSep:(int)geoidSep;

    Swift

    func setGeoidSep(_ geoidSep: Int32)

    Parameters

    geoidSep

    the applied Geoid separation to set

  • Returns the number of satellites in view.

    Declaration

    Objective-C

    - (short)getNoSatsInView;

    Swift

    func getNoSatsInView() -> Int16

    Return Value

    the number of satellites in view.

  • Sets the number of satellites in view.

    Declaration

    Objective-C

    - (void)setNoSatsInView:(short)noSatsInView;

    Swift

    func setNoSatsInView(_ noSatsInView: Int16)

    Parameters

    noSatsInView

    the number of satellites in view to set.

  • Declaration

    Objective-C

    - (BOOL)isExtraPolated;

    Swift

    func isExtraPolated() -> Bool

    Return Value

    whether the information is based on (software) internal extrapolation.

  • Sets whether the information is based on (software) internal extrapolation.

    Declaration

    Objective-C

    - (void)setIsExtraPolated:(BOOL)isExtraPolated;

    Swift

    func setIsExtraPolated(_ isExtraPolated: Bool)

    Parameters

    isExtraPolated

    the information is based on (software) internal extrapolation.

  • Returns the extrapolated position.

    Declaration

    Objective-C

    - (NSDK_Position *)getExtraPolatedPos;

    Swift

    func getExtraPolatedPos() -> NSDK_Position!

    Return Value

    the extrapolated position.

  • Sets the extrapolated position.

    Declaration

    Objective-C

    - (void)setExtraPolatedPos:(NSDK_Position *)extraPolatedPos;

    Swift

    func setExtraPolatedPos(_ extraPolatedPos: NSDK_Position!)

    Parameters

    extraPolatedPos

    the extrapolated position to set.

  • Returns the extrapolated Velocity [km/h].

    Declaration

    Objective-C

    - (int)getExtraPolatedVelocity;

    Swift

    func getExtraPolatedVelocity() -> Int32

    Return Value

    the extrapolated Velocity [km/h].

  • Sets the extrapolated Velocity [km/h].

    Declaration

    Objective-C

    - (void)setExtraPolatedVelocity:(int)extraPolatedVelocity;

    Swift

    func setExtraPolatedVelocity(_ extraPolatedVelocity: Int32)

    Parameters

    extraPolatedVelocity

    the extrapolated Velocity to set.

  • Returns the extrapolated Navigation direction ([0..360[ 0=East, 90=North)

    Declaration

    Objective-C

    - (int)getExtraPolatedCourse;

    Swift

    func getExtraPolatedCourse() -> Int32

    Return Value

    the extrapolated Navigation direction.

  • Sets the extrapolated Navigation direction ([0..360[ 0=East, 90=North).

    Declaration

    Objective-C

    - (void)setExtraPolatedCourse:(int)extraPolatedCourse;

    Swift

    func setExtraPolatedCourse(_ extraPolatedCourse: Int32)

    Parameters

    extraPolatedCourse

    the extrapolated Navigation direction to set.