HalfDuplexModem (UnetStack 3.4.0 API)

org.arl.unet.sim.HalfDuplexModem

Generic modem physical layer agent for simulation.

Field Summary

Fields
Modifiers	Name	Description
`float`	`basebandRate`	Baseband sampling rate (Hz).
`float`	`basebandRxDuration`	Baseband reception duration (s).
`float`	`carrierFrequency`	Carrier frequency (Hz).
`ChannelModel`	`channel`	Channel model to use for simulating transmission, reception and interference.
`float[]`	`dataRate`	Communication link data rate (bps) for CONTROL and DATA channels.
`static String`	`description`
`int[]`	`frameLength`	Frame length (bytes) for CONTROL and DATA channels.
`int`	`headerLength`	Frame header length in bytes.
`boolean[]`	`janus`	Support for JANUS frames.
`int[]`	`maxFrameLength`	Maximum frame length (bytes) for CONTROL and DATA channels.
`float`	`maxPowerLevel`	Maximum allowable transmit power level (dB re refPowerLevel).
`int`	`maxSignalLength`	Maximum allowable baseband signal length.
`float`	`minPowerLevel`	Minimum allowable transmit power level (dB re refPowerLevel).
`float[]`	`powerLevel`	Transmit power level (dB re refPowerLevel) for CONTROL and DATA channels.
`float`	`preambleDuration`	Frame detection preamble duration in seconds.
`float`	`refPowerLevel`	Reference transmit power level (dB re uPa @ 1m).
`float`	`rxSensitivity`	Reference receive sensitivity (dB re uPa).
`float`	`signalPowerLevel`	Transmit power level (dB re refPowerLevel) for baseband signals.
`int`	`timestampLength`	Timestamp length in bytes, for timestamped frames.
`float`	`timestampedTxDelay`	Transmission delay in seconds when scheduling transmission of a timestamped packet.
`static String`	`title`
`Tracer`	`tracer`	Tracer to use for logging events.
`float`	`txDelay`	Transmission delay in seconds when switching from receive to transmit mode.

Inherited fields
Fields inherited from class	Fields
`class UnetAgent`	`timeout`

Properties Summary

Properties
Type	Name and description
`float`	`basebandRxDuration`
`float`	`clockOffset`
`Float`	`dataRate`
`Integer`	`frameLength`
`int`	`janus`
`Integer`	`maxFrameLength`
`Float`	`powerLevel`
`Float`	`signalPowerLevel`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`def`	`HalfDuplexModem()`
	`float`	`getBasebandRate()` Gets the baseband sampling rate.
	`float`	`getBasebandRxDuration()` Gets the baseband recording duration when baseband preamble is received.
	`boolean`	`getBusy()` Checks if modem is busy transmitting/receiving.
	`float`	`getCarrierFrequency()` Gets the default carrier frequency.
	`float`	`getClockOffset()` Gets time offset of this node's clock.
	`Float`	`getDataRate(int type)` Gets the frame data rate for data or control channel.
	`Integer`	`getErrorDetection(int type)` Get error detection.
	`Integer`	`getFec(int type)` Get FEC.
	`List<String>`	`getFecList(int type)` Get FEC list.
	`Float`	`getFrameDuration(int type)` Get frame duration.
	`Integer`	`getFrameLength(int type)` Gets the frame length for data or control channel.
	`Boolean`	`getJanus(int type)` Checks for support for JANUS frames.
	`Boolean`	`getLlr(int type)` Checks for support for log-likelihood ratio reporting.
	`Integer`	`getMTU()` Get maximum frame size for DATA channel.
	`Integer`	`getMTU(int type)` Get maximum frame size.
	`Integer`	`getMaxFrameLength(int type)` Gets the maximum possible frame length.
	`Float`	`getMaxPowerLevel(int type)` Gets maximum possible power level.
	`int`	`getMaxPreambleID()` Gets the number of preambles supported.
	`int`	`getMaxSignalLength()` Gets the maximum length of a baseband signal.
	`Float`	`getMinPowerLevel(int type)` Gets minimum possible power level.
	`Float`	`getNoise()` Gets the noise power.
	`protected List<Parameter>`	`getParameterList()`
	`protected List<Parameter>`	`getParameterList(int index)`
	`Float`	`getPowerLevel(int type)` Gets power level for data or control channel.
	`float`	`getPreambleDuration()` Gets the preamble duration in seconds.
	`float`	`getPropagationSpeed()` Get signal propagation speed.
	`Integer`	`getRTU()` Get recommended frame size for DATA channel.
	`Integer`	`getRTU(int type)` Get recommended frame size.
	`float`	`getRefPowerLevel()` Gets reference power level.
	`boolean`	`getRxEnable()` Checks if reception is enabled.
	`float`	`getRxSensitivity()` Gets reference receive sensitivity.
	`Float`	`getSignalPowerLevel()` Gets power level for baseband signal transmission.
	`long`	`getTime()` Get current physical layer clock.
	`float`	`getTimestampedTxDelay()` Get transmission delay incurred for a timestamped transmission.
	`protected void`	`processMessage(Message msg)`
	`protected Message`	`processRequest(Message msg)`
	`float`	`setBasebandRxDuration(float value)` Sets the baseband recording duration when baseband preamble is received.
	`float`	`setClockOffset(float t)` Sets time offset of this node's clock.
	`Float`	`setDataRate(int type, int value)` Sets the frame data rate for data or control channel.
	`Integer`	`setFrameLength(int type, int value)` Sets the frame length for data or control channel.
	`Boolean`	`setJanus(int type, boolean value)` Enables/disables support for JANUS frames.
	`Integer`	`setMaxFrameLength(int type, int value)` Gets the maximum possible frame length.
	`Float`	`setPowerLevel(int type, float value)` Sets power level for data or control channel.
	`boolean`	`setRxEnable(boolean value)` Enables or disables reception.
	`Float`	`setSignalPowerLevel(float value)` Sets power level for baseband signal transmission.
	`protected void`	`setup()`
	`protected void`	`startup()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class UnetAgent`	`addCapability, allOf, deregister, deregister, die, get, get, getBuildInfo, getLogLevel, getParam, getParameterClasses, getParameterClasses, getParameterList, getParameterList, getServices, getTitle, getVersion, init, isReadOnly, longValue, processMessage, processQuery, processRequest, register, register, set, set, setLogLevel, setParam, setup, shutdown, startup, subscribeForService, subscribeForService, trace, trace, trace, unsubscribeForService, unsubscribeForService`

