RouteComponent

```
public interface RouteComponent
```
Component in a route definition

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RouteComponent.AccountType` Types of information the accounter processor can append to the data
`static interface`	`RouteComponent.Action` Similar to a `CodeBlock` except this interface is specifically for data producers

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`RouteComponent`	`account()` Variant of `account(AccountType)` that defaults to recalculating timestamps
`RouteComponent`	`account(RouteComponent.AccountType type)` Add additional information to the payload to assist in checking if streamed data is lost
`RouteComponent`	`accumulate()` Accumulates a running sum of all data samples passing through this component and outputs the current tally
`RouteComponent`	`average(byte nSamples)` Deprecated. Renamed to `lowpass` in SDK v3.1
`RouteComponent`	`buffer()` Stores the input data in memory.
`RouteComponent`	`count()` Counts the number of data samples that have passed through this component and outputs the current count
`RouteComponent`	`delay(byte samples)` Stops data from leaving until at least N samples have been collected.
`RouteComponent`	`end()` Signifies the end of a split or multicast route.
`RouteComponent`	`filter(Comparison op, ComparisonOutput output, java.lang.Number... references)` Variant of `filter(Comparison, Number...)` where the filter can output values providing additional details about the comparison.
`RouteComponent`	`filter(Comparison op, ComparisonOutput output, java.lang.String... dataNames)` Variant of `filter(Comparison, ComparisonOutput, Number...)` where reference values are outputs from other sensors or processors.
`RouteComponent`	`filter(Comparison op, java.lang.Number... references)` Remove data from the route that does not satisfy the comparison
`RouteComponent`	`filter(Comparison op, java.lang.String... dataNames)` Variant of the `filter(Comparison, Number...)` function where the reference values are outputs from other sensors or processors
`RouteComponent`	`filter(DifferentialOutput output, java.lang.Number distance)` Removes data that it is not a minimum distance away from a reference value.
`RouteComponent`	`filter(ThresholdOutput output, java.lang.Number threshold)` Remove data from the route that doesn't not cross the threshold
`RouteComponent`	`filter(ThresholdOutput output, java.lang.Number threshold, java.lang.Number hysteresis)` Variant of `filter(ThresholdOutput, Number)` with a configurable hysteresis value for data that frequently oscillates around the threshold boundary
`RouteComponent`	`find(PulseOutput output, java.lang.Number threshold, short samples)` Scans the input data for a pulse.
`RouteComponent`	`fuse(java.lang.String... bufferNames)` Combines data from multiple sources into 1 packet.
`RouteComponent`	`highpass(byte nSamples)` Applies a high pass filter over the input data, available in firmware v1.3.4 and later
`RouteComponent`	`index(int i)` Gets a specific component value from the split data value
`RouteComponent`	`limit(int period)` Reduce the amount of data allowed through such that the output data rate matches the delay
`RouteComponent`	`limit(Passthrough type, short value)` Only allow data through under certain user controlled conditions
`RouteComponent`	`log(Subscriber subscriber)` Records the input data to the on-board logger, retrieved when a log download is started
`RouteComponent`	`lowpass(byte nSamples)` Applies a low pass filter over the input data.
`RouteComponent`	`map(Function1 fn)` Apply a 1 input function to all of the input data
`RouteComponent`	`map(Function2 fn, java.lang.Number rhs)` Apply a 2 input function to all of the input data
`RouteComponent`	`map(Function2 fn, java.lang.String... dataNames)` Variant of `map(Function2, Number)` where the rhs value is the output of another sensor or processor
`RouteMulticast`	`multicast()` Splits the route directing the input data to different end points
`RouteComponent`	`name(java.lang.String name)` Assigns a user-defined name identifying the data processor.
`RouteComponent`	`pack(byte count)` Packs multiple input values into 1 BTLE packet.
`RouteComponent`	`react(RouteComponent.Action action)` Programs the board to react in response to data being created by the most resent sensor or processor
`RouteSplit`	`split()` Separates multi=component data into its individual values
`RouteComponent`	`stream(Subscriber subscriber)` Streams the input data to the local device
`RouteComponent`	`to()` Signals the creation of a new multicast branch

- Method Detail
  - multicast
```
RouteMulticast multicast()
```
    Splits the route directing the input data to different end points
    
    Returns:
    
    Element for building multicast routes
  - to
```
RouteComponent to()
```
    Signals the creation of a new multicast branch
    
    Returns:
    
    RouteComponent from the most recent multicast component
  - split
```
RouteSplit split()
```
    Separates multi=component data into its individual values
    
    Returns:
    
    Element for building routes for component data values
  - index
```
RouteComponent index(int i)
```
    Gets a specific component value from the split data value
    
    Parameters:
    
    i - Position in the split values array to return
    
    Returns:
    
    Object representing the component value
  - end
```
RouteComponent end()
```
    Signifies the end of a split or multicast route. Control is return to the most recent multicast or split route element
    
    Returns:
    
    Most recent multicast or split route
  - name
```
RouteComponent name(java.lang.String name)
```
    Assigns a user-defined name identifying the data processor. The key can be used to modify the processor configuration, read its state, and create feedback or feedforward loops with other data processors
    
    Parameters:
    
    name - Value to name the most recent data processor
    
    Returns:
    
    Calling object
    
    See Also:
    
    DataProcessor.edit(String, Class), DataProcessor.state(String)
  - stream
```
RouteComponent stream(Subscriber subscriber)
```
    Streams the input data to the local device
    
    Parameters:
    
    subscriber - Subscriber to handle the received data
    
    Returns:
    
    Calling object
  - log
```
RouteComponent log(Subscriber subscriber)
```
    Records the input data to the on-board logger, retrieved when a log download is started
    
    Parameters:
    
    subscriber - Subscriber to handle the received data
    
    Returns:
    
    Calling object
  - react
```
RouteComponent react(RouteComponent.Action action)
```
    Programs the board to react in response to data being created by the most resent sensor or processor
    
    Parameters:
    
    action - On-board action to execute
    
    Returns:
    
    Calling object
  - buffer
```
RouteComponent buffer()
```
    Stores the input data in memory. The currently stored value can be extracted by reading he buffer state. As this buffer has no output, the route cannot continue thus the route either ends here or control is passed back to the most recent multicast or splitter
    
    Returns:
    
    Object for continuing the route
  - fuse
```
RouteComponent fuse(java.lang.String... bufferNames)
```
    Combines data from multiple sources into 1 packet. The additional data you want to combine must first be stored into a named buffer.
    
    Parameters:
    
    bufferNames - Named buffer components holding the extra data to combine
    
    Returns:
    
    Object for continuing the route
  - count
```
RouteComponent count()
```
    Counts the number of data samples that have passed through this component and outputs the current count
    
    Returns:
    
    Object representing the output of the counter
  - accumulate
```
RouteComponent accumulate()
```
    Accumulates a running sum of all data samples passing through this component and outputs the current tally
    
    Returns:
    
    Object representing the output of the counter
  - highpass
```
RouteComponent highpass(byte nSamples)
```
    Applies a high pass filter over the input data, available in firmware v1.3.4 and later
    
    Parameters:
    
    nSamples - Number of previous data samples to compare against
    
    Returns:
    
    Object representing the high pass output
  - lowpass
```
RouteComponent lowpass(byte nSamples)
```
    Applies a low pass filter over the input data. Starting in firmware v1.3.4, can be used with multi-component data e.g. acceleration values.
    
    Parameters:
    
    nSamples - Number of previous data samples to compare against
    
    Returns:
    
    Object representing the low pass output
  - average
```
@Deprecated
RouteComponent average(byte nSamples)
```
    Deprecated. Renamed to lowpass in SDK v3.1
    
    Computes a moving average over the previous N samples. This component will not output data until the first average i.e. until N samples have been received.
    
    Parameters:
    
    nSamples - Number of samples to average over
    
    Returns:
    
    Object representing the output of the averager
  - delay
```
RouteComponent delay(byte samples)
```
    Stops data from leaving until at least N samples have been collected.
    
    Parameters:
    
    samples - Number of samples to collect
    
    Returns:
    
    Object representing the output of the sample delay component
  - map
```
RouteComponent map(Function1 fn)
```
    Apply a 1 input function to all of the input data
    
    Parameters:
    
    fn - Function to use
    
    Returns:
    
    Object representing the output of the mapper
  - map
```
RouteComponent map(Function2 fn,
                   java.lang.Number rhs)
