RangeNtf (UnetStack 3.0.2 API)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

org.arl.unet.phy.RangeNtf

Notification message for providing ranging information.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`from`
`protected Long`	`offset`
`protected float`	`range`
`protected int`	`to`
`protected boolean`	`valid`

Constructor Summary

Constructors
Constructor and description
`RangeNtf ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getFrom()` Gets the from address.
	`Long`	`getOffset()` Gets clock offset in us.
	`float`	`getRange()` Gets range in meters.
	`int`	`getTo()` Gets the to address.
	`boolean`	`isValid()` Checks if range information is valid.
	`void`	`setFrom(int from)` Sets from address.
	`void`	`setOffset(Long dt)` Sets clock offset in us.
	`void`	`setRange(float range)` Sets range in meters.
	`void`	`setTo(int to)` Sets to address.
	`void`	`setValid(boolean valid)` Sets the validity.
	`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 int from
  - protected Long offset
  - protected float range
  - protected int to
  - protected boolean valid
- Constructor Detail
  - public RangeNtf()
- Method Detail
  - public int getFrom()
    
    Gets the from address.
    Returns:
    from address
  - public Long getOffset()
    
    Gets clock offset in us.
    Returns:
    clock offset in us, null if unknown
  - public float getRange()
    
    Gets range in meters.
    Returns:
    range in meters, NaN if unknown
  - public int getTo()
    
    Gets the to address.
    Returns:
    to address
  - public boolean isValid()
    
    Checks if range information is valid.
    Returns:
    true if valid range.
  - public void setFrom(int from)
    
    Sets from address.
    Parameters:
    from - address
  - public void setOffset(Long dt)
    
    Sets clock offset in us.
    Parameters:
    dt - offset in us, null if unknown
  - public void setRange(float range)
    
    Sets range in meters.
    Parameters:
    range - in meters, NaN if unknown
  - public void setTo(int to)
    
    Sets to address.
    Parameters:
    to - address
  - public void setValid(boolean valid)
    
    Sets the validity.
    Parameters:
    valid - validity
  - @Override public String toString()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Copyright 2013-19, Acoustic Research Laboratory, National University of Singapore, and Subnero Pte Ltd