com.openxc.measurements

Class VehicleButtonEvent

java.lang.Object

com.openxc.measurements.BaseMeasurement<TheUnit>

com.openxc.measurements.EventedMeasurement<State<VehicleButtonEvent.ButtonId>>

com.openxc.measurements.VehicleButtonEvent

All Implemented Interfaces:

Measurement

public class VehicleButtonEvent
extends EventedMeasurement<State<VehicleButtonEvent.ButtonId>>

A ButtonEvent represents a button press, release or hold on the vehicle HMI. This measurement is only valid when used asynchronously, much like any other key or button event in Java. An application registers to receive button events, and decides what to do based on the returned ButtonId and ButtonAction. If this measurement is retrieved synchronously, it will return the last button event received - this is probably not what you want. TODO This is by far the ugliest measurement because it has to incorporate two different values instead of the usual one. Is this implementation saying something about the architecture in general, or is it just an edge case we need to ignore and let live?

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VehicleButtonEvent.ButtonAction The ButtonAction is the specific event that occurred.
static class	VehicleButtonEvent.ButtonId The ButtonId is the direction of a button within a single control cluster.

Nested classes/interfaces inherited from interface com.openxc.measurements.Measurement

Measurement.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID

Fields inherited from class com.openxc.measurements.BaseMeasurement

mValue

Constructor Summary

Constructors

Constructor and Description
VehicleButtonEvent(State<VehicleButtonEvent.ButtonId> value, State<VehicleButtonEvent.ButtonAction> event)
VehicleButtonEvent(java.lang.String value, java.lang.String event)
VehicleButtonEvent(VehicleButtonEvent.ButtonId value, VehicleButtonEvent.ButtonAction event)

Method Summary

Modifier and Type	Method and Description
State<VehicleButtonEvent.ButtonAction>	getEvent()
java.lang.String	getGenericName()
java.lang.String	getSerializedEvent()
java.lang.String	getSerializedValue() Return the value of this measurement as a type good for serialization.

Methods inherited from class com.openxc.measurements.EventedMeasurement

equals, hasEvent, toVehicleMessage

Methods inherited from class com.openxc.measurements.BaseMeasurement

getAge, getBirthtime, getClassForId, getKeyForMeasurement, getMeasurementFromMessage, getMeasurementFromMessage, getName, getRange, getValue, hasRange, setTimestamp, toString

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

VehicleButtonEvent

public VehicleButtonEvent(State<VehicleButtonEvent.ButtonId> value,
                          State<VehicleButtonEvent.ButtonAction> event)

VehicleButtonEvent

public VehicleButtonEvent(VehicleButtonEvent.ButtonId value,
                          VehicleButtonEvent.ButtonAction event)

VehicleButtonEvent

public VehicleButtonEvent(java.lang.String value,
                          java.lang.String event)

Method Detail

getEvent

public State<VehicleButtonEvent.ButtonAction> getEvent()

Overrides:

getEvent in class EventedMeasurement<State<VehicleButtonEvent.ButtonId>>

getSerializedEvent

public java.lang.String getSerializedEvent()

Specified by:

getSerializedEvent in class EventedMeasurement<State<VehicleButtonEvent.ButtonId>>

getSerializedValue

public java.lang.String getSerializedValue()

Description copied from interface: Measurement

Return the value of this measurement as a type good for serialization.

Specified by:

getSerializedValue in interface Measurement

Overrides:

getSerializedValue in class BaseMeasurement<State<VehicleButtonEvent.ButtonId>>

Returns:

something easily serializable - e.g. String, Double, Boolean.

getGenericName

public java.lang.String getGenericName()

Specified by:

getGenericName in interface Measurement

Specified by:

getGenericName in class BaseMeasurement<State<VehicleButtonEvent.ButtonId>>