com.openxc.measurements

Class VehicleDoorStatus

java.lang.Object

com.openxc.measurements.BaseMeasurement<TheUnit>

com.openxc.measurements.EventedMeasurement<State<VehicleDoorStatus.DoorId>>

com.openxc.measurements.VehicleDoorStatus

All Implemented Interfaces:

Measurement

public class VehicleDoorStatus
extends EventedMeasurement<State<VehicleDoorStatus.DoorId>>

A DoorStatus represents a door's ajar status. 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. TODO would you want to be able to query for a specific door's state synchronously?

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VehicleDoorStatus.DoorId The DoorId is the specific door of the vehicle.

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
VehicleDoorStatus(State<VehicleDoorStatus.DoorId> value, Boolean event)
VehicleDoorStatus(java.lang.String value, java.lang.Boolean event)
VehicleDoorStatus(VehicleDoorStatus.DoorId value, Boolean event)
VehicleDoorStatus(VehicleDoorStatus.DoorId value, java.lang.Boolean event)

Method Summary

Modifier and Type	Method and Description
Boolean	getEvent()
java.lang.String	getGenericName()
java.lang.Boolean	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

VehicleDoorStatus

public VehicleDoorStatus(State<VehicleDoorStatus.DoorId> value,
                         Boolean event)

VehicleDoorStatus

public VehicleDoorStatus(VehicleDoorStatus.DoorId value,
                         Boolean event)

VehicleDoorStatus

public VehicleDoorStatus(VehicleDoorStatus.DoorId value,
                         java.lang.Boolean event)

VehicleDoorStatus

public VehicleDoorStatus(java.lang.String value,
                         java.lang.Boolean event)

Method Detail

getEvent

public Boolean getEvent()

Overrides:

getEvent in class EventedMeasurement<State<VehicleDoorStatus.DoorId>>

getSerializedEvent

public java.lang.Boolean getSerializedEvent()

Specified by:

getSerializedEvent in class EventedMeasurement<State<VehicleDoorStatus.DoorId>>

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<VehicleDoorStatus.DoorId>>

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<VehicleDoorStatus.DoorId>>