com.openxc.sources

Interface VehicleDataSource

All Superinterfaces:

DataPipeline.Operator

All Known Subinterfaces:

VehicleInterface

All Known Implementing Classes:

ApplicationSource, BaseVehicleDataSource, BluetoothVehicleInterface, BytestreamDataSource, ContextualVehicleDataSource, NativeLocationSource, NetworkVehicleInterface, PhoneSensorSource, RemoteListenerSource, TestSource, TestVehicleInterface, TraceVehicleDataSource, UsbVehicleInterface

public interface VehicleDataSource
extends DataPipeline.Operator

The interface for all sources of raw vehicle measurements. Data is retrieved from a vehicle source by registering a callback object that implements the DataPipeline - its receive() methods are passed values from the data source.

Method Summary

Modifier and Type	Method and Description
boolean	isConnected() Return true if the data source is actively connected to its target, be it a USB endpoint, a Bluetooth channel, a trace file, etc.
void	setCallback(SourceCallback callback) Set the callback for receiving raw measurements as they are received.
void	stop() Release any acquired resources and either stop sending measurements (if a source) or stop expecting to receive them (if a sink).

Methods inherited from interface com.openxc.DataPipeline.Operator

onPipelineActivated, onPipelineDeactivated

Method Detail

setCallback

void setCallback(SourceCallback callback)

Set the callback for receiving raw measurements as they are received. Vehicle data sources only need to support a single callback, and in fact should not support more than one - all vehicle measurements should be directed to a single, central collector.

isConnected

boolean isConnected()

Return true if the data source is actively connected to its target, be it a USB endpoint, a Bluetooth channel, a trace file, etc. The source is capable of providing new vehicle data. Returns true if connected, false otherwise.

stop

void stop()

Release any acquired resources and either stop sending measurements (if a source) or stop expecting to receive them (if a sink).