com.digi.wva.device

Class FaultCodes

java.lang.Object

com.digi.wva.device.FaultCodes

public class FaultCodes
extends Object

This object allows users to access information about vehicle diagnostic trouble codes (also known as fault codes). The WVA allows for both direct querying of the most recent fault code from a particular ECU, and subscribing and/or setting up alarms to receive new fault code information through the TCP event channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FaultCodes.Bus
static class	FaultCodes.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAULT_CODE_BASE The base URL path for all fault code data.

Constructor Summary

Constructors

Constructor and Description
FaultCodes(HttpClient client)

Method Summary

Methods

Modifier and Type	Method and Description
void	createAlarm(FaultCodes.Bus bus, FaultCodes.MessageType type, String ecu, int seconds, WvaCallback<Void> cb) Underlying implementation of WVA.createFaultCodeAlarm(FaultCodes.Bus, FaultCodes.MessageType, String, int, WvaCallback)
void	deleteAlarm(FaultCodes.Bus bus, FaultCodes.MessageType type, String ecu, WvaCallback<Void> cb) Underlying implementation of WVA.deleteFaultCodeAlarm(FaultCodes.Bus, FaultCodes.MessageType, String, WvaCallback)
void	fetchEcuNames(FaultCodes.Bus bus, WvaCallback<Set<String>> callback) Underlying implementation of WVA.fetchFaultCodeEcuNames(FaultCodes.Bus, WvaCallback)
void	fetchFaultCode(FaultCodes.Bus bus, FaultCodes.MessageType type, String ecu, WvaCallback<FaultCodeResponse> cb) Underlying implementation of WVA.fetchFaultCode(FaultCodes.Bus, FaultCodes.MessageType, String, WvaCallback)
FaultCodeResponse	getCachedFaultCode(FaultCodes.Bus bus, FaultCodes.MessageType type, String ecu) Underlying implementation of WVA.getCachedFaultCode(FaultCodes.Bus, FaultCodes.MessageType, String)
void	notifyListeners(FaultCodeEvent e) Triggers the listener associated with e's shortname (if there are any), and then the "catch-all" listener (if any).
void	removeAllListeners() Underlying implementation of WVA.removeAllFaultCodeListeners()
void	removeFaultCodeListener() Underlying implementation of WVA.removeFaultCodeListener()
void	removeFaultCodeListener(FaultCodes.Bus bus, FaultCodes.MessageType type, String ecu) Underlying implementation of WVA.removeFaultCodeListener(FaultCodes.Bus, FaultCodes.MessageType, String)
void	setFaultCodeListener(FaultCodeListener listener) Underlying implementation of WVA.setFaultCodeListener(FaultCodeListener)
void	setFaultCodeListener(FaultCodes.Bus bus, FaultCodes.MessageType type, String ecu, FaultCodeListener listener) Underlying implementation of WVA.setFaultCodeListener(FaultCodes.Bus, FaultCodes.MessageType, String, FaultCodeListener)
void	subscribe(FaultCodes.Bus bus, FaultCodes.MessageType type, String ecu, int seconds, WvaCallback<Void> cb) Underlying implementation of WVA.subscribeToFaultCodes(FaultCodes.Bus, FaultCodes.MessageType, String, int, WvaCallback)
void	unsubscribe(FaultCodes.Bus bus, FaultCodes.MessageType type, String ecu, WvaCallback<Void> cb) Underlying implementation of WVA.unsubscribeFromFaultCodes(FaultCodes.Bus, FaultCodes.MessageType, String, WvaCallback)
void	updateCachedFaultCode(FaultCodeEvent e) Updates the cached fault code value of a given ECU, and also calls notifyListeners(FaultCodeEvent) with e.
void	updateCachedFaultCode(String uri, FaultCodeResponse response) Updates the cached fault code value of a given ECU, and also calls notifyListeners(FaultCodeEvent) with a new FaultCodeEvent constructed using uri and response.

Methods inherited from class java.lang.Object

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

Field Detail

FAULT_CODE_BASE

public static final String FAULT_CODE_BASE

The base URL path for all fault code data.

See Also:

