RangeReq (UnetStack 3.0.2 API)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

org.arl.unet.phy.RangeReq

Request message to fetch range and sync information from a destination.

Field Summary

Fields
Modifiers	Name	Description
`protected boolean`	`reqBeacon`
`protected int`	`to`
`protected boolean`	`txBeacon`

Constructor Summary

Constructors
Constructor and description
`RangeReq ()`
`RangeReq (int destination)` Constructs range request message with destination node address.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getTo()` Gets the destination node address.
	`boolean`	`isReqBeacon()` Checks if beacon from destination is requested.
	`boolean`	`isTxBeacon()` If it is transmit request for a beacon.
	`void`	`setReqBeacon(boolean reqBeacon)` Requests for transmission of a beacon from destination.
	`void`	`setTo(int destination)` Sets the destination address.
	`void`	`setTxBeacon(boolean txBeacon)` Sets true if transmission of beacon is requested.
	`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 boolean reqBeacon
  - protected int to
  - protected boolean txBeacon
- Constructor Detail
  - public RangeReq()
  - public RangeReq(int destination)
    
    Constructs range request message with destination node address.
    Parameters:
    destination - destination address
- Method Detail
  - public int getTo()
    
    Gets the destination node address.
    Returns:
    the destination peer address
  - public boolean isReqBeacon()
    
    Checks if beacon from destination is requested.
    Returns:
    true if includes request for a beacon from destination peer.
  - public boolean isTxBeacon()
    
    If it is transmit request for a beacon.
    Returns:
    true if tx beacon is requested else false.
  - public void setReqBeacon(boolean reqBeacon)
    
    Requests for transmission of a beacon from destination.
    Parameters:
    reqBeacon - true if want to include request for a range beacon from destination peer
  - public void setTo(int destination)
    
    Sets the destination address.
    Parameters:
    destination - address
  - public void setTxBeacon(boolean txBeacon)
    
    Sets true if transmission of beacon is requested.
    Parameters:
    txBeacon - true if transmission of beacon is requested
  - @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