com.openxc.sources

Class BaseVehicleDataSource

java.lang.Object

com.openxc.sources.BaseVehicleDataSource

All Implemented Interfaces:

DataPipeline.Operator, VehicleDataSource

Direct Known Subclasses:

ApplicationSource, ContextualVehicleDataSource, RemoteListenerSource, TestSource

public abstract class BaseVehicleDataSource
extends java.lang.Object
implements VehicleDataSource

A common parent for all vehicle data sources. This class encapsulates functionality common to most data sources. It accepts and stores a SourceCallback reference (required by the VehicleDataSource interface) and implements a handleMessage(VehicleMessage) method for subclass to call with each new message, regardless of its origin.

Constructor Summary

Constructors

Constructor and Description
BaseVehicleDataSource()
BaseVehicleDataSource(SourceCallback callback) Construct a new instance and set the callback.

Method Summary

Modifier and Type	Method and Description
protected void	connected()
protected void	disconnected()
SourceCallback	getCallback()
protected java.lang.String	getTag() Return a string suitable as a tag for logging.
protected void	handleMessage(VehicleMessage message) Pass a new message to the callback, if set.
abstract 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	onPipelineActivated()
void	onPipelineDeactivated()
void	setCallback(SourceCallback callback) Set the current source callback to the given value.
void	stop() Clear the callback so no further updates are sent.
protected void	waitForCallback()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseVehicleDataSource

public BaseVehicleDataSource()

BaseVehicleDataSource

public BaseVehicleDataSource(SourceCallback callback)

Construct a new instance and set the callback.

Parameters:

callback - An object implementing the SourceCallback interface that should receive data from this source.

Method Detail

setCallback

public void setCallback(SourceCallback callback)

Set the current source callback to the given value.

Specified by:

setCallback in interface VehicleDataSource

Parameters:

callback - a valid callback or null if you wish to stop the source from sending updates.

disconnected

protected void disconnected()

connected

protected void connected()

isConnected

public abstract boolean isConnected()

Description copied from interface: VehicleDataSource

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.

Specified by:

isConnected in interface VehicleDataSource

stop

public void stop()

Clear the callback so no further updates are sent. Subclasses should be sure to call super.stop() so they also stop sending updates when killed by a user.

Specified by:

stop in interface VehicleDataSource

handleMessage

protected void handleMessage(VehicleMessage message)

Pass a new message to the callback, if set.

Parameters:

message - the new message object.

waitForCallback

protected void waitForCallback()

onPipelineActivated

public void onPipelineActivated()

Specified by:

onPipelineActivated in interface DataPipeline.Operator

onPipelineDeactivated

public void onPipelineDeactivated()

Specified by:

onPipelineDeactivated in interface DataPipeline.Operator

getCallback

public SourceCallback getCallback()

getTag

protected java.lang.String getTag()

Return a string suitable as a tag for logging.