- Field Detail
  - public float basebandRate
    
    Baseband sampling rate (Hz).
  - public float basebandRxDuration
    
    Baseband reception duration (s).
  - public float carrierFrequency
    
    Carrier frequency (Hz).
  - public ChannelModel channel
    
    Channel model to use for simulating transmission, reception and interference.
  - public float[] dataRate
    
    Communication link data rate (bps) for CONTROL and DATA channels.
  - public static final String description
  - public int[] frameLength
    
    Frame length (bytes) for CONTROL and DATA channels.
  - public int headerLength
    
    Frame header length in bytes.
  - public boolean[] janus
    
    Support for JANUS frames.
  - public int[] maxFrameLength
    
    Maximum frame length (bytes) for CONTROL and DATA channels.
  - public float maxPowerLevel
    
    Maximum allowable transmit power level (dB re refPowerLevel).
  - public int maxSignalLength
    
    Maximum allowable baseband signal length.
  - public float minPowerLevel
    
    Minimum allowable transmit power level (dB re refPowerLevel).
  - public float[] powerLevel
    
    Transmit power level (dB re refPowerLevel) for CONTROL and DATA channels.
  - public float preambleDuration
    
    Frame detection preamble duration in seconds.
  - public float refPowerLevel
    
    Reference transmit power level (dB re uPa @ 1m).
  - public float rxSensitivity
    
    Reference receive sensitivity (dB re uPa).
  - public float signalPowerLevel
    
    Transmit power level (dB re refPowerLevel) for baseband signals.
  - public int timestampLength
    
    Timestamp length in bytes, for timestamped frames.
  - public float timestampedTxDelay
    
    Transmission delay in seconds when scheduling transmission of a timestamped packet.
  - public static final String title
  - public Tracer tracer
    
    Tracer to use for logging events.
  - public float txDelay
    
    Transmission delay in seconds when switching from receive to transmit mode.
- Property Detail
  - float basebandRxDuration
  - float clockOffset
  - Float dataRate
  - Integer frameLength
  - int janus
  - Integer maxFrameLength
  - Float powerLevel
  - Float signalPowerLevel
