AbstractAcousticChannel (UnetStack 3.4.0 API)

org.arl.unet.sim.channels.AbstractAcousticChannel

All Implemented Interfaces and Traits:

ChannelModel
```
public abstract class AbstractAcousticChannel
```
Base class for implementing acoustic channel models.

Field Summary

Fields
Modifiers	Name	Description
`protected TimestampProvider`	`clock`
`protected Logger`	`log`

Properties Summary

Properties
Type	Name and description
`double`	`bandwidth`
`double`	`irreduciblePER`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addArrival(Reception rx)`
	`void`	`addTx(Transmission tx)`
	`boolean`	`canNeglect(Reception rx)`
	`void`	`cancelArrival(Reception rx)`
	`void`	`cancelTx(Transmission tx)`
	`protected int`	`decode(Reception rx, double snr)` Simulates bit errors in a reception.
	`float`	`decodeRx(Reception rx)`
	`protected boolean`	`detect(Reception rx, double snr)` Simulates detection for a reception.
	`boolean`	`detectRx(Reception rx)`
	`double`	`getBandwidth()` Gets the bandwidth of the communication signal.
	`double`	`getIrreduciblePER()` Gets the irreducible packet error rate (PER).
	`void`	`setBandwidth(double bandwidth)` Sets the bandwidth of the communication signal.
	`void`	`setIrreduciblePER(double iper)` Sets the irreducible packet error rate (PER).
	`void`	`setTimestampProvider(TimestampProvider platform)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected TimestampProvider clock
  - protected Logger log
- Property Detail
  - double bandwidth
  - double irreduciblePER
- Method Detail
  - @Override public void addArrival(Reception rx)
  - @Override public void addTx(Transmission tx)
  - @Override public boolean canNeglect(Reception rx)
  - @Override public void cancelArrival(Reception rx)
  - @Override public void cancelTx(Transmission tx)
  - protected int decode(Reception rx, double snr)
    
    Simulates bit errors in a reception.
    Parameters:
    rx - received frame
    snr - signal-to-noise ratio
    Returns:
    number of bits in error in frame
  - @Override public float decodeRx(Reception rx)
  - protected boolean detect(Reception rx, double snr)
    
    Simulates detection for a reception.
    Parameters:
    rx - received frame
    snr - signal-to-noise ratio
    Returns:
    true if the preamble is detected, false otherwise
  - @Override public boolean detectRx(Reception rx)
  - public double getBandwidth()
    
    Gets the bandwidth of the communication signal.
    Returns:
    bandwidth in Hz
  - public double getIrreduciblePER()
    
    Gets the irreducible packet error rate (PER).
    Returns:
    minimum PER
  - public void setBandwidth(double bandwidth)
    
    Sets the bandwidth of the communication signal.
    Parameters:
    bandwidth - bandwidth in Hz
  - public void setIrreduciblePER(double iper)
    
    Sets the irreducible packet error rate (PER).
    Parameters:
    iper - minimum PER
  - @Override public void setTimestampProvider(TimestampProvider platform)

Summary:
Field
Property
Method

| Detail:
Field
Property
Method

[Java] Class AbstractAcousticChannel

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected TimestampProvider clock

protected Logger log

Property Detail

double bandwidth

double irreduciblePER

Method Detail

@Override public void addArrival(Reception rx)

@Override public void addTx(Transmission tx)

@Override public boolean canNeglect(Reception rx)

@Override public void cancelArrival(Reception rx)

@Override public void cancelTx(Transmission tx)

protected int decode(Reception rx, double snr)

@Override public float decodeRx(Reception rx)

protected boolean detect(Reception rx, double snr)

@Override public boolean detectRx(Reception rx)

public double getBandwidth()

public double getIrreduciblePER()

public void setBandwidth(double bandwidth)

public void setIrreduciblePER(double iper)

@Override public void setTimestampProvider(TimestampProvider platform)