BadFrameNtf (unet-framework 7.0.0 API)

org.arl.unet.phy.BadFrameNtf

Notification message for reception of corrupted or bad physical frame.

Field Summary

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

Properties Summary

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

Constructor Summary

Constructors
Constructor and description
`BadFrameNtf ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`byte[]`	`getBytes()` Gets the estimated raw bytes.
	`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()` Gets the reception timestamp of frame in us.
	`java.lang.String`	`getSchemeCode()` Gets the scheme code used for this frame.
	`int`	`getType()` Gets the type of channel.
	`void`	`setBytes(byte[] bytes)` Sets the estimated raw bytes.
	`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 of frame.
	`void`	`setRxStartTime(long time)` Sets the reception timestamp of frame.
	`void`	`setSchemeCode(java.lang.String schemeCode)` Sets the scheme code used for this frame.
	`void`	`setType(int type)` Sets the channel type.
	`java.lang.String`	`toString()` Gets a string representation of the bad frame.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.arl.fjage.Message`	org.arl.fjage.Message#toString(), org.arl.fjage.Message#setPerformative(org.arl.fjage.Performative), org.arl.fjage.Message#getPerformative(), org.arl.fjage.Message#setRecipient(org.arl.fjage.AgentID), org.arl.fjage.Message#getRecipient(), org.arl.fjage.Message#setSender(org.arl.fjage.AgentID), org.arl.fjage.Message#getSender(), org.arl.fjage.Message#setMessageID(java.lang.String), org.arl.fjage.Message#getMessageID(), org.arl.fjage.Message#setInReplyTo(java.lang.String), org.arl.fjage.Message#getInReplyTo(), org.arl.fjage.Message#setSentAt(long), org.arl.fjage.Message#getSentAt(), org.arl.fjage.Message#getJsonCache(), org.arl.fjage.Message#setJsonCache(java.lang.String), org.arl.fjage.Message#wait(long, int), org.arl.fjage.Message#wait(long), org.arl.fjage.Message#wait(), org.arl.fjage.Message#equals(java.lang.Object), org.arl.fjage.Message#hashCode(), org.arl.fjage.Message#getClass(), org.arl.fjage.Message#notify(), org.arl.fjage.Message#notifyAll()

- Field Detail
  - protected byte[] bytes
  - protected double[] location
  - protected float[] metrics
  - protected float rssi
  - protected java.lang.Long rxStartTime
  - protected java.lang.String schemeCode
  - protected int type
- Property Detail
  - byte[] bytes
  - double[] location
  - float[] metrics
  - float rssi
  - java.lang.Long rxStartTime
  - java.lang.String schemeCode
  - int type
- Constructor Detail
  - public BadFrameNtf()
- Method Detail
  - public byte[] getBytes()
    
    Gets the estimated raw bytes.
    Returns:
    estimated raw bytes
  - 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.
    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()
    
    Gets the reception timestamp of frame in us. Timestamp indicates the start of frame reception.
    Returns:
    reception time stamp in us, null if unknown.
  - public java.lang.String getSchemeCode()
    
    Gets the scheme code used for this frame.
    Returns:
    scheme code, or null if unavailable
  - public int getType()
    
    Gets the type of channel.
    Returns:
    type of channel (Physical.DATA or Physical.CONTROL)
  - public void setBytes(byte[] bytes)
    
    Sets the estimated raw bytes.
    Parameters:
    bytes - estimated raw bytes
  - 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 of frame. Timestamp indicates the start of frame reception.
    Parameters:
    time - reception timestamp in us
  - public void setRxStartTime(long time)
    
    Sets the reception timestamp of frame. Timestamp indicates the start of frame reception.
    Parameters:
    time - reception timestamp in us
  - 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 setType(int type)
    
    Sets the channel type.
    Parameters:
    type - of channel (Physical.DATA or Physical.CONTROL)
  - @java.lang.Override public java.lang.String toString()
    
    Gets a string representation of the bad frame.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class BadFrameNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected byte[] bytes

protected double[] location

protected float[] metrics

protected float rssi

protected java.lang.Long rxStartTime

protected java.lang.String schemeCode

protected int type

Property Detail

byte[] bytes

double[] location

float[] metrics

float rssi

java.lang.Long rxStartTime

java.lang.String schemeCode

int type

Constructor Detail

public BadFrameNtf()

Method Detail

public byte[] getBytes()

public double[] getLocation()

public float[] getMetrics()

public float getRssi()

public java.lang.Long getRxStartTime()

public java.lang.String getSchemeCode()

public int getType()

public void setBytes(byte[] bytes)

public void setLocation(double[] location)

public void setMetrics(float[] metrics)

public void setRssi(float rssi)

public void setRxStartTime(java.lang.Long time)

public void setRxStartTime(long time)

public void setSchemeCode(java.lang.String schemeCode)

public void setType(int type)

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