- Method Detail
  - public def HalfDuplexModem()
  - public float getBasebandRate()
    
    Gets the baseband sampling rate.
    Returns:
    sampling rate in Hz
  - public float getBasebandRxDuration()
    
    Gets the baseband recording duration when baseband preamble is received.
    Returns:
    duration to record in seconds
  - public boolean getBusy()
    
    Checks if modem is busy transmitting/receiving.
    Returns:
    true if modem is busy, false if it is idle
  - public float getCarrierFrequency()
    
    Gets the default carrier frequency.
    Returns:
    carrier frequency in Hz
  - public float getClockOffset()
    
    Gets time offset of this node's clock.
    Returns:
    time offset in seconds
  - public Float getDataRate(int type)
    
    Gets the frame data rate for data or control channel.
    Parameters:
    type - DATA or CONTROL
    Returns:
    frame data rate in bps
  - public Integer getErrorDetection(int type)
    
    Get error detection.
    Parameters:
    type - DATA or CONTROL
    Returns:
    1 for CRC8
  - public Integer getFec(int type)
    
    Get FEC.
    Parameters:
    type - DATA or CONTROL
    Returns:
    0 for default
  - public List<String> getFecList(int type)
    
    Get FEC list.
    Parameters:
    type - DATA or CONTROL
    Returns:
    empty list.
  - public Float getFrameDuration(int type)
    
    Get frame duration.
    Parameters:
    type - DATA or CONTROL
    Returns:
    maximum frame duration in milliseconds
  - public Integer getFrameLength(int type)
    
    Gets the frame length for data or control channel.
    Parameters:
    type - DATA or CONTROL
    Returns:
    frame length in bytes
  - public Boolean getJanus(int type)
    
    Checks for support for JANUS frames.
    Parameters:
    type - DATA or CONTROL
    Returns:
    true, if supported, false otherwise
  - public Boolean getLlr(int type)
    
    Checks for support for log-likelihood ratio reporting.
    Parameters:
    type - DATA or CONTROL
    Returns:
    true, if supported, false otherwise
  - public Integer getMTU()
    
    Get maximum frame size for DATA channel.
    Returns:
    maximum frame size in bytes
  - public Integer getMTU(int type)
    
    Get maximum frame size.
    Parameters:
    type - DATA or CONTROL
    Returns:
    maximum frame size in bytes
  - public Integer getMaxFrameLength(int type)
    
    Gets the maximum possible frame length.
    Parameters:
    type - DATA or CONTROL
    Returns:
    maximum frame length in bytes
  - public Float getMaxPowerLevel(int type)
    
    Gets maximum possible power level.
    Parameters:
    type - DATA or CONTROL
    Returns:
    power level in dB re reference power level
  - public int getMaxPreambleID()
    
    Gets the number of preambles supported.
    Returns:
    number of preambles supported
  - public int getMaxSignalLength()
    
    Gets the maximum length of a baseband signal.
    Returns:
    length in baseband samples
  - public Float getMinPowerLevel(int type)
    
    Gets minimum possible power level.
    Parameters:
    type - DATA or CONTROL
    Returns:
    power level in dB re reference power level
  - public Float getNoise()
    
    Gets the noise power.
    Returns:
    noise power in dB
  - @Override protected List<Parameter> getParameterList()
  - @Override protected List<Parameter> getParameterList(int index)
  - public Float getPowerLevel(int type)
    
    Gets power level for data or control channel.
    Parameters:
    type - DATA or CONTROL
    Returns:
    power in dB re reference power level
  - public float getPreambleDuration()
    
    Gets the preamble duration in seconds.
    Returns:
    preamble duration
  - public float getPropagationSpeed()
    
    Get signal propagation speed.
    Returns:
    speed
  - public Integer getRTU()
    
    Get recommended frame size for DATA channel.
    Returns:
    recommended frame size in bytes
  - public Integer getRTU(int type)
    
    Get recommended frame size.
    Parameters:
    type - DATA or CONTROL
    Returns:
    recommended frame size in bytes
  - public float getRefPowerLevel()
    
    Gets reference power level. @ 1m
    Returns:
    power level in dB re 1uPa
  - public boolean getRxEnable()
    
    Checks if reception is enabled.
    Returns:
    true if reception enabled
  - public float getRxSensitivity()
    
    Gets reference receive sensitivity.
    Returns:
    reference receive sensititivy in dB re uPa
  - public Float getSignalPowerLevel()
    
    Gets power level for baseband signal transmission.
    Returns:
    power in dB re reference power level
  - public long getTime()
    
    Get current physical layer clock.
    Returns:
    time in microseconds
  - public float getTimestampedTxDelay()
    
    Get transmission delay incurred for a timestamped transmission.
    Returns:
    delay in seconds
  - @Override protected void processMessage(Message msg)
  - @Override protected Message processRequest(Message msg)
  - public float setBasebandRxDuration(float value)
    
    Sets the baseband recording duration when baseband preamble is received.
    Parameters:
    value - duration in seconds
    Returns:
    duration to record in seconds
  - public float setClockOffset(float t)
    
    Sets time offset of this node's clock.
    Parameters:
    t - offset in seconds
    Returns:
    time offset in seconds
  - public Float setDataRate(int type, int value)
    
    Sets the frame data rate for data or control channel.
    Parameters:
    type - DATA or CONTROL
    value - frame data rate in bps
    Returns:
    frame data rate in bps
  - public Integer setFrameLength(int type, int value)
    
    Sets the frame length for data or control channel.
    Parameters:
    type - DATA or CONTROL
    value - frame length in bytes
    Returns:
    frame length in bytes
  - public Boolean setJanus(int type, boolean value)
    
    Enables/disables support for JANUS frames.
    Parameters:
    type - DATA or CONTROL
    value - true to enable, false to disable
    Returns:
    true, if supported, false otherwise
  - public Integer setMaxFrameLength(int type, int value)
    
    Gets the maximum possible frame length.
    Parameters:
    type - DATA or CONTROL
    value - maximum frame length in bytes
    Returns:
    maximum frame length in bytes
  - public Float setPowerLevel(int type, float value)
    
    Sets power level for data or control channel.
    Parameters:
    type - DATA or CONTROL
    value - value in dB re reference power level
    Returns:
    new value of power level
  - public boolean setRxEnable(boolean value)
    
    Enables or disables reception.
    Parameters:
    value - true to enable, false to disable reception
    Returns:
    true if reception is enabled
  - public Float setSignalPowerLevel(float value)
    
    Sets power level for baseband signal transmission.
    Parameters:
    value - value in dB re reference power level
    Returns:
    new value of power level
  - @Override protected void setup()
  - @Override protected void startup()