```
    Apply a 2 input function to all of the input data
    
    Parameters:
    
    fn - Function to use
    
    rhs - Second input for the function
    
    Returns:
    
    Object representing the output of the mapper
  - map
```
RouteComponent map(Function2 fn,
                   java.lang.String... dataNames)
```
    Variant of map(Function2, Number) where the rhs value is the output of another sensor or processor
    
    Parameters:
    
    fn - Function to apply to the input data
    
    dataNames - Keys identifying which sensor or processor data to feed into the mapper
    
    Returns:
    
    Object representing the output of the mapper
  - limit
```
RouteComponent limit(int period)
```
    Reduce the amount of data allowed through such that the output data rate matches the delay
    
    Parameters:
    
    period - How often to allow data through, in milliseconds (ms)
    
    Returns:
    
    Object representing the output of the limiter
  - limit
```
RouteComponent limit(Passthrough type,
                     short value)
```
    Only allow data through under certain user controlled conditions
    
    Parameters:
    
    type - Passthrough operation type
    
    value - Initial value to set the passthrough limiter to
    
    Returns:
    
    Object representing the output of the limiter
  - find
```
RouteComponent find(PulseOutput output,
                    java.lang.Number threshold,
                    short samples)
```
    Scans the input data for a pulse. When one is detected, output a summary of the scanned data
    
    Parameters:
    
    output - Type of summary data to output
    
    threshold - Value the sensor data must exceed for a valid pulse
    
    samples - Minimum number of samples that must be above the threshold for a valid pulse
    
    Returns:
    
    Object representing the output of the pulse finder
  - filter
```
RouteComponent filter(Comparison op,
                      java.lang.Number... references)
