RxFrameNtf (unet-framework 7.0.0 API)

org.arl.unet.phy.RxFrameNtf

Notification message for received frame.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`bits`
`protected byte[]`	`bytes`
`protected float`	`cfo`
`protected java.lang.Integer`	`errors`
`protected double[]`	`location`
`protected float[]`	`metrics`
`protected float`	`rssi`
`protected java.lang.Long`	`rxStartTime`
`protected java.lang.String`	`schemeCode`
`protected java.lang.Long`	`txStartTime`
`protected int`	`type`

Inherited fields
Fields inherited from class	Fields
`class DatagramNtf`	`data, from, priority, protocol, to, ttl`

Properties Summary

Properties
Type	Name and description
`int`	`bits`
`byte[]`	`bytes`
`float`	`cfo`
`java.lang.Integer`	`errors`
`double[]`	`location`
`float[]`	`metrics`
`float`	`rssi`
`java.lang.Long`	`rxStartTime`
`java.lang.String`	`schemeCode`
`java.lang.Long`	`txStartTime`
`int`	`type`

Constructor Summary

Constructors
Constructor and description
`RxFrameNtf ()`
`RxFrameNtf (org.arl.fjage.AgentID recipient)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getBits()` Gets the number of bits in the data frame.
	`byte[]`	`getBytes()` Gets the raw bytes of the received frame.
	`float`	`getCfo()` Gets the carrier frequency offset.
	`java.lang.Integer`	`getErrors()` Gets the number of erroneous bits corrected in the data frame.
	`double[]`	`getLocation()` Gets the location where this frame was received.
	`float[]`	`getMetrics()` Gets the bit metrics.
	`float`	`getRssi()` Gets the received signal strength.
	`java.lang.Long`	`getRxStartTime()` Returns timestamp in us at which frame was received (indicates the start of reception).
	`java.lang.String`	`getSchemeCode()` Gets the scheme code used for this frame.
	`java.lang.Long`	`getTxStartTime()` Returns the frame transmission timestamp (indicates the start of transmission).
	`int`	`getType()` Gets the channel type Physical.DATA or Physical.CONTROL.
	`void`	`setBits(int bits)` Sets the number of bits in the data frame.
	`void`	`setBytes(byte[] bytes)` Sets the raw bytes of the received frame.
	`void`	`setCfo(float cfo)` Sets the carrier frequency offset.
	`void`	`setErrors(java.lang.Integer bits)` Sets the number of erroneous bits corrected in the data frame.
	`void`	`setLocation(double[] location)` Sets the location where this frame was received.
	`void`	`setMetrics(float[] metrics)` Sets the bit metrics.
	`void`	`setRssi(float rssi)` Sets the received signal strength.
	`void`	`setRxStartTime(java.lang.Long time)` Sets the reception timestamp in us (start of reception).
	`void`	`setSchemeCode(java.lang.String schemeCode)` Sets the scheme code used for this frame.
	`void`	`setTxStartTime(java.lang.Long time)` Sets the transmission timestamp (start of transmission).
	`void`	`setType(int type)` Sets the channel type.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DatagramNtf`	`getData, getFrom, getPriority, getProtocol, getTo, getTtl, setData, setFrom, setPriority, setProtocol, setTo, setTtl, toString`

- Field Detail
  - protected int bits
  - protected byte[] bytes
  - protected float cfo
  - protected java.lang.Integer errors
  - protected double[] location
  - protected float[] metrics
  - protected float rssi
  - protected java.lang.Long rxStartTime
  - protected java.lang.String schemeCode
  - protected java.lang.Long txStartTime
  - protected int type
- Property Detail
  - int bits
  - byte[] bytes
  - float cfo
  - java.lang.Integer errors
  - double[] location
  - float[] metrics
  - float rssi
  - java.lang.Long rxStartTime
  - java.lang.String schemeCode
  - java.lang.Long txStartTime
  - int type
- Constructor Detail
  - public RxFrameNtf()
  - public RxFrameNtf(org.arl.fjage.AgentID recipient)
- Method Detail
  - public int getBits()
    
    Gets the number of bits in the data frame.
    Returns:
    number of bits, 0 if unknown
  - public byte[] getBytes()
    
    Gets the raw bytes of the received frame.
    Returns:
    raw bytes, or null if unavailable
  - public float getCfo()
    
    Gets the carrier frequency offset.
    Returns:
    carrier frequency offset, NaN if unknown
  - public java.lang.Integer getErrors()
    
    Gets the number of erroneous bits corrected in the data frame.
    Returns:
    number of erroneous bits, null if unknown
  - public double[] getLocation()
    
    Gets the location where this frame was received.
    Returns:
    location (x, y) or (x, y, z), or null if unavailable
  - public float[] getMetrics()
    
    Gets the bit metrics. A bit metric is a float value representing the demodulated bit. Nominal metric values are centered around -1 for bit 0 and +1 for bit 1. Metrics are typically only populated for test frames for diagnostic purposes.
    Returns:
    metrics, or null if unavailable
  - public float getRssi()
    
    Gets the received signal strength.
    Returns:
    RSSI in dB, NaN if unknown
  - public java.lang.Long getRxStartTime()
    
    Returns timestamp in us at which frame was received (indicates the start of reception).
    Returns:
    rx timestamp in us, null if unspecified.
  - public java.lang.String getSchemeCode()
    
    Gets the scheme code used for this frame.
    Returns:
    scheme code, or null if unavailable
  - public java.lang.Long getTxStartTime()
    
    Returns the frame transmission timestamp (indicates the start of transmission).
    Returns:
    tx timestamp in us, null if unspecified.
  - public int getType()
    
    Gets the channel type Physical.DATA or Physical.CONTROL.
    Returns:
    type of channel.
  - public void setBits(int bits)
    
    Sets the number of bits in the data frame.
    Parameters:
    bits - number of bits
  - public void setBytes(byte[] bytes)
    
    Sets the raw bytes of the received frame.
    Parameters:
    bytes - raw bytes, or null if unavailable
  - public void setCfo(float cfo)
    
    Sets the carrier frequency offset.
    Parameters:
    cfo - carrier frequency offset
  - public void setErrors(java.lang.Integer bits)
    
    Sets the number of erroneous bits corrected in the data frame.
    Parameters:
    bits - number of erroneous bits
  - public void setLocation(double[] location)
    
    Sets the location where this frame was received.
    Parameters:
    location - coordinates (x, y) or (x, y, z), or null if unavailable
  - public void setMetrics(float[] metrics)
    
    Sets the bit metrics. A bit metric is a float value representing the demodulated bit. Nominal metric values are centered around -1 for bit 0 and +1 for bit 1.
    Parameters:
    metrics, - or null if unavailable
  - public void setRssi(float rssi)
    
    Sets the received signal strength.
    Parameters:
    rssi - RSSI in dB
  - public void setRxStartTime(java.lang.Long time)
    
    Sets the reception timestamp in us (start of reception).
    Parameters:
    time - reception timestamp (us), null if unspecified.
  - public void setSchemeCode(java.lang.String schemeCode)
    
    Sets the scheme code used for this frame.
    Parameters:
    schemeCode - scheme code, or null if unavailable
  - public void setTxStartTime(java.lang.Long time)
    
    Sets the transmission timestamp (start of transmission).
    Parameters:
    time - timestamp in us, null if unspecified.
  - public void setType(int type)
    
    Sets the channel type.
    Parameters:
    type - channel type
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class RxFrameNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int bits

protected byte[] bytes

protected float cfo

protected java.lang.Integer errors

protected double[] location

protected float[] metrics

protected float rssi

protected java.lang.Long rxStartTime

protected java.lang.String schemeCode

protected java.lang.Long txStartTime

protected int type

Property Detail

int bits

byte[] bytes

float cfo

java.lang.Integer errors

double[] location

float[] metrics

float rssi

java.lang.Long rxStartTime

java.lang.String schemeCode

java.lang.Long txStartTime

int type

Constructor Detail

public RxFrameNtf()

public RxFrameNtf(org.arl.fjage.AgentID recipient)

Method Detail

public int getBits()

public byte[] getBytes()

public float getCfo()

public java.lang.Integer getErrors()

public double[] getLocation()

public float[] getMetrics()

public float getRssi()

public java.lang.Long getRxStartTime()

public java.lang.String getSchemeCode()

public java.lang.Long getTxStartTime()

public int getType()

public void setBits(int bits)

public void setBytes(byte[] bytes)

public void setCfo(float cfo)

public void setErrors(java.lang.Integer bits)

public void setLocation(double[] location)

public void setMetrics(float[] metrics)

public void setRssi(float rssi)

public void setRxStartTime(java.lang.Long time)

public void setSchemeCode(java.lang.String schemeCode)

public void setTxStartTime(java.lang.Long time)

public void setType(int type)

@java.lang.Override public java.lang.String toString()