Interface GnssMultiFrame.Builder

  • Method Details

    • captures

      List of GNSS scan captures. Each capture contains a payload from a single GNSS scan. The number of captures must be 2, 4, 8, 16, or 32.

      Parameters:
      captures - List of GNSS scan captures. Each capture contains a payload from a single GNSS scan. The number of captures must be 2, 4, 8, 16, or 32.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • captures

      GnssMultiFrame.Builder captures(GnssCapture... captures)

      List of GNSS scan captures. Each capture contains a payload from a single GNSS scan. The number of captures must be 2, 4, 8, 16, or 32.

      Parameters:
      captures - List of GNSS scan captures. Each capture contains a payload from a single GNSS scan. The number of captures must be 2, 4, 8, 16, or 32.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • captures

      List of GNSS scan captures. Each capture contains a payload from a single GNSS scan. The number of captures must be 2, 4, 8, 16, or 32.

      This is a convenience method that creates an instance of the GnssCapture.Builder avoiding the need to create one manually via GnssCapture.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to captures(List<GnssCapture>).

      Parameters:
      captures - a consumer that will call methods on GnssCapture.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • captureTimeAccuracy

      GnssMultiFrame.Builder captureTimeAccuracy(Float captureTimeAccuracy)

      Optional value that gives the capture time estimate accuracy, in seconds. If capture time accuracy is not specified, default value of 300 is used.

      Parameters:
      captureTimeAccuracy - Optional value that gives the capture time estimate accuracy, in seconds. If capture time accuracy is not specified, default value of 300 is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • assistPosition

      GnssMultiFrame.Builder assistPosition(Collection<Float> assistPosition)

      Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.

      Parameters:
      assistPosition - Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • assistPosition

      GnssMultiFrame.Builder assistPosition(Float... assistPosition)

      Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.

      Parameters:
      assistPosition - Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • assistAltitude

      GnssMultiFrame.Builder assistAltitude(Float assistAltitude)

      Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid. This parameter is required when Use2DSolver is enabled.

      Parameters:
      assistAltitude - Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid. This parameter is required when Use2DSolver is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • use2DSolver

      GnssMultiFrame.Builder use2DSolver(Boolean use2DSolver)

      Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.

      Parameters:
      use2DSolver - Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.