RxFrameNtf (UnetStack 3.4.0 API)

org.arl.unet.phy.RxFrameNtf

Notification message for received frame.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`bits`
`protected float`	`cfo`
`protected int`	`errors`
`protected boolean`	`is16BitTS`
`protected double[]`	`location`
`protected float`	`rssi`
`protected Long`	`rxTime`
`protected Long`	`timestamp`
`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
`boolean`	`16BitTS`
`int`	`bits`
`float`	`cfo`
`int`	`errors`
`double[]`	`location`
`float`	`rssi`
`Long`	`rxTime`
`Long`	`txTime`
`int`	`type`

Constructor Summary

Constructors
Constructor and description
`RxFrameNtf ()`
`RxFrameNtf (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.
	`int`	`getErrors()` Gets the number of erroneous bits corrected in the data frame.
	`double[]`	`getLocation()` Gets the location where this frame was received.
	`float`	`getRssi()` Gets the received signal strength.
	`Long`	`getRxTime()` Returns timestamp in us at which frame was received (indicates the start of reception).
	`Long`	`getTxTime()` Returns the frame transmission timestamp. indicates the start of transmission.
	`int`	`getType()` Gets the channel type Physical.DATA or Physical.CONTROL.
	`boolean`	`is16BitTS()` Checks if msg contains 16 bit timestamp.
	`void`	`set16BitTS(boolean is16BitRx)` Sets 16 bit timestamp.
	`void`	`setBits(int bits)` Sets the number of bits in the data frame.
	`void`	`setCfo(float cfo)` Sets the carrier frequency offset.
	`void`	`setErrors(int 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`	`setRssi(float rssi)` Sets the received signal strength.
	`void`	`setRxTime(Long time)` Sets the reception timestamp in us.
	`void`	`setTxTime(Long time)` Sets the transmission timestamp.
	`void`	`setType(int type)` Sets the channel type.
	`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 float cfo
  - protected int errors
  - protected boolean is16BitTS
  - protected double[] location
  - protected float rssi
  - protected Long rxTime
  - protected Long timestamp
  - protected int type
- Property Detail
  - boolean 16BitTS
  - int bits
  - float cfo
  - int errors
  - double[] location
  - float rssi
  - Long rxTime
  - Long txTime
  - int type
- Constructor Detail
  - public RxFrameNtf()
  - public RxFrameNtf(AgentID recipient)
- Method Detail
  - public int getBits()
    
    Gets the number of bits in the data frame.
    Returns:
    number of bits, 0 if unknown
  - public float getCfo()
    
    Gets the carrier frequency offset.
    Returns:
    carrier frequency offset, NaN if unknown
  - public int getErrors()
    
    Gets the number of erroneous bits corrected in the data frame.
    Returns:
    number of erroneous bits, 0 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 getRssi()
    
    Gets the received signal strength.
    Returns:
    RSSI in dB, NaN if unknown
  - public Long getRxTime()
    
    Returns timestamp in us at which frame was received (indicates the start of reception).
    Returns:
    rx timestamp in us, null if unspecified.
  - public Long getTxTime()
    
    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 boolean is16BitTS()
    
    Checks if msg contains 16 bit timestamp.
    Returns:
    true if contains 16 bit timestamp.
  - public void set16BitTS(boolean is16BitRx)
    
    Sets 16 bit timestamp.
    Parameters:
    is16BitRx - true if 16 bit timestamp
  - 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 setErrors(int 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 setRssi(float rssi)
    
    Sets the received signal strength.
    Parameters:
    rssi - RSSI in dB
  - public void setRxTime(Long time)
    
    Sets the reception timestamp in us.
    Parameters:
    time - reception timestamp (us), null if unspecified.
  - public void setTxTime(Long time)
    
    Sets the transmission timestamp.
    Parameters:
    time - timestamp in us, null if unspecified.
  - public void setType(int type)
    
    Sets the channel type.
    Parameters:
    type - channel type
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

[Java] Class RxFrameNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int bits

protected float cfo

protected int errors

protected boolean is16BitTS

protected double[] location

protected float rssi

protected Long rxTime

protected Long timestamp

protected int type

Property Detail

boolean 16BitTS

int bits

float cfo

int errors

double[] location

float rssi

Long rxTime

Long txTime

int type

Constructor Detail

public RxFrameNtf()

public RxFrameNtf(AgentID recipient)

Method Detail

public int getBits()

public float getCfo()

public int getErrors()

public double[] getLocation()

public float getRssi()

public Long getRxTime()

public Long getTxTime()

public int getType()

public boolean is16BitTS()

public void set16BitTS(boolean is16BitRx)

public void setBits(int bits)

public void setCfo(float cfo)

public void setErrors(int bits)

public void setLocation(double[] location)

public void setRssi(float rssi)

public void setRxTime(Long time)

public void setTxTime(Long time)

public void setType(int type)

@Override public String toString()