NodeInfo (UnetStack 3.4.0 API)

org.arl.unet.nodeinfo.NodeInfo

Node-info agent to manage and maintain node's attribute such as address, location, speed etc.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`description`
`static String`	`title`

Inherited fields
Fields inherited from class	Fields
`class UnetAgent`	`timeout`

Properties Summary

Properties
Type	Name and description
`int`	`address`
`int`	`addressSize`
`double`	`diveRate`
`double`	`heading`
`double[]`	`location`
`double[]`	`location`
`String`	`nodeName`
`double[]`	`origin`
`double[]`	`origin`
`double[]`	`origin`
`double`	`pitch`
`double`	`roll`
`double`	`speed`
`double`	`turnRate`

Constructor Summary

Constructors
Constructor and description
`NodeInfo ()`
`NodeInfo (int address)`
`NodeInfo (int address, String nodeName)`
`NodeInfo (String nodeName)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Integer`	`getAddress()` Gets the node address.
	`int`	`getAddressSize()` Gets the node address size in bits.
	`boolean`	`getCanForward()` return true if node has forwarding capability.
	`double`	`getDiveRate()` Gets the dive rate.
	`double`	`getHeading()` Gets the heading.
	`double[]`	`getLocation()` Gets the node location.
	`boolean`	`getMobility()` Checks if it is a mobile node.
	`String`	`getNodeName()` Get the Node name.
	`double[]`	`getOrigin()` Get the origin of the coordinate system.
	`protected List<Parameter>`	`getParameterList()`
	`double`	`getPitch()` Gets the pitch angle of the node.
	`double`	`getRoll()` Gets the roll angle of the node.
	`double`	`getSpeed()` Gets the speed.
	`Date`	`getTime()` Gets the node time.
	`double`	`getTurnRate()` Gets the turn rate.
	`int`	`setAddress(int address)` Sets the node address.
	`int`	`setAddressSize(int size)` Sets the node address size in bits.
	`void`	`setCanForward(boolean canForward)` Set forwarding capability of the node.
	`double`	`setDiveRate(double diveRate)` Sets the dive rate.
	`double`	`setHeading(double heading)` Sets the heading.
	`double[]`	`setLocation(double[] location)` Sets the location.
	`double[]`	`setLocation(ArrayList<?> location)` Sets the location.
	`boolean`	`setMobility(boolean b)` Sets the mobility.
	`String`	`setNodeName(String nodeName)` Sets the node name.
	`double[]`	`setOrigin(double[] origin)` Set the origin of the coordinate system.
	`double[]`	`setOrigin(double latitude, double longitude)` Set the origin of the coordinate system.
	`double[]`	`setOrigin(ArrayList<?> origin)` Set the origin of the coordinate system.
	`double`	`setPitch(double pitch)` Sets the pitch angle of the node.
	`double`	`setRoll(double roll)` Sets the roll angle of the node.
	`double`	`setSpeed(double speed)` Sets the speed.
	`double`	`setTurnRate(double turnRate)` Sets the turn rate.
	`protected void`	`setup()`
	`protected void`	`startup()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class UnetAgent`	`addCapability, allOf, deregister, deregister, die, get, get, getBuildInfo, getLogLevel, getParam, getParameterClasses, getParameterClasses, getParameterList, getParameterList, getServices, getTitle, getVersion, init, isReadOnly, longValue, processMessage, processQuery, processRequest, register, register, set, set, setLogLevel, setParam, setup, shutdown, startup, subscribeForService, subscribeForService, trace, trace, trace, unsubscribeForService, unsubscribeForService`

- Field Detail
  - public static final String description
  - public static final String title
- Property Detail
  - int address
  - int addressSize
  - double diveRate
  - double heading
  - double[] location
  - double[] location
  - String nodeName
  - double[] origin
  - double[] origin
  - double[] origin
  - double pitch
  - double roll
  - double speed
  - double turnRate
- Constructor Detail
  - public NodeInfo()
  - public NodeInfo(int address)
  - public NodeInfo(int address, String nodeName)
  - public NodeInfo(String nodeName)
