Method Detail

• public void addArrival(Reception rx)

  Adds a signal arrival at a modem in the channel.

  Parameters:

  rx - reception details.

• public void addTx(Transmission tx)

  Adds a modem transmission in the channel.

  Parameters:

  tx - transmission details.

• public boolean canNeglect(Reception rx)

  Checks if a signal arrival is too weak to care about.

  Parameters:

  rx - reception details.

  Returns:

  true if the signal is weak enough to neglect, false otherwise.

• public void cancelArrival(Reception rx)

  Cancels a scheduled/ongoing signal arrival at the modem in the channel. This happens when the transmitter aborts the relevant transmission.

  Parameters:

  rx - reception details.

• public void cancelTx(Transmission tx)

  Cancels a scheduled/ongoing modem transmission in the channel.

  Parameters:

  tx - transmission details.

• public float decodeRx(Reception rx)

  Checks if the reception can be decoded by the modem. This method is called when a modem stops receiving a frame.

  Parameters:

  rx - reception details.

  Returns:

  0 if the frame can be successfully decoded, BER otherwise.

• public boolean detectRx(Reception rx)

  Checks if the reception can be detected by the modem. This method is called when a modem is about to start receiving a frame.

  Parameters:

  rx - reception details.

  Returns:

  true if the modem can detect the frame, false otherwise.

• public float getCarrierFrequency()

  Gets the carrier frequency (kHz) in the channel.

  Returns:

  carrier frequency (kHz).

• public float getSoundSpeed()

  Gets the mean sound speed in the channel.

  Returns:

  sound speed in m/s.

• public void setTimestampProvider(TimestampProvider platform)

  Sets the time provider used to get current time.

  Parameters:

  platform - time provider.