SignalToFrameReq (unet-framework 7.0.0 API)

org.arl.unet.phy.SignalToFrameReq

Request to process a baseband signal. Once this request is processed, a PHYSICAL agent will send a RxFrameNtf or a BadFrameNtf message to the sender.
The preamble field is used to select the frame type to be used for processing the signal, and should be set even if the signal was not detected using a preamble in reality.

Field Summary

Fields
Modifiers	Name	Description
`protected double[]`	`location`
`protected int`	`preambleLength`
`protected float`	`rssi`
`protected java.lang.Long`	`rxStartTime`

Inherited fields
Fields inherited from class	Fields
`class BasebandSignal`	`channels, fs, preamble, signal`

Properties Summary

Properties
Type	Name and description
`double[]`	`location`
`int`	`preambleLength`
`float`	`rssi`
`java.lang.Long`	`rxStartTime`
`java.lang.Long`	`rxStartTime`

Constructor Summary

Constructors
Constructor and description
`SignalToFrameReq ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`double[]`	`getLocation()` Gets the location where this frame was received.
	`int`	`getPreambleLength()` Gets the length of the preamble in samples in the received signal.
	`float`	`getRssi()` Gets the received signal strength.
	`java.lang.Long`	`getRxStartTime()` Gets the time at which the signal was received.
	`void`	`setLocation(double[] location)` Sets the location where this frame was received.
	`void`	`setPreambleLength(int len)` Sets the length of the preamble in samples in the received signal.
	`void`	`setRssi(float rssi)` Sets the received signal strength.
	`void`	`setRxStartTime(java.lang.Long time)` Sets reception timestamp.
	`void`	`setRxStartTime(long time)` Sets reception timestamp.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class BasebandSignal`	`getChannels, getFc, getFs, getPreamble, getSignal, getSignal, getSignalAsBase64, getSignalLength, isComplex, setChannels, setFc, setFs, setPreamble, setSignal, setSignalFromBase64, toString`

- Field Detail
  - protected double[] location
  - protected int preambleLength
  - protected float rssi
  - protected java.lang.Long rxStartTime
- Property Detail
  - double[] location
  - int preambleLength
  - float rssi
  - java.lang.Long rxStartTime
  - java.lang.Long rxStartTime
- Constructor Detail
  - public SignalToFrameReq()
- Method Detail
  - public double[] getLocation()
    
    Gets the location where this frame was received.
    Returns:
    location (x, y) or (x, y, z), or null if unavailable
  - public int getPreambleLength()
    
    Gets the length of the preamble in samples in the received signal. If the signal was not detected using a preamble, this value is 0.
    Returns:
    preamble length in samples
  - public float getRssi()
    
    Gets the received signal strength.
    Returns:
    RSSI in dB, NaN if unknown
  - public java.lang.Long getRxStartTime()
    
    Gets the time at which the signal was received. Timestamp indicates the start of frame reception.
    Returns:
    reception timestamp in us, null if unspecified
  - 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 setPreambleLength(int len)
    
    Sets the length of the preamble in samples in the received signal. If the signal was not detected using a preamble, this value is 0.
    Parameters:
    len - preamble length in samples
  - public void setRssi(float rssi)
    
    Sets the received signal strength.
    Parameters:
    rssi - RSSI in dB
  - public void setRxStartTime(java.lang.Long time)
    
    Sets reception timestamp. Timestamp indicates the start of frame reception.
    Parameters:
    time - reception time in us, null if unspecified
  - public void setRxStartTime(long time)
    
    Sets reception timestamp. Timestamp indicates the start of frame reception.
    Parameters:
    time - reception time in us, null if unspecified
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class SignalToFrameReq

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected double[] location

protected int preambleLength

protected float rssi

protected java.lang.Long rxStartTime

Property Detail

double[] location

int preambleLength

float rssi

java.lang.Long rxStartTime

java.lang.Long rxStartTime

Constructor Detail

public SignalToFrameReq()

Method Detail

public double[] getLocation()

public int getPreambleLength()

public float getRssi()

public java.lang.Long getRxStartTime()

public void setLocation(double[] location)

public void setPreambleLength(int len)

public void setRssi(float rssi)

public void setRxStartTime(java.lang.Long time)

public void setRxStartTime(long time)

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