com.mbientlab.metawear

Interface DataSignal

public interface DataSignal

Represents data from a data producer (sensor or on-board data processor) and defines what to do with the data

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DataSignal.ActivityHandler Reacts to data being emitted from a producer i.e.
static interface	DataSignal.DataToken Token representing sensor/data processor output.
static interface	DataSignal.ProcessorConfig Base class representing processor configurations

Method Summary

Modifier and Type	Method and Description
DataSignal	branch() Starts a new branch on the most recent split signal.
AsyncOperation<RouteManager>	commit() Writes the data route to the board.
DataSignal	end() Signifies an end the current branch and reverts control back to the previous split signal.
DataSignal	log(java.lang.String key) Logs the data from the most recent data processor or sensor.
DataSignal	monitor(DataSignal.ActivityHandler handler) Attaches a monitor to the most recent data producer that watches for data activity
DataSignal	process(DataSignal.ProcessorConfig config) Attaches a data processor to the signal to filter to transform the data.
DataSignal	process(java.lang.String configUri) Attaches a data processor to the signal to filter or transform the data.
DataSignal	process(java.lang.String key, DataSignal.ProcessorConfig config) Attaches a data processor to the signal to filter or transform the data.
DataSignal	process(java.lang.String key, java.lang.String configUri) Attaches a data processor to the signal to filter or transform the data.
DataSignal	split() Splits a signal, allowing multiple processors to be attached to the same data.
DataSignal	stream(java.lang.String key) Creates a data stream that will broadcast data live from the most recent producer to your mobile device.

Method Detail

split

DataSignal split()

Splits a signal, allowing multiple processors to be attached to the same data.

Returns:

Calling object

branch

DataSignal branch()

Starts a new branch on the most recent split signal.

Returns:

Most recent signal that was split

end

DataSignal end()

Signifies an end the current branch and reverts control back to the previous split signal. If no previously split signals are available, the route must be committed.

Returns:

Previous split signal if available

log

DataSignal log(java.lang.String key)

Logs the data from the most recent data processor or sensor. You must attach a MessageHandler to the logger before initiating a log download

Parameters:

key - Unique key identifying this logger

Returns:

Calling object

See Also:

RouteManager.setLogMessageHandler(String, RouteManager.MessageHandler)

stream

DataSignal stream(java.lang.String key)

Creates a data stream that will broadcast data live from the most recent producer to your mobile device.

Parameters:

key - Unique key identifying the stream

Returns:

Calling object

See Also:

RouteManager.subscribe(String, RouteManager.MessageHandler), RouteManager.unsubscribe(String)

monitor

DataSignal monitor(DataSignal.ActivityHandler handler)

Attaches a monitor to the most recent data producer that watches for data activity

Parameters:

handler - Handler to deal with when the signal is active

Returns:

Calling object

process

DataSignal process(java.lang.String key,
                   DataSignal.ProcessorConfig config)

Attaches a data processor to the signal to filter or transform the data. This function is for processors that are part of a feedback or feedforward loop.

Parameters:

key - Unique key identifying the processor

config - Token holding the processor configuration

Returns:

Calling object

process

DataSignal process(DataSignal.ProcessorConfig config)

Attaches a data processor to the signal to filter to transform the data.

Parameters:

config - Token holding the processor configuration

Returns:

Calling object

process

DataSignal process(java.lang.String configUri)

Attaches a data processor to the signal to filter or transform the data.

Parameters:

configUri - String URI specifying a processor configuration

Returns:

Calling object

process

DataSignal process(java.lang.String key,
                   java.lang.String configUri)

Attaches a data processor to the signal to filter or transform the data. This function is for processors that are part of a feedback or feedforward loop.

Parameters:

key - Unique key identifying the processor

configUri - String URI specifying a processor configuration

Returns:

Calling object

commit

AsyncOperation<RouteManager> commit()

Writes the data route to the board.

Returns:

RouteManager that will be available if the route is successfully written