com.efiAnalytics.plugin.ecu.servers
Interface ControllerParameterServer

public interface ControllerParameterServer

This interface will be implemented by the Host Application. Plugins will retrieve an instance of it from ControllerParameterManager

Author:

Philip Tobin

Method Summary

void	burnData(java.lang.String configurationName) initiates a burn command to the named configuration.
ControllerParameter	getControllerParameter(java.lang.String ecuConfigurationName, java.lang.String controllerParameterName) retrieves a ControllerParameter by name.
java.lang.String[]	getParameterNames(java.lang.String ecuConfigurationName) returns a list of all parameter names in the current controller configuration these names would have been defined in the ecu configuration or ini file
void	subscribe(java.lang.String ecuConfigurationName, java.lang.String parameterName, ControllerParameterChangeListener listener) subscribes the listener to be notified any time there is a change in value for the parameter referenced by name.
void	unsubscribe(ControllerParameterChangeListener listener) unsubscribes the listener from all parameters
void	updateParameter(java.lang.String ecuConfigurationName, java.lang.String controllerParameterName, double value) updates the value of a scalar parameter.
void	updateParameter(java.lang.String ecuConfigurationName, java.lang.String controllerParameterName, double[][] values) updates an Array.
void	updateParameter(java.lang.String ecuConfigurationName, java.lang.String controllerParameterName, java.lang.String option) used to update the value of a bit selection

Method Detail

subscribe

void subscribe(java.lang.String ecuConfigurationName,
               java.lang.String parameterName,
               ControllerParameterChangeListener listener)
               throws ControllerException

subscribes the listener to be notified any time there is a change in value for the parameter referenced by name. use getParameterNames() to retrieve a full list of ecu Paramenter name in the current ecuConfiguration

Throws:

ControllerException

unsubscribe

void unsubscribe(ControllerParameterChangeListener listener)

unsubscribes the listener from all parameters

getParameterNames

java.lang.String[] getParameterNames(java.lang.String ecuConfigurationName)

returns a list of all parameter names in the current controller configuration these names would have been defined in the ecu configuration or ini file

getControllerParameter

ControllerParameter getControllerParameter(java.lang.String ecuConfigurationName,
                                           java.lang.String controllerParameterName)
                                           throws ControllerException

retrieves a ControllerParameter by name. valid names are defined in the ecu configuration or ini file and can be retrieved with getParameterNames()

Throws:

ControllerException - The Exception message will provide greater detail on the error.

ControllerException

updateParameter

void updateParameter(java.lang.String ecuConfigurationName,
                     java.lang.String controllerParameterName,
                     double value)
                     throws ControllerException

updates the value of a scalar parameter.

Throws:

ControllerException - The Exception message will provide greater detail on the error.

ControllerException

updateParameter

void updateParameter(java.lang.String ecuConfigurationName,
                     java.lang.String controllerParameterName,
                     double[][] values)
                     throws ControllerException

updates an Array. The array dimensions must be equal to that of the Parameter which would have been retrieved from ControllerParameter

Throws:

ControllerException - The Exception message will provide greater detail on the error.

ControllerException

updateParameter

void updateParameter(java.lang.String ecuConfigurationName,
                     java.lang.String controllerParameterName,
                     java.lang.String option)
                     throws ControllerException

used to update the value of a bit selection

Parameters:

controllerParameterName - - Valid Parameter name

option - - String value description, must be equal to a valid value retrieved from ControllerParameter

Throws:

ControllerException - The Exception message will provide greater detail on the error.

ControllerException

burnData

void burnData(java.lang.String configurationName)
              throws ControllerException

initiates a burn command to the named configuration. This will persist any changes that have been made to the settings data.

Parameters:

configurationName - - the name of the configuration to initiate the burn command.

Throws:

ControllerException