Constant Field Values

Constructor Detail

FaultCodes

public FaultCodes(HttpClient client)

Method Detail

notifyListeners

public void notifyListeners(FaultCodeEvent e)

Triggers the listener associated with e's shortname (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.removeAllFaultCodeListeners()

updateCachedFaultCode

public void updateCachedFaultCode(FaultCodeEvent e)

Updates the cached fault code value of a given ECU, and also calls notifyListeners(FaultCodeEvent) with e. It is convenient for testing when no WVA and/or TCP connection is available.

Parameters:

e - a FaultCodeEvent object

updateCachedFaultCode

public void updateCachedFaultCode(String uri,
                         FaultCodeResponse response)

Updates the cached fault code value of a given ECU, and also calls notifyListeners(FaultCodeEvent) with a new FaultCodeEvent constructed using 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

setFaultCodeListener

public void setFaultCodeListener(FaultCodeListener listener)

Underlying implementation of WVA.setFaultCodeListener(FaultCodeListener)

removeFaultCodeListener

public void removeFaultCodeListener()

Underlying implementation of WVA.removeFaultCodeListener()

setFaultCodeListener

public void setFaultCodeListener(FaultCodes.Bus bus,
                        FaultCodes.MessageType type,
                        String ecu,
                        FaultCodeListener listener)

Underlying implementation of WVA.setFaultCodeListener(FaultCodes.Bus, FaultCodes.MessageType, String, FaultCodeListener)

removeFaultCodeListener

public void removeFaultCodeListener(FaultCodes.Bus bus,
                           FaultCodes.MessageType type,
                           String ecu)

Underlying implementation of WVA.removeFaultCodeListener(FaultCodes.Bus, FaultCodes.MessageType, String)

getCachedFaultCode

public FaultCodeResponse getCachedFaultCode(FaultCodes.Bus bus,
                                   FaultCodes.MessageType type,
                                   String ecu)

Underlying implementation of WVA.getCachedFaultCode(FaultCodes.Bus, FaultCodes.MessageType, String)

fetchFaultCode

public void fetchFaultCode(FaultCodes.Bus bus,
                  FaultCodes.MessageType type,
                  String ecu,
                  WvaCallback<FaultCodeResponse> cb)

Underlying implementation of WVA.fetchFaultCode(FaultCodes.Bus, FaultCodes.MessageType, String, WvaCallback)

fetchEcuNames

public void fetchEcuNames(FaultCodes.Bus bus,
                 WvaCallback<Set<String>> callback)

Underlying implementation of WVA.fetchFaultCodeEcuNames(FaultCodes.Bus, WvaCallback)

subscribe

public void subscribe(FaultCodes.Bus bus,
             FaultCodes.MessageType type,
             String ecu,
             int seconds,
             WvaCallback<Void> cb)
               throws JSONException

Underlying implementation of WVA.subscribeToFaultCodes(FaultCodes.Bus, FaultCodes.MessageType, String, int, WvaCallback)

Throws:

JSONException - If an error occurs while creating the request

unsubscribe

public void unsubscribe(FaultCodes.Bus bus,
               FaultCodes.MessageType type,
               String ecu,
               WvaCallback<Void> cb)

Underlying implementation of WVA.unsubscribeFromFaultCodes(FaultCodes.Bus, FaultCodes.MessageType, String, WvaCallback)

createAlarm

public void createAlarm(FaultCodes.Bus bus,
               FaultCodes.MessageType type,
               String ecu,
               int seconds,
               WvaCallback<Void> cb)
                 throws JSONException

Underlying implementation of WVA.createFaultCodeAlarm(FaultCodes.Bus, FaultCodes.MessageType, String, int, WvaCallback)

Throws:

JSONException - if an error occurs in generating the JSON data being sent to the WVA to create the alarm

deleteAlarm

public void deleteAlarm(FaultCodes.Bus bus,
               FaultCodes.MessageType type,
               String ecu,
               WvaCallback<Void> cb)

Underlying implementation of WVA.deleteFaultCodeAlarm(FaultCodes.Bus, FaultCodes.MessageType, String, WvaCallback)