RxFrameStartNtf (UnetStack 3.0.2 API)

org.arl.unet.phy.RxFrameStartNtf

Notification message for start of reception. To listen to these notifications subscribe to service Services#PHYSICAL#PHYSICAL.

Field Summary

Fields
Modifiers	Name	Description
`protected float`	`detector`
`protected Integer`	`rxDuration`
`protected Long`	`rxTime`
`protected int`	`type`

Constructor Summary

Constructors
Constructor and description
`RxFrameStartNtf ()`
`RxFrameStartNtf (AgentID recipient)`
`RxFrameStartNtf (Message inReplyTo)`

Methods Summary

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

Inherited Methods Summary

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

- Field Detail
  - protected float detector
  - protected Integer rxDuration
  - protected Long rxTime
  - protected int type
- Constructor Detail
  - public RxFrameStartNtf()
  - public RxFrameStartNtf(AgentID recipient)
  - public RxFrameStartNtf(Message inReplyTo)
- Method Detail
  - public float getDetector()
    
    Gets the detector output.
    Returns:
    detector metric (0-1)
  - public Integer getRxDuration()
    
    Gets reception duration.
    Returns:
    estimated duration us, null if unavailable
  - public Long getRxTime()
    
    Gets reception timestamp. Time stamp 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(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 setRxTime(Long time)
    
    Sets the reception timestamp in us.
    Parameters:
    time - timestamp in us.
  - public void setRxTime(long time)
    
    Sets the reception timestamp in us.
    Parameters:
    time - timestamp in us.
  - public void setType(int type)
    
    Sets the frame type.
    Parameters:
    type - frame type
  - @Override public String toString()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class RxFrameStartNtf

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected float detector

protected Integer rxDuration

protected Long rxTime

protected int type

Constructor Detail

public RxFrameStartNtf()

public RxFrameStartNtf(AgentID recipient)

public RxFrameStartNtf(Message inReplyTo)

Method Detail

public float getDetector()

public Integer getRxDuration()

public Long getRxTime()

public int getType()

public void setDetector(float x)

public void setRxDuration(Integer duration)

public void setRxDuration(int duration)

public void setRxTime(Long time)

public void setRxTime(long time)

public void setType(int type)

@Override public String toString()