Summary:
Field
Property
Method

| Detail:
Field
Property
Method

[Java] Class HalfDuplexModem

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public float basebandRate

public float basebandRxDuration

public float carrierFrequency

public ChannelModel channel

public float[] dataRate

public static final String description

public int[] frameLength

public int headerLength

public boolean[] janus

public int[] maxFrameLength

public float maxPowerLevel

public int maxSignalLength

public float minPowerLevel

public float[] powerLevel

public float preambleDuration

public float refPowerLevel

public float rxSensitivity

public float signalPowerLevel

public int timestampLength

public float timestampedTxDelay

public static final String title

public Tracer tracer

public float txDelay

Property Detail

float basebandRxDuration

float clockOffset

Float dataRate

Integer frameLength

int janus

Integer maxFrameLength

Float powerLevel

Float signalPowerLevel

Method Detail

public def HalfDuplexModem()

public float getBasebandRate()

public float getBasebandRxDuration()

public boolean getBusy()

public float getCarrierFrequency()

public float getClockOffset()

public Float getDataRate(int type)

public Integer getErrorDetection(int type)

public Integer getFec(int type)

public List<String> getFecList(int type)

public Float getFrameDuration(int type)

public Integer getFrameLength(int type)

public Boolean getJanus(int type)

public Boolean getLlr(int type)

public Integer getMTU()

public Integer getMTU(int type)

public Integer getMaxFrameLength(int type)

public Float getMaxPowerLevel(int type)

public int getMaxPreambleID()

public int getMaxSignalLength()

public Float getMinPowerLevel(int type)

public Float getNoise()

@Override protected List<Parameter> getParameterList()

@Override protected List<Parameter> getParameterList(int index)

public Float getPowerLevel(int type)

public float getPreambleDuration()

public float getPropagationSpeed()

public Integer getRTU()

public Integer getRTU(int type)

public float getRefPowerLevel()

public boolean getRxEnable()

public float getRxSensitivity()

public Float getSignalPowerLevel()

public long getTime()

public float getTimestampedTxDelay()

@Override protected void processMessage(Message msg)

@Override protected Message processRequest(Message msg)

public float setBasebandRxDuration(float value)

public float setClockOffset(float t)

public Float setDataRate(int type, int value)

public Integer setFrameLength(int type, int value)