程序包 net.sf.marineapi.nmea.sentence

接口 BODSentence

所有超级接口:
Sentence
public interface BODSentence extends Sentence
True and magnetic bearing from origin to destination in degrees. This sentence is transmitted by a GPS in the GOTO mode (with or without active route).

Example:
$GPBOD,234.9,T,228.8,M,RUSKI,*1D

作者:
Kimmo Tuukkanen

  • 方法详细资料

    • getDestinationWaypointId

      String getDestinationWaypointId()
      Get the ID of destination waypoint. This field should be always available in GOTO mode.
      返回:
      waypoint id
      抛出:
      DataNotAvailableException - If the data is not available.
      ParseException - If the field contains unexpected or illegal value.

    • getMagneticBearing

      double getMagneticBearing()
      Get the magnetic bearing from origin to destination.

      Notice: The bearing is calculated from the origin when GOTO is activated and it is not updated dynamically.

      返回:
      magnetic bearing value
      抛出:
      DataNotAvailableException - If the data is not available.
      ParseException - If the field contains unexpected or illegal value.

    • getOriginWaypointId

      String getOriginWaypointId()
      Get the ID of origin waypoint. This field is available only when route is active.
      返回:
      waypoint id
      抛出:
      DataNotAvailableException - If the data is not available.
      ParseException - If the field contains unexpected or illegal value.

    • getTrueBearing

      double getTrueBearing()
      Get the true bearing from origin to destination.

      Notice: Typically the bearing is calculated when GOTO mode is activated and it is not updated dynamically.

      返回:
      True bearing
      抛出:
      DataNotAvailableException - If the data is not available.
      ParseException - If the field contains unexpected or illegal value.

    • setDestinationWaypointId

      void setDestinationWaypointId(String id)
      Sets the destination waypoint ID.
      参数:
      id - ID to set

    • setMagneticBearing

      void setMagneticBearing(double bearing)
      Sets the true bearing from origin to destination, in degrees.
      参数:
      bearing - Bearing value
      抛出:
      IllegalArgumentException - If bearing value out range 0..360 degrees.

    • setOriginWaypointId

      void setOriginWaypointId(String id)
      Sets the ID of origin waypoint.
      参数:
      id - ID to set.

    • setTrueBearing

      void setTrueBearing(double bearing)
      Sets the true bearing from origin to destination, in degrees.
      参数:
      bearing - Bearing value
      抛出:
      IllegalArgumentException - If bearing value out range 0..360 degrees.