- Method Detail
  - public Integer getAddress()
    
    Gets the node address.
    Returns:
    address, or null if unavailable
  - public int getAddressSize()
    
    Gets the node address size in bits.
    Returns:
    address size in bits
  - public boolean getCanForward()
    
    return true if node has forwarding capability.
    Returns:
    true if node has forwarding capability.
  - public double getDiveRate()
    
    Gets the dive rate.
    Returns:
    dive rate in meters/second
  - public double getHeading()
    
    Gets the heading.
    Returns the heading based on last update and turnRate if mobility is set to true. Changes in heading/turnRate are assumed to be from the time of last location update.
    Returns:
    heading in degrees (0 is north, clockwise)
  - public double[] getLocation()
    
    Gets the node location. The location is in meters from origin and ENU coordinate system, if origin is set. Otherwise it is in decimal [latitude, longitude]. Depth is always in meters. Returns the location based on last update, and speed/heading/turnRate/diveRate if mobility is set to true. Changes in speed/heading/turnRate/diveRate are assumed to be from the time of last location update.
    Returns:
    location as [x, y] or [x, y, z] or []
  - public boolean getMobility()
    
    Checks if it is a mobile node.
    Returns:
    true if mobile node
  - public String getNodeName()
    
    Get the Node name.
    Returns:
    node-name
  - public double[] getOrigin()
    
    Get the origin of the coordinate system.
    Returns:
    origin as [latitude, longitude] or null
  - @Override protected List<Parameter> getParameterList()
  - public double getPitch()
    
    Gets the pitch angle of the node.
    Returns:
    pitch angle in degrees
  - public double getRoll()
    
    Gets the roll angle of the node.
    Returns:
    roll angle in degrees
  - public double getSpeed()
    
    Gets the speed.
    Returns:
    speed in meters/second
  - public Date getTime()
    
    Gets the node time.
    Returns:
    node time.
  - public double getTurnRate()
    
    Gets the turn rate.
    Returns:
    turn rate in degrees/second (clockwise)
  - public int setAddress(int address)
    
    Sets the node address.
    Parameters:
    address - node address
    Returns:
    address
  - public int setAddressSize(int size)
    
    Sets the node address size in bits.
    Parameters:
    size - address size in bits (8 or 16)
    Returns:
    address size in bits
  - public void setCanForward(boolean canForward)
    
    Set forwarding capability of the node.
    Parameters:
    canForward - forwarding capability
  - public double setDiveRate(double diveRate)
    
    Sets the dive rate.
    Parameters:
    diveRate - dive rate in meters/second
    Returns:
    dive rate
  - public double setHeading(double heading)
    
    Sets the heading.
    Parameters:
    heading - in degrees (0 is north, clockwise)
    Returns:
    heading
  - public double[] setLocation(double[] location)
    
    Sets the location. The location is in meters from origin and ENU coordinate system, if origin is set. Otherwise it is in decimal [latitude, longitude]. Depth is always in meters.
    Parameters:
    location - as [x, y] or [x, y, z] or []
    Returns:
    location
  - public double[] setLocation(ArrayList<?> location)
    
    Sets the location. The location is in meters from origin and ENU coordinate system, if origin is set. Otherwise it is in decimal [latitude, longitude]. Depth is always in meters.
    Parameters:
    location - as [x, y] or [x, y, z] or null
    Returns:
    location
  - public boolean setMobility(boolean b)
    
    Sets the mobility.
    Parameters:
    b - true if mobile node
    Returns:
    mobility
  - public String setNodeName(String nodeName)
    
    Sets the node name.
    Parameters:
    nodeName - node name
    Returns:
    nodeName
  - public double[] setOrigin(double[] origin)
    
    Set the origin of the coordinate system.
    Parameters:
    origin - [latitude, longitude] or null
    Returns:
    origin
  - public double[] setOrigin(double latitude, double longitude)
    
    Set the origin of the coordinate system.
    Parameters:
    latitude - latitude in decimal degrees
    longitude - longitude in decimal degrees
    Returns:
    origin as [latitude, longitude]
  - public double[] setOrigin(ArrayList<?> origin)
    
    Set the origin of the coordinate system.
    Parameters:
    origin - [latitude, longitude] or null
    Returns:
    origin
  - public double setPitch(double pitch)
    
    Sets the pitch angle of the node.
    Parameters:
    pitch - pitch angle in degrees
    Returns:
    pitch angle
  - public double setRoll(double roll)
    
    Sets the roll angle of the node.
    Parameters:
    roll - roll angle in degrees
    Returns:
    roll angle
  - public double setSpeed(double speed)
    
    Sets the speed.
    Parameters:
    speed - in meters/second
    Returns:
    speed
  - public double setTurnRate(double turnRate)
    
    Sets the turn rate.
    Parameters:
    turnRate - turn rate in degrees/second (clockwise)
    Returns:
    turn rate
  - @Override protected void setup()
  - @Override protected void startup()

Summary:
Field
Property
Constructor
Method

[Java] Class NodeInfo

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String description

public static final String title

Property Detail

int address

int addressSize

double diveRate

double heading

double[] location

double[] location

String nodeName

double[] origin

double[] origin

double[] origin

double pitch

double roll

double speed

double turnRate

Constructor Detail

public NodeInfo()

public NodeInfo(int address)

public NodeInfo(int address, String nodeName)

public NodeInfo(String nodeName)

Method Detail

public Integer getAddress()

public int getAddressSize()

public boolean getCanForward()

public double getDiveRate()

public double getHeading()

public double[] getLocation()

public boolean getMobility()

public String getNodeName()

public double[] getOrigin()

@Override protected List<Parameter> getParameterList()

public double getPitch()

public double getRoll()

public double getSpeed()

public Date getTime()

public double getTurnRate()

public int setAddress(int address)

public int setAddressSize(int size)

public void setCanForward(boolean canForward)

public double setDiveRate(double diveRate)

public double setHeading(double heading)

public double[] setLocation(double[] location)

public double[] setLocation(ArrayList<?> location)

public boolean setMobility(boolean b)

public String setNodeName(String nodeName)

public double[] setOrigin(double[] origin)

public double[] setOrigin(double latitude, double longitude)

public double[] setOrigin(ArrayList<?> origin)

public double setPitch(double pitch)

public double setRoll(double roll)

public double setSpeed(double speed)

public double setTurnRate(double turnRate)

@Override protected void setup()

@Override protected void startup()