Class NmeaDataSource.Location

  • Enclosing class:
    NmeaDataSource

    public static final class NmeaDataSource.Location
    extends LocationDataSource.Location
    Represents a NMEA location.
    Since:
    100.3.0
    • Constructor Detail

      • Location

        public Location​(Calendar timeStamp,
                        Point position,
                        double horizontalAccuracy,
                        double verticalAccuracy,
                        double velocity,
                        double course,
                        boolean lastKnown,
                        double pDop,
                        double hDop,
                        double vDop,
                        double dGpsAge,
                        int stationId,
                        NmeaDataSource.Location.FixType fixType,
                        Iterable<NmeaDataSource.Location.SatelliteInfo> satelliteInfoList,
                        NmeaDataSource.Location.AccuracyType accuracyType,
                        double geoIdSeparation)
        Constructs a NMEA Location with the given parameters.
        Parameters:
        timeStamp - a timestamp when location was received
        position - a Point representing the geographical position of the NMEA location
        horizontalAccuracy - the horizontal accuracy in meters
        verticalAccuracy - the vertical accuracy in meters
        velocity - the location's velocity in meters per second
        course - the location's course in degrees (clockwise), zero being true North
        lastKnown - a flag that indicates if the location represents a last known position, or is current
        pDop - Position Dilution of Precision (measure of accuracy in 3-D position), 0.5 through 99.9
        hDop - Horizontal Dilution of Precision (measure of accuracy in 2-D position, for example Latitude and Longitude), 0.5 through 99.9
        vDop - Vertical Dilution of Precision (measure of accuracy in 1-D position, Height), 0.5 through 99.9
        dGpsAge - the age of differential GPS data record in seconds, Type 1 or Type 9. Double.NaN when DGPS is not used
        stationId - reference station ID, range 0000-4095, -1 when any reference station ID is selected and no corrections are received
        fixType - a NMEA type of signal or technique being used by the GPS receiver to determine its location
        satelliteInfoList - a collection of NMEA satellite infos
        accuracyType - a NMEA accuracy type determines from which type of message accuracy has been calculated
        geoIdSeparation - Geoid separation - the height difference between the ellipsoidal surface and the geoid model's surface in meters
        Throws:
        IllegalArgumentException - if one of the following parameters is null:
        • timeStamp
        • position
        • fixType
        • satelliteInfoList
        • accuracyType
        Since:
        100.3.0
    • Method Detail

      • getPdop

        public double getPdop()
        Gets the Position Dilution of Precision (measure of accuracy in 3-D position), in range of 0.5 through 99.9 percent.
        Returns:
        the Position Dilution of Precision (measure of accuracy in 3-D position), in range of 0.5 through 99.9 percent
        Since:
        100.3.0
      • getHdop

        public double getHdop()
        Gets the Horizontal Dilution of Precision (measure of accuracy in 2-D position, for example Latitude and Longitude), in range of 0.5 through 99.9 percent.
        Returns:
        the Horizontal Dilution of Precision (measure of accuracy in 2-D position, for example Latitude and Longitude), in range of 0.5 through 99.9 percent
        Since:
        100.3.0
      • getVdop

        public double getVdop()
        Gets the Vertical Dilution of Precision (measure of accuracy in 1-D position, Height), in range of 0.5 through 99.9 percent.
        Returns:
        the Vertical Dilution of Precision (measure of accuracy in 1-D position, Height), in range of 0.5 through 99.9 percent
        Since:
        100.3.0
      • getDgpsAge

        public double getDgpsAge()
        Gets the age of Differential GPS data record, Type 1 or Type 9, in seconds.

        The DGPS age shows the age of the differential data (in seconds) and the time elapsed since the last valid differential correction received. Because the validity of a differential correction depends on the difference between the time the differential signal is calculated and the time it is used by the receiver, smaller values are better.

        Returns:
        the age of Differential GPS data record, Type 1 or Type 9, in seconds; Double.NaN when DGPS is not used
        Since:
        100.3.0
      • getReferenceStationId

        public int getReferenceStationId()
        Gets the Reference station ID, in range of 0 through 4095; -1 when any reference station ID is selected and no corrections are received.
        Returns:
        the Reference station ID, in range of 0 through 4095; -1 when any reference station ID is selected and no corrections are received
        Since:
        100.3.0
      • getFixType

        public NmeaDataSource.Location.FixType getFixType()
        Gets the type of signal or technique being used by the GPS receiver to determine it's location.
        Returns:
        the type of signal or technique being used by the GPS receiver to determine it's location
        Since:
        100.3.0
      • getSatellites

        public List<NmeaDataSource.Location.SatelliteInfo> getSatellites()
        Gets the satellite infos of the location.
        Returns:
        an unmodifiable list of satellite infos of the location
        Since:
        100.3.0
      • getGeoidSeparation

        public double getGeoidSeparation()
        Gets the geoid separation, the height difference between ellipsoidal surface and the geoid model's surface, in meters.
        Returns:
        the geoid separation, the height difference between ellipsoidal surface and the geoid model's surface, in meters
        Since:
        100.3.0