Package uicc.usim.geolocation

Interface GeoLocation

public interface GeoLocation
This interface defines services allowing an application to get information on the ME current geographical location.

  • Field Details

    • HORIZONTAL_ACCURACY_BEST_EFFORT

      static final byte HORIZONTAL_ACCURACY_BEST_EFFORT
      Horizontal accuracy: best effort
      See Also:

    • VERTICAL_COORDINATE_NOT_REQUESTED

      static final byte VERTICAL_COORDINATE_NOT_REQUESTED
      Vertical coordinate: not requested
      See Also:

    • VERTICAL_COORDINATE_REQUESTED_BEST_EFFORT

      static final byte VERTICAL_COORDINATE_REQUESTED_BEST_EFFORT
      Vertical coordinate: best effort
      See Also:

    • HORIZONTAL_VELOCITY_REQUESTED

      static final byte HORIZONTAL_VELOCITY_REQUESTED
      Horizontal velocity requested
      See Also:

    • VERTICAL_AND_HORIZONTAL_VELOCITY_REQUESTED

      static final byte VERTICAL_AND_HORIZONTAL_VELOCITY_REQUESTED
      Vertical velocity requested in addition to horizontal velocity
      See Also:

    • HORIZONTAL_VELOCITY_REQUESTED_WITH_UNCERTAINTY

      static final byte HORIZONTAL_VELOCITY_REQUESTED_WITH_UNCERTAINTY
      Uncertainty of horizontal velocity requested in addition to horizontal velocity
      See Also:

    • VERTICAL_AND_HORIZONTAL_VELOCITY_REQUESTED_WITH_UNCERTAINTY

      static final byte VERTICAL_AND_HORIZONTAL_VELOCITY_REQUESTED_WITH_UNCERTAINTY
      Uncertainty of vertical and horizontal velocity requested in addition to horizontal and vertical velocity
      See Also:

    • GET_HORIZONTAL_VELOCITY

      static final byte GET_HORIZONTAL_VELOCITY
      Obtain Horizontal Velocity Field from Velocity information.
      See Also:

    • GET_VERTICAL_VELOCITY

      static final byte GET_VERTICAL_VELOCITY
      Obtain Vertical Velocity Field from Velocity information.
      See Also:

    • GET_HORIZONTAL_UNCERTAINTY_VELOCITY

      static final byte GET_HORIZONTAL_UNCERTAINTY_VELOCITY
      Obtain Horizontal Uncertainty Velocity Field from Velocity information.
      See Also:

    • GET_VERTICAL_UNCERTAINTY_VELOCITY

      static final byte GET_VERTICAL_UNCERTAINTY_VELOCITY
      Obtain Vertical Uncertainty Velocity Field from Velocity information.
      See Also:

    • GAD_SHAPES_ELLIPSOID_POINT

      static final byte GAD_SHAPES_ELLIPSOID_POINT
      GAD shape: Ellipsoid point
      See Also:

    • GAD_SHAPES_ELLIPSOID_POINT_WITH_UNCERTAINTY_CIRCLE

      static final byte GAD_SHAPES_ELLIPSOID_POINT_WITH_UNCERTAINTY_CIRCLE
      GAD shape: Ellipsoid point with uncertainty circle
      See Also:

    • GAD_SHAPES_ELLIPSOID_POINT_WITH_UNCERTAINTY_ELLIPSE

      static final byte GAD_SHAPES_ELLIPSOID_POINT_WITH_UNCERTAINTY_ELLIPSE
      GAD shape: Ellipsoid point with uncertainty ellipse
      See Also:

    • GAD_SHAPES_ELLIPSOID_POINT_WITH_ALTITUDE

      static final byte GAD_SHAPES_ELLIPSOID_POINT_WITH_ALTITUDE
      GAD shape: Ellipsoid point with altitude
      See Also:

    • GAD_SHAPES_POLYGON

      static final byte GAD_SHAPES_POLYGON
      GAD shape: Polygon
      See Also:

    • GAD_SHAPES_ELLIPSOID_POINT_WITH_ALTITUDE_AND_UNCERTAINTY_ELLIPSOID

      static final byte GAD_SHAPES_ELLIPSOID_POINT_WITH_ALTITUDE_AND_UNCERTAINTY_ELLIPSOID
      GAD shape: Ellipsoid point with altitude and uncertainty ellipsoid
      See Also:

    • GAD_SHAPES_ELLIPSOID_ARC

      static final byte GAD_SHAPES_ELLIPSOID_ARC
      GAD shape: Ellipsoid arc
      See Also:

    • PREFERRED_NMEA_SENTENCE_RMC

      static final byte PREFERRED_NMEA_SENTENCE_RMC
      Preferred NMEA sentence: _RMC
      See Also:

    • PREFERRED_NMEA_SENTENCE_GGA

      static final byte PREFERRED_NMEA_SENTENCE_GGA
      Preferred NMEA sentence: _GGA
      See Also:

    • PREFERRED_NMEA_SENTENCE_GLL

      static final byte PREFERRED_NMEA_SENTENCE_GLL
      Preferred NMEA sentence: _GLL
      See Also:

    • PREFERRED_NMEA_SENTENCE_GNS

      static final byte PREFERRED_NMEA_SENTENCE_GNS
      Preferred NMEA sentence: _GNS
      See Also:

  • Method Details

    • setAlphaIdentifier

      void setAlphaIdentifier(byte[] alphaIdentifier)
      Set alpha identifier parameter for this object as defined in 3GPP TS 31.111 [7].
      Parameters:
      alphaIdentifier - Alpha identifier TLV as defined in 3GPP TS 31.111 [7].

    • setIconIdentifier

      void setIconIdentifier(short iconIdentifier)
      Set icon identifier parameter for this object as defined in 3GPP TS 31.111 [7].
      Parameters:
      iconIdentifier - Value part of Icon identifier TLV as defined in 3GPP TS 31.111 [7].
      Throws:
      GeoLocationException - with the following reason codes:
      • INCORRECT_PARAMETERS in case of bad parameter is set.

    • setHorizontalAccuracy

      void setHorizontalAccuracy(byte horizontalAccuracy)
      Set horizontal accuracy parameter for this object as defined in 3GPP TS 31.111 [7].
      Parameters:
      horizontalAccuracy - as defined in 3GPP TS 31.111.
      The horizontalAccuracy value shall be:
      • in the range '00' to '7F', or
      • HORIZONTAL_ACCURACY_BEST_EFFORT
      Throws:
      GeoLocationException - with the following reason codes:
      • INCORRECT_PARAMETERS in case of bad parameter is set.

    • setVerticalCoordinate

      void setVerticalCoordinate(byte verticalCoordinate)
      Set vertical coordinate parameter for this object as defined in 3GPP TS 31.111 [7].
      Parameters:
      verticalCoordinate - as defined in 3GPP TS 31.111.
      The verticalCoordinate value shall be:
      • in the range '00' to '7F', or
      • VERTICAL_COORDINATE_NOT_REQUESTED, or
      • VERTICAL_COORDINATE_REQUESTED_BEST_EFFORT
      Throws:
      GeoLocationException - with the following reason codes:
      • INCORRECT_PARAMETERS in case of bad parameter is set.

    • setVelocity

      void setVelocity(byte velocity)
      Set velocity parameter for this object as defined in 3GPP TS 31.111 [7].
      Parameters:
      velocity - byte to identify the Velocity Type to return. Possible value, one or combination (OR operation) of:
      • HORIZONTAL_VELOCITY_REQUESTED
      • VERTICAL_AND_HORIZONTAL_VELOCITY_REQUESTED
      • HORIZONTAL_VELOCITY_REQUESTED_WITH_UNCERTAINTY
      • VERTICAL_AND_HORIZONTAL_VELOCITY_REQUESTED_WITH_UNCERTAINTY
      Throws:
      GeoLocationException - with the following reason codes:
      • INCORRECT_PARAMETERS in case of bad parameter is set.

    • setAcceptedGADShapes

      void setAcceptedGADShapes(byte acceptedGADShapes)
      Set accepted GAD shapes parameter for this object as defined in 3GPP TS 31.111 [7].
      Parameters:
      acceptedGADShapes - GAD shapes as defined in 3GPP TS 31.111[7].
      Possible values:
      • GAD_SHAPES_ELLIPSOID_POINT
      • GAD_SHAPES_ELLIPSOID_POINT_WITH_UNCERTAINTY_CIRCLE
      • GAD_SHAPES_ELLIPSOID_POINT_WITH_UNCERTAINTY_ELLIPSE
      • GAD_SHAPES_ELLIPSOID_POINT_WITH_ALTITUDE
      • GAD_SHAPES_POLYGON
      • GAD_SHAPES_ELLIPSOID_POINT_WITH_ALTITUDE_AND_UNCERTAINTY_ELLIPSOID
      • GAD_SHAPES_ELLIPSOID_ARC
      Throws:
      GeoLocationException - with the following reason codes:
      • INCORRECT_PARAMETERS in case of bad parameter is set.

    • setPreferredNMEASentences

      void setPreferredNMEASentences(byte preferredNMEASentences)
      Set Preferred NMEA sentences parameter for this object as defined in 3GPP TS 31.111 [7].
      Parameters:
      preferredNMEASentences - as defined in 3GPP TS 31.111[7].
      Possible values:
      • PREFERRED_NMEA_SENTENCE_RMC
      • PREFERRED_NMEA_SENTENCE_GGA
      • PREFERRED_NMEA_SENTENCE_GLL
      • PREFERRED_NMEA_SENTENCE_GNS
      Throws:
      GeoLocationException - with the following reason codes:
      • INCORRECT_PARAMETERS in case of bad parameter is set.

    • setPreferredMaximumResponseTime

      void setPreferredMaximumResponseTime(byte preferredMaximumResponseTime)
      Set Preferred Maximum Response Time parameter for this object as defined in 3GPP TS 31.111 [7].
      Parameters:
      preferredMaximumResponseTime - as defined in 3GPP TS 31.111[7].
      preferredMaximumResponseTime shall be in the range'02' to '07' where 2^'xx' represents the preferred maximum response time in seconds
      Throws:
      GeoLocationException - with the following reason codes:
      • INCORRECT_PARAMETERS in case of bad parameter is set.

    • performGeoLocationRequest

      void performGeoLocationRequest(GeoLocationEventListener geoLocationEventListener) throws GeoLocationException, uicc.toolkit.ToolkitException
      Request a geographical location operation, using parameters defined in the object. A callback mechanism is used to retrieve the result, when available, using the geoLocationEventListener object.
      If the ME has indicated in its Terminal Profile that it supports "class n" ("Geographical Location Request" see TS 31.111[7] for more details) the system will first send out a "Geographical Location Request" proactive command.
      • If the Terminal Response from the ME indicates that the commands can be performed successfully the actual Geo Location information will be made available through a GeoLocationInformation object.
      • If the Terminal Response from the ME indicates that it can not perform this command, an exception is thrown, UNABLE_TO_PROCESS_COMMAND.
      If the ME does not support "class n", an exception is thrown, UNABLE_TO_PROCESS_COMMAND.
      Parameters:
      geoLocationEventListener - the callback object to be invoked once the result is available.
      Throws:
      NullPointerException - if geoLocationEventListener is null
      GeoLocationException - with the following reason codes:
      • FUNCTION_DISABLED in case the ME is currently unable to get the location information (e.g. due to lack of GPS coverage or due to a deactivated GPS receiver).
      • UNABLE_TO_PROCESS_COMMAND in case the ME is not equipped with a positioning feature.
      • LOCATION_REQUEST_PROCESSING in case a Geographical Location Request has already been issued and the Envelope Geographical Location Reporting is expected.
      uicc.toolkit.ToolkitException - with the following reason code:
      • HANDLER_NOT_AVAILABLE if there is on-going proactive session