RxFrameStartNtf (unet-framework 7.0.0 API)

org.arl.unet.phy.RxFrameStartNtf

Notification message for start of reception.

Field Summary

Fields
Modifiers	Name	Description
`protected float`	`detector`
`protected java.lang.Integer`	`rxDuration`
`protected java.lang.Long`	`rxStartTime`
`protected int`	`type`

Properties Summary

Properties
Type	Name and description
`float`	`detector`
`java.lang.Integer`	`rxDuration`
`java.lang.Long`	`rxStartTime`
`int`	`type`

Constructor Summary

Constructors
Constructor and description
`RxFrameStartNtf ()`
`RxFrameStartNtf (org.arl.fjage.AgentID recipient)`
`RxFrameStartNtf (org.arl.fjage.Message inReplyTo)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`float`	`getDetector()` Gets the detector output.
	`java.lang.Integer`	`getRxDuration()` Gets reception duration.
	`java.lang.Long`	`getRxStartTime()` Gets reception timestamp.
	`int`	`getType()` Gets the frame type.
	`void`	`setDetector(float x)` Sets the detector output.
	`void`	`setRxDuration(java.lang.Integer duration)` Sets the reception duration in us.
	`void`	`setRxDuration(int duration)` Sets the reception duration in us.
	`void`	`setRxStartTime(java.lang.Long time)` Sets the reception timestamp in us.
	`void`	`setRxStartTime(long time)` Sets the reception timestamp in us.
	`void`	`setType(int type)` Sets the frame type.
	`java.lang.String`	`toString()`

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 float detector
  - protected java.lang.Integer rxDuration
  - protected java.lang.Long rxStartTime
  - protected int type
- Property Detail
  - float detector
  - java.lang.Integer rxDuration
  - java.lang.Long rxStartTime
  - int type
- Constructor Detail
  - public RxFrameStartNtf()
  - public RxFrameStartNtf(org.arl.fjage.AgentID recipient)
  - public RxFrameStartNtf(org.arl.fjage.Message inReplyTo)
- Method Detail
  - public float getDetector()
    
    Gets the detector output.
    Returns:
    detector metric (0-1)
  - public java.lang.Integer getRxDuration()
    
    Gets reception duration.
    Returns:
    estimated duration us, null if unavailable
  - public java.lang.Long getRxStartTime()
    
    Gets reception timestamp. Timestamp indicates the start of frame reception.
    Returns:
    time timestamp in us, null if unavailable
  - public int getType()
    
    Gets the frame type.
    Returns:
    type (frame type control or data).
  - public void setDetector(float x)
    
    Sets the detector output.
    Parameters:
    x - detector metric (0-1)
  - public void setRxDuration(java.lang.Integer duration)
    
    Sets the reception duration in us.
    Parameters:
    duration - estimated duration in us.
  - public void setRxDuration(int duration)
    
    Sets the reception duration in us.
    Parameters:
    duration - estimated duration in us.
  - public void setRxStartTime(java.lang.Long time)
    
    Sets the reception timestamp in us. Timestamp indicates the start of frame reception.
    Parameters:
    time - timestamp in us.
  - public void setRxStartTime(long time)
    
    Sets the reception timestamp in us. Timestamp indicates the start of frame reception.
    Parameters:
    time - timestamp in us.
  - public void setType(int type)
    
    Sets the frame type.
    Parameters:
    type - frame type
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class RxFrameStartNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected float detector

protected java.lang.Integer rxDuration

protected java.lang.Long rxStartTime

protected int type

Property Detail

float detector

java.lang.Integer rxDuration

java.lang.Long rxStartTime

int type

Constructor Detail

public RxFrameStartNtf()

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

public RxFrameStartNtf(org.arl.fjage.Message inReplyTo)

Method Detail

public float getDetector()

public java.lang.Integer getRxDuration()

public java.lang.Long getRxStartTime()

public int getType()

public void setDetector(float x)

public void setRxDuration(java.lang.Integer duration)

public void setRxDuration(int duration)

public void setRxStartTime(java.lang.Long time)

public void setRxStartTime(long time)

public void setType(int type)

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