Route

```
public interface Route
```
Defines how data flows from a data producer to an endpoint

Author:

Eric Tsai

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`generateIdentifier(int pos)` Generates a string identifying the data producer chain the subscriber is receiving data from.
`int`	`id()` Unique value identifying the route.
`boolean`	`isActive()` Checks if the route is
`void`	`remove()` Removes the route and marks the object as inactive
`boolean`	`resubscribe(int pos)` Reactivates the stream the subscriber is listening to.
`boolean`	`resubscribe(int pos, Subscriber subscriber)` Reactivates the stream the subscriber is listening to and updates the data subscriber.
`boolean`	`setEnvironment(int pos, Object... env)` Sets the environment values passed into the `apply` function
`boolean`	`unsubscribe(int pos)` Quiets the stream the subscriber is listening to, does nothing if the subscriber is handling log data

- Method Detail
  - generateIdentifier
```
String generateIdentifier(int pos)
```
    Generates a string identifying the data producer chain the subscriber is receiving data from. This value can be matched with the output from AnonymousRoute.identifier() if syncing data using the AnonymousRoute interface.
    
    Parameters:
    
    pos - Numerical position of the subscriber to interact with, starting from 0
    
    Returns:
    
    String identifying the data chain, null if param value is out of bounds
  - setEnvironment
```
boolean setEnvironment(int pos,
                       Object... env)
```
    Sets the environment values passed into the apply function
    
    Parameters:
    
    pos - Numerical position of the subscriber to interact with, starting from 0
    
    env - Environment values to use with the subscriber
    
    Returns:
    
    True if operation succeeded, false otherwise
  - unsubscribe
```
boolean unsubscribe(int pos)
```
    Quiets the stream the subscriber is listening to, does nothing if the subscriber is handling log data
    
    Parameters:
    
    pos - Numerical position of the subscriber to interact with, starting at 0
    
    Returns:
    
    True if operation succeeded, false otherwise
  - resubscribe
```
boolean resubscribe(int pos)
```
    Reactivates the stream the subscriber is listening to. If the subscriber originally listened to log data, the function only updates the subscriber.
    
    Parameters:
    
    pos - Numerical position of the subscriber to interact with, starting at 0
    
    Returns:
    
    True if operation succeeded, false otherwise
  - resubscribe
```
boolean resubscribe(int pos,
                    Subscriber subscriber)
```
    Reactivates the stream the subscriber is listening to and updates the data subscriber. If the subscriber originally listened to log data, the function only updates the subscriber.
    
    Parameters:
    
    pos - Numerical position of the subscriber to interact with, starting at 0
    
    subscriber - New subscriber to handle the received data
    
    Returns:
    
    True if operation succeeded, false otherwise
  - remove
```
void remove()
```
    Removes the route and marks the object as inactive
  - isActive
```
boolean isActive()
```
    Checks if the route is
    
    Returns:
    
    True if route is active
  - id
```
int id()
```
    Unique value identifying the route. This value can be used with MetaWearBoard.lookupRoute(int) lookupRoute} to retrieve the current object
    
    Returns:
    
    Numerical ID identifying the route

Interface Route

Method Summary

Method Detail

generateIdentifier

setEnvironment

unsubscribe

resubscribe

resubscribe

remove

isActive

id