```
    Remove data from the route that does not satisfy the comparison
    
    Parameters:
    
    op - Comparison operation to perform
    
    references - Reference values to compare against, can be multiple values if the board is on firmware v1.2.3 or later
    
    Returns:
    
    Object representing the output of the comparator filter
  - filter
```
RouteComponent filter(Comparison op,
                      java.lang.String... dataNames)
```
    Variant of the filter(Comparison, Number...) function where the reference values are outputs from other sensors or processors
    
    Parameters:
    
    op - Comparison operation to perform
    
    dataNames - Names identifying which sensor or processor data to use as the reference value when new values are produced
    
    Returns:
    
    Object representing the output of the comparator filter
  - filter
```
RouteComponent filter(Comparison op,
                      ComparisonOutput output,
                      java.lang.Number... references)
```
    Variant of filter(Comparison, Number...) where the filter can output values providing additional details about the comparison. This variant component is only supported starting with firmware v1.2.5. Note that if ComparisonOutput.PASS_FAIL or ComparisonOutput.ZONE is used, component will instead function as a map component.
    
    Parameters:
    
    op - Comparison operation to perform.
    
    output - Output type the filter should produce
    
    references - Reference values to compare against, can be multiple values if the board is on firmware v1.2.3 or later
    
    Returns:
    
    Object representing the output of the comparator filter
  - filter
```
RouteComponent filter(Comparison op,
                      ComparisonOutput output,
                      java.lang.String... dataNames)
```
    Variant of filter(Comparison, ComparisonOutput, Number...) where reference values are outputs from other sensors or processors.
    
    Parameters:
    
    op - Comparison operation to perform
    
    output - Output type of the filter
    
    dataNames - Names identifying which sensor or processor data to use as the reference value when new values are produced
    
    Returns:
    
    Object representing the output of the comparator filter
  - filter
```
RouteComponent filter(ThresholdOutput output,
                      java.lang.Number threshold)
```
    Remove data from the route that doesn't not cross the threshold
    
    Parameters:
    
    output - Type of output the filter will produce
    
    threshold - Threshold boundary the data must cross
    
    Returns:
    
    Object representing the output of the threshold filter
  - filter
```
RouteComponent filter(ThresholdOutput output,
                      java.lang.Number threshold,
                      java.lang.Number hysteresis)
```
    Variant of filter(ThresholdOutput, Number) with a configurable hysteresis value for data that frequently oscillates around the threshold boundary
    
    Parameters:
    
    output - Type of output the filter will produce
    
    threshold - Threshold boundary the data must cross
    
    hysteresis - Minimum distance between the boundary and value that indicates a successful crossing
    
    Returns:
    
    Object representing the output of the threshold filter
  - filter
```
RouteComponent filter(DifferentialOutput output,
                      java.lang.Number distance)
```
    Removes data that it is not a minimum distance away from a reference value. The reference value is continually updated to be the previous passing value
    
    Parameters:
    
    output - Type of output the filter will produce
    
    distance - Minimum distance from the reference value
    
    Returns:
    
    Object representing the output of the differential filter
  - pack
```
RouteComponent pack(byte count)
```
    Packs multiple input values into 1 BTLE packet. Used to reduce the number of packets broadcasted over the link.
    
    Parameters:
    
    count - Number of input values to pack
    
    Returns:
    
    Object representing the output of the packer
  - account
```
RouteComponent account()
```
    Variant of account(AccountType) that defaults to recalculating timestamps
    
    Returns:
    
    Object representing the accounter output
  - account
```
RouteComponent account(RouteComponent.AccountType type)
```
    Add additional information to the payload to assist in checking if streamed data is lost
    
    Parameters:
    
    type - Type of information to append to the data<
    
    Returns:
    
    Object representing the accounter output

Interface RouteComponent

Nested Class Summary

Method Summary

Method Detail

multicast

to

split

index

end

name

stream

log

react

buffer

fuse

count

accumulate

highpass

lowpass

average

delay

map

map

map

limit

limit

find

filter

filter

filter

filter

filter

filter

filter

pack

account

account