RxDataNtf (UnetStack 3.4.0 API)

org.arl.yoda.RxDataNtf

Notification message for received raw data frame from C PHY.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`bits`
`protected float`	`cfo`
`protected byte[]`	`data`
`protected int`	`errors`
`protected float[]`	`llr`
`protected float`	`rssi`
`protected int`	`scheme`
`protected boolean`	`test`
`protected long`	`time`

Properties Summary

Properties
Type	Name and description
`int`	`bits`
`float`	`cfo`
`byte[]`	`data`
`int`	`errors`
`float[]`	`llr`
`float`	`rssi`
`long`	`rxTime`
`int`	`scheme`
`boolean`	`testFrame`

Constructor Summary

Constructors
Constructor and description
`RxDataNtf ()`
`RxDataNtf (AgentID recipient)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getBits()` Gets the number of bits in the data frame.
	`float`	`getCfo()` Gets the carrier frequency offset.
	`byte[]`	`getData()` Gets the data as byte array.
	`int`	`getErrors()` Gets the number of erroneous bits corrected in the data frame.
	`float[]`	`getLlr()` Gets the log likelihood ratios (LLR).
	`float`	`getRssi()` Gets the received signal strength.
	`long`	`getRxTime()` Gets the time of reception.
	`int`	`getScheme()` Gets the scheme.
	`boolean`	`isTestFrame()` Checks if the frame is a test frame.
	`void`	`setBits(int bits)` Sets the number of bits in the data frame.
	`void`	`setCfo(float cfo)` Sets the carrier frequency offset.
	`void`	`setData(byte[] data)` Sets the data as byte array.
	`void`	`setErrors(int bits)` Sets the number of erroneous bits corrected in the data frame.
	`void`	`setLlr(float[] llr)` Sets the log likelihood ratios (LLR).
	`void`	`setRssi(float rssi)` Sets the received signal strength.
	`void`	`setRxTime(long time)` Sets the time of reception.
	`void`	`setScheme(int scheme)` Sets the scheme.
	`void`	`setTestFrame(boolean b)` Sets the test frame flag for the frame.
	`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Message`	`setPerformative, toString, getSender, setMessageID, getSentAt, setRecipient, getInReplyTo, setSentAt, setSender, getPerformative, getRecipient, getMessageID, setInReplyTo, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected int bits
  - protected float cfo
  - protected byte[] data
  - protected int errors
  - protected float[] llr
  - protected float rssi
  - protected int scheme
  - protected boolean test
  - protected long time
- Property Detail
  - int bits
  - float cfo
  - byte[] data
  - int errors
  - float[] llr
  - float rssi
  - long rxTime
  - int scheme
  - boolean testFrame
- Constructor Detail
  - public RxDataNtf()
  - public RxDataNtf(AgentID recipient)
- Method Detail
  - public int getBits()
    
    Gets the number of bits in the data frame.
    Returns:
    number of bits
  - public float getCfo()
    
    Gets the carrier frequency offset.
    Returns:
    carrier frequency offset, NaN if unknown
  - public byte[] getData()
    
    Gets the data as byte array.
    Returns:
    data in bytes
  - public int getErrors()
    
    Gets the number of erroneous bits corrected in the data frame.
    Returns:
    number of erroneous bits
  - public float[] getLlr()
    
    Gets the log likelihood ratios (LLR).
    Returns:
    LLR, or null if unavailable
  - public float getRssi()
    
    Gets the received signal strength.
    Returns:
    RSSI in dB, NaN if unknown
  - public long getRxTime()
    
    Gets the time of reception.
    Returns:
    time of reception in microseconds
  - public int getScheme()
    
    Gets the scheme.
    Returns:
    scheme
  - public boolean isTestFrame()
    
    Checks if the frame is a test frame.
    Returns:
    true if test frame, false otherwise
  - public void setBits(int bits)
    
    Sets the number of bits in the data frame.
    Parameters:
    bits - number of bits
  - public void setCfo(float cfo)
    
    Sets the carrier frequency offset.
    Parameters:
    cfo - carrier frequency offset
  - public void setData(byte[] data)
    
    Sets the data as byte array.
    Parameters:
    data - in byte array
  - public void setErrors(int bits)
    
    Sets the number of erroneous bits corrected in the data frame.
    Parameters:
    bits - number of erroneous bits
  - public void setLlr(float[] llr)
    
    Sets the log likelihood ratios (LLR).
    Parameters:
    llr - LLR, or null if unavailable
  - public void setRssi(float rssi)
    
    Sets the received signal strength.
    Parameters:
    rssi - RSSI in dB
  - public void setRxTime(long time)
    
    Sets the time of reception.
    Parameters:
    time - time of reception in microseconds
  - public void setScheme(int scheme)
    
    Sets the scheme.
    Parameters:
    scheme - scheme number
  - public void setTestFrame(boolean b)
    
    Sets the test frame flag for the frame.
    Parameters:
    b - true if test frame, false otherwise
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

[Java] Class RxDataNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int bits

protected float cfo

protected byte[] data

protected int errors

protected float[] llr

protected float rssi

protected int scheme

protected boolean test

protected long time

Property Detail

int bits

float cfo

byte[] data

int errors

float[] llr

float rssi

long rxTime

int scheme

boolean testFrame

Constructor Detail

public RxDataNtf()

public RxDataNtf(AgentID recipient)

Method Detail

public int getBits()

public float getCfo()

public byte[] getData()

public int getErrors()

public float[] getLlr()

public float getRssi()

public long getRxTime()

public int getScheme()

public boolean isTestFrame()

public void setBits(int bits)

public void setCfo(float cfo)

public void setData(byte[] data)

public void setErrors(int bits)

public void setLlr(float[] llr)

public void setRssi(float rssi)

public void setRxTime(long time)

public void setScheme(int scheme)

public void setTestFrame(boolean b)

@Override public String toString()