Ranging (UnetStack 3.0.2 API)

org.arl.unet.phy.Ranging

Agent providing ranging functionality.
Services:
- Services.RANGING
Parameters:
- RangeParam

Field Summary

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

Inherited fields
Fields inherited from class	Fields
`class UnetAgent`	`NON_BLOCKING, BLOCKING`
`class Agent`	`NON_BLOCKING, BLOCKING`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getChannel()` Gets the channel being used for ranging.
	`int`	`getLifetime()` Gets the lifetime of ranging information.
	`int`	`getMaxBadRangeCnt()` Gets maximum bad range count.
	`float`	`getMaxRange()` Gets the maximum possible range.
	`float`	`getMinRange()` Gets the minimum possible range value.
	`protected List<Parameter>`	`getParameterList()`
	`protected void`	`processMessage(Message msg)`
	`protected Message`	`processRequest(Message msg)`
	`void`	`setChannel(int ch)` Sets the channel to use for ranging.
	`int`	`setLifetime(int lifetime)` Sets the lifetime of ranging information.
	`void`	`setMaxBadRangeCnt(int count)` Sets maximum bad range count.
	`float`	`setMaxRange(float maxRange)` Sets the maximum possible range.
	`float`	`setMinRange(float minRange)` Sets the minimum possible range value.
	`protected void`	`setup()`
	`protected void`	`startup()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class UnetAgent`	register, register, getLogLevel, setLogLevel, getServices, getTitle, deregister, deregister, getParameterClasses, getParameterClasses, println, run, add, toString, clone, currentTimeMillis, nanoTime, getName, stop, getState, topic, topic, topic, topic, topic, topic, send, receive, receive, receive, receive, receive, receive, receive, receive, getPlatform, request, request, subscribe, getStore, getContainer, wake, agent, agentForService, agentForService, agentsForService, agentsForService, getAgentID, unsubscribe, platformSend, setQueueSize, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll
`class Agent`	println, run, add, toString, register, register, clone, currentTimeMillis, nanoTime, getName, stop, getState, setLogLevel, topic, topic, topic, topic, topic, topic, send, receive, receive, receive, receive, receive, receive, receive, receive, getPlatform, request, request, subscribe, getStore, getContainer, deregister, deregister, wake, agent, agentForService, agentForService, agentsForService, agentsForService, getAgentID, unsubscribe, platformSend, setQueueSize, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Field Detail
  - public static final String description
  - public static final String title
- Method Detail
  - public int getChannel()
    
    Gets the channel being used for ranging.
    Returns:
    channel (DATA/CONTROL)
  - public int getLifetime()
    
    Gets the lifetime of ranging information.
    Returns:
    lifetime in seconds
  - public int getMaxBadRangeCnt()
    
    Gets maximum bad range count. If more bad ranges than this are received, the node synchronization information is removed from cache.
    Returns:
    Maximum bad range count
  - public float getMaxRange()
    
    Gets the maximum possible range.
    Returns:
    maximum possible range in meters
  - public float getMinRange()
    
    Gets the minimum possible range value.
    Returns:
    minimum possible range
  - @Override protected List<Parameter> getParameterList()
  - @Override protected void processMessage(Message msg)
  - @Override protected Message processRequest(Message msg)
  - public void setChannel(int ch)
    
    Sets the channel to use for ranging.
    Parameters:
    ch - DATA/CONTROL channel to use
  - public int setLifetime(int lifetime)
    
    Sets the lifetime of ranging information.
    Parameters:
    lifetime - lifetime in seconds
    Returns:
    lifetime
  - public void setMaxBadRangeCnt(int count)
    
    Sets maximum bad range count. If more bad ranges than this are received, the node synchronization information is removed from cache.
    Parameters:
    count - maximum bad range count
  - public float setMaxRange(float maxRange)
    
    Sets the maximum possible range.
    Parameters:
    maxRange - maximum range in meters
    Returns:
    max Range maximum range
  - public float setMinRange(float minRange)
    
    Sets the minimum possible range value.
    Parameters:
    minRange - minimum possible range
    Returns:
    min Range
  - @Override protected void setup()
  - @Override protected void startup()

Summary:
Field
Method

| Detail:
Field
Method

[Java] Class Ranging

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String description

public static final String title

Method Detail

public int getChannel()

public int getLifetime()

public int getMaxBadRangeCnt()

public float getMaxRange()

public float getMinRange()

@Override protected List<Parameter> getParameterList()

@Override protected void processMessage(Message msg)

@Override protected Message processRequest(Message msg)

public void setChannel(int ch)

public int setLifetime(int lifetime)

public void setMaxBadRangeCnt(int count)

public float setMaxRange(float maxRange)

public float setMinRange(float minRange)

@Override protected void setup()

@Override protected void startup()