ProtocolChannelModel (UnetStack 3.0.2 API)

org.arl.unet.sim.channels.ProtocolChannelModel

All Implemented Interfaces and Traits:

ChannelModel
```
public class ProtocolChannelModel
```
Protocol channel model. This channel model ignores power level settings and assumes constant performance with range until the communication range. It also assumes that any collision within the interference range causes a frame to be lost. The performance can be characterized by a probability of frame detection and probability of successful decoding.

Field Summary

Fields
Modifiers	Name	Description
`float`	`communicationRange`	Maximum distance for successful communication (meters).
`float`	`detectionRange`	Maximum distance for detection of frame (meters).
`float`	`fc`	Carrier frequency (kHz).
`float`	`interferenceRange`	Maximum distance for interference from a source (meters).
`float`	`pDecoding`	Probability of successful decoding of frame, when within communication range.
`float`	`pDetection`	Probability of frame detection, when within detection range.
`float`	`soundSpeed`	Sound speed (m/s).

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)`
	`float`	`decodeRx(Reception rx)`
	`boolean`	`detectRx(Reception rx)`
	`float`	`getCarrierFrequency()`
	`protected float`	`getProbabilityDecoding(Reception rx)` Returns the probability of decoding for a given reception.
	`protected float`	`getProbabilityDetection(Reception rx)` Returns the probability of detection for a given reception.
	`float`	`getSoundSpeed()`
	`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
  - public float communicationRange
    
    Maximum distance for successful communication (meters).
  - public float detectionRange
    
    Maximum distance for detection of frame (meters).
  - public float fc
    
    Carrier frequency (kHz).
  - public float interferenceRange
    
    Maximum distance for interference from a source (meters).
  - public float pDecoding
    
    Probability of successful decoding of frame, when within communication range.
  - public float pDetection
    
    Probability of frame detection, when within detection range.
  - public float soundSpeed
    
    Sound speed (m/s).
- 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)
  - @Override public float decodeRx(Reception rx)
  - @Override public boolean detectRx(Reception rx)
  - @Override public float getCarrierFrequency()
  - protected float getProbabilityDecoding(Reception rx)
    
    Returns the probability of decoding for a given reception. The default implementation simply returns pDecoding. However, a child class may override this method to provide a link-dependent probability.
    Parameters:
    rx - reception
    Returns:
    probability of decoding
  - protected float getProbabilityDetection(Reception rx)
    
    Returns the probability of detection for a given reception. The default implementation simply returns pDetection. However, a child class may override this method to provide a link-dependent probability.
    Parameters:
    rx - reception
    Returns:
    probability of detection
  - @Override public float getSoundSpeed()
  - @Override public void setTimestampProvider(TimestampProvider platform)

Summary:
Field
Method

| Detail:
Field
Method

[Java] Class ProtocolChannelModel

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public float communicationRange

public float detectionRange

public float fc

public float interferenceRange

public float pDecoding

public float pDetection

public float soundSpeed

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)

@Override public float decodeRx(Reception rx)

@Override public boolean detectRx(Reception rx)

@Override public float getCarrierFrequency()

protected float getProbabilityDecoding(Reception rx)

protected float getProbabilityDetection(Reception rx)

@Override public float getSoundSpeed()

@Override public void setTimestampProvider(TimestampProvider platform)