com.digi.wva.device

Class VehicleData

java.lang.Object

com.digi.wva.device.VehicleData

public class VehicleData
extends Object

This object allows users to access both raw and derived data about the current operation of a vehicle. These endpoints offer a subscription model for continuous updates, and an alarm model for handling/logging special events.

You should not need to create an instance of this class manually. Use the WVA class to manage all interactions with the WVA.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUB_SUFFIX Suffix used to create the default short names for subscriptions.

Constructor Summary

Constructors

Constructor and Description
VehicleData(HttpClient client)

Method Summary

Methods

Modifier and Type	Method and Description
void	createAlarm(String endpoint, AlarmType type, double threshold, int seconds, WvaCallback<Void> cb) Underlying implementation of WVA.createVehicleDataAlarm(String, AlarmType, float, int, WvaCallback)
void	deleteAlarm(String endpoint, AlarmType type, WvaCallback<Void> cb) Underlying implementation of WVA.deleteVehicleDataAlarm(String, AlarmType, WvaCallback)
void	fetchVehicleData(String endpoint, WvaCallback<VehicleDataResponse> cb) Underlying implementation of WVA.fetchVehicleData(String, WvaCallback)
void	fetchVehicleDataEndpoints(WvaCallback<Set<String>> onInitialized) Underlying implementation of WVA.fetchVehicleDataEndpoints(WvaCallback).
VehicleDataResponse	getCachedVehicleData(String endpoint) Underlying implementation of WVA.getCachedVehicleData(String)
Set<String>	getCachedVehicleDataEndpoints() Underlying implementation of WVA.getCachedVehicleDataEndpoints()
void	notifyListeners(VehicleDataEvent e) Triggers the listener associated with e's endpoint name (if there are any), and then the "catch-all" listener (if any).
void	removeAllListeners() Underlying implementation of WVA.removeAllVehicleDataListeners()
void	removeVehicleDataListener() Underlying implementation of WVA.removeVehicleDataListener()
void	removeVehicleDataListener(String endpoint) Underlying implementation of WVA.removeVehicleDataListener(String)
void	setVehicleDataListener(String endpoint, VehicleDataListener listener) Underlying implementation of WVA.setVehicleDataListener(String, VehicleDataListener)
void	setVehicleDataListener(VehicleDataListener listener) Underlying implementation of WVA.setVehicleDataListener(VehicleDataListener)
void	subscribe(String endpoint, int seconds, WvaCallback<Void> cb) Underlying implementation of WVA.subscribeToVehicleData(String, int, WvaCallback)
void	unsubscribe(String endpoint, WvaCallback<Void> cb) Underlying implementation of WVA.unsubscribeFromVehicleData(String, WvaCallback)
void	updateCachedVehicleData(String uri, VehicleDataResponse response) Updates the cached value of an endpoint, and also calls notifyListeners(VehicleDataEvent) with a new Event constructed from uri and response.
void	updateCachedVehicleData(VehicleDataEvent e) Updates the cached value of an endpoint, and also calls notifyListeners(VehicleDataEvent) with e.

Methods inherited from class java.lang.Object

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

Field Detail

SUB_SUFFIX

public static final String SUB_SUFFIX

Suffix used to create the default short names for subscriptions. Appended onto the endpoint name, e.g. "EngineSpeed" becomes "EngineSpeed~sub".

See Also:

Constant Field Values

Constructor Detail

VehicleData

public VehicleData(HttpClient client)

Method Detail

fetchVehicleDataEndpoints

public void fetchVehicleDataEndpoints(WvaCallback<Set<String>> onInitialized)

Underlying implementation of WVA.fetchVehicleDataEndpoints(WvaCallback).

getCachedVehicleDataEndpoints

public Set<String> getCachedVehicleDataEndpoints()

Underlying implementation of WVA.getCachedVehicleDataEndpoints()

notifyListeners

public void notifyListeners(VehicleDataEvent e)

Triggers the listener associated with e's endpoint name (if there are any), and then the "catch-all" listener (if any).

Parameters:

e - the event to be used to trigger the aforementioned listeners

removeAllListeners

public void removeAllListeners()

Underlying implementation of WVA.removeAllVehicleDataListeners()

updateCachedVehicleData

public void updateCachedVehicleData(VehicleDataEvent e)

Updates the cached value of an endpoint, and also calls notifyListeners(VehicleDataEvent) with e. It is convenient for testing when no WVA and/or TCP connection is available.

Parameters:

e - a VehicleDataEvent object

updateCachedVehicleData

public void updateCachedVehicleData(String uri,
                           VehicleDataResponse response)

Updates the cached value of an endpoint, and also calls notifyListeners(VehicleDataEvent) with a new Event constructed from uri and response. It is convenient for testing when no WVA and/or TCP connection is available.

Parameters:

uri - the web service URI whose data is being updated

response - the data from the WVA

setVehicleDataListener

public void setVehicleDataListener(VehicleDataListener listener)

Underlying implementation of WVA.setVehicleDataListener(VehicleDataListener)

removeVehicleDataListener

public void removeVehicleDataListener()

Underlying implementation of WVA.removeVehicleDataListener()

setVehicleDataListener

public void setVehicleDataListener(String endpoint,
                          VehicleDataListener listener)

Underlying implementation of WVA.setVehicleDataListener(String, VehicleDataListener)

removeVehicleDataListener

public void removeVehicleDataListener(String endpoint)

Underlying implementation of WVA.removeVehicleDataListener(String)

getCachedVehicleData

public VehicleDataResponse getCachedVehicleData(String endpoint)

Underlying implementation of WVA.getCachedVehicleData(String)

fetchVehicleData

public void fetchVehicleData(String endpoint,
                    WvaCallback<VehicleDataResponse> cb)

Underlying implementation of WVA.fetchVehicleData(String, WvaCallback)

subscribe

public void subscribe(String endpoint,
             int seconds,
             WvaCallback<Void> cb)
               throws JSONException

Underlying implementation of WVA.subscribeToVehicleData(String, int, WvaCallback)

Throws:

JSONException

unsubscribe

public void unsubscribe(String endpoint,
               WvaCallback<Void> cb)

Underlying implementation of WVA.unsubscribeFromVehicleData(String, WvaCallback)

createAlarm

public void createAlarm(String endpoint,
               AlarmType type,
               double threshold,
               int seconds,
               WvaCallback<Void> cb)
                 throws JSONException

Underlying implementation of WVA.createVehicleDataAlarm(String, AlarmType, float, int, WvaCallback)

Throws:

JSONException

deleteAlarm

public void deleteAlarm(String endpoint,
               AlarmType type,
               WvaCallback<Void> cb)

Underlying implementation of WVA.deleteVehicleDataAlarm(String, AlarmType, WvaCallback)