Package org.ka2ddo.aprs

Interface SetBeaconRatesIfc

All Known Implementing Classes:
BeaconData, ConfigureBeaconRates, ObjectReport, ObjectReportSender, SendableMessageWrapper, StatusData, Transmitter
public interface SetBeaconRatesIfc
This interface defines an API for an object that can accept beacon rate settings.
Author:
Andrew Pavlin, KA2DDO

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getDecayRatio()
    Get the scaling factor by which the message repeat interval is enlarged (until the default slow send rate is reached).
    int
    getInitialSendRate()
    Get the time interval between retransmissions when a message is newly introduced into the system.
    int
    getSlowSendRate()
    The slowest rate a message should be sent.
    boolean
    isUseGpsForPosition()
    Indicate whether beacon data source can dynamically change its position (latitude/longitude), such as for a mobile station with a GPS.
    void
    setDecayRatio(int decayRatio)
    Set the scaling factor by which the message repeat interval is enlarged (until the default slow send rate is reached).
    void
    setInitialSendRate(int initialSendRate)
    Set the time interval between retransmissions when a message is newly introduced into the system.
    void
    setSlowSendRate(int slowSendRate)
    Set the slowest rate a message should be sent.

  • Method Details

    • getDecayRatio

      int getDecayRatio()
      Get the scaling factor by which the message repeat interval is enlarged (until the default slow send rate is reached).
      Returns:
      int decay ratio

    • setDecayRatio

      void setDecayRatio(int decayRatio)
      Set the scaling factor by which the message repeat interval is enlarged (until the default slow send rate is reached).
      Parameters:
      decayRatio - int decay ratio (should be 2 or 3)

    • getInitialSendRate

      int getInitialSendRate()
      Get the time interval between retransmissions when a message is newly introduced into the system.
      Returns:
      send interval in seconds

    • setInitialSendRate

      void setInitialSendRate(int initialSendRate)
      Set the time interval between retransmissions when a message is newly introduced into the system.
      Parameters:
      initialSendRate - send interval in seconds

    • getSlowSendRate

      int getSlowSendRate()
      The slowest rate a message should be sent. For messages to be terminated, they should stop being requeued when the retransmission interval is enlarged to this.
      Returns:
      transmission interval in seconds

    • setSlowSendRate

      void setSlowSendRate(int slowSendRate)
      Set the slowest rate a message should be sent. For messages to be terminated, they should stop being requeued when the retransmission interval is enlarged to this.
      Parameters:
      slowSendRate - transmission interval in seconds

    • isUseGpsForPosition

      boolean isUseGpsForPosition()
      Indicate whether beacon data source can dynamically change its position (latitude/longitude), such as for a mobile station with a GPS.
      Returns:
      boolean true if latitude or longitude of beacon can change dynamically (not just through UI)