DetectionNtf (unet-framework 7.0.0 API)

org.arl.unet.bb.DetectionNtf

Notification message for detection of preamble.

Field Summary

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

Properties Summary

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

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Long`	`getCaptureStartTime()` Gets time of start of capture.
	`float`	`getDetector()` Gets the detector output.
	`int`	`getPreamble()` Gets the preamble ID.
	`java.lang.Integer`	`getRxDuration()` Gets reception duration in us.
	`java.lang.Long`	`getRxStartTime()` Gets reception timestamp.
	`void`	`setCaptureStartTime(java.lang.Long time)` Sets the time of start of capture in us.
	`void`	`setCaptureStartTime(long time)` Sets the time of start of capture in us.
	`void`	`setDetector(float x)` Sets the detector output.
	`void`	`setPreamble(int preamble)` Sets the preamble ID.
	`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.
	`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 java.lang.Long captureStartTime
  - protected float detector
  - protected int preamble
  - protected java.lang.Integer rxDuration
  - protected java.lang.Long rxStartTime
- Property Detail
  - java.lang.Long captureStartTime
  - float detector
  - int preamble
  - java.lang.Integer rxDuration
  - java.lang.Long rxStartTime
- Constructor Detail
  - public DetectionNtf()
  - public DetectionNtf(org.arl.fjage.AgentID recipient)
  - public DetectionNtf(org.arl.fjage.Message inReplyTo)
- Method Detail
  - public java.lang.Long getCaptureStartTime()
    
    Gets time of start of capture. Timestamp indicates the time of strongest arrival.
    Returns:
    time timestamp in us, null if unavailable
  - public float getDetector()
    
    Gets the detector output.
    Returns:
    detector metric (0-1)
  - public int getPreamble()
    
    Gets the preamble ID.
    Returns:
    preamble ID
  - public java.lang.Integer getRxDuration()
    
    Gets reception duration in us.
    Returns:
    estimated duration us, null if unavailable
  - public java.lang.Long getRxStartTime()
    
    Gets reception timestamp. Timestamp indicates the time of first arrival.
    Returns:
    time timestamp in us, null if unavailable
  - public void setCaptureStartTime(java.lang.Long time)
    
    Sets the time of start of capture in us. Timestamp indicates the time of strongest arrival.
    Parameters:
    time - timestamp in us.
  - public void setCaptureStartTime(long time)
    
    Sets the time of start of capture in us. Timestamp indicates the time of strongest arrival.
    Parameters:
    time - timestamp in us.
  - public void setDetector(float x)
    
    Sets the detector output.
    Parameters:
    x - detector metric (0-1)
  - public void setPreamble(int preamble)
    
    Sets the preamble ID.
    Parameters:
    preamble - preamble ID
  - 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 time of first arrival.
    Parameters:
    time - timestamp in us.
  - public void setRxStartTime(long time)
    
    Sets the reception timestamp in us. Timestamp indicates the time of first arrival.
    Parameters:
    time - timestamp in us.
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class DetectionNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.lang.Long captureStartTime

protected float detector

protected int preamble

protected java.lang.Integer rxDuration

protected java.lang.Long rxStartTime

Property Detail

java.lang.Long captureStartTime

float detector

int preamble

java.lang.Integer rxDuration

java.lang.Long rxStartTime

Constructor Detail

public DetectionNtf()

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

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

Method Detail

public java.lang.Long getCaptureStartTime()

public float getDetector()

public int getPreamble()

public java.lang.Integer getRxDuration()

public java.lang.Long getRxStartTime()

public void setCaptureStartTime(java.lang.Long time)

public void setCaptureStartTime(long time)

public void setDetector(float x)

public void setPreamble(int preamble)

public void setRxDuration(java.lang.Integer duration)

public void setRxDuration(int duration)

public void setRxStartTime(java.lang.Long time)

public void setRxStartTime(long time)

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