com.openxc.measurements.VehicleDoorStatus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openxc-it Show documentation

Instrumentation test suite for OpenXC library

The newest version!

package com.openxc.measurements;

import java.util.Locale;

import com.openxc.units.State;

import com.openxc.units.Boolean;

/**
 * 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?
 */
public class VehicleDoorStatus
        extends BaseMeasurement> {
    public final static String ID = "door_status";

    /**
     * The DoorId is the specific door of the vehicle.
     */
    public enum DoorId {
        DRIVER,
        PASSENGER,
        REAR_LEFT,
        REAR_RIGHT,
        BOOT
    }

    public VehicleDoorStatus(State value, Boolean event) {
        super(value, event);
    }

    public VehicleDoorStatus(DoorId value, Boolean event) {
        this(new State(value), event);
    }

    public VehicleDoorStatus(String value, java.lang.Boolean event) {
        this(DoorId.valueOf(value.toUpperCase(Locale.US)), new Boolean(event));
    }

    @Override
    public Boolean getEvent() {
        return (Boolean) super.getEvent();
    }

    @Override
    public java.lang.Boolean getSerializedEvent() {
        return new java.lang.Boolean(getEvent().booleanValue());
    }

    @Override
    public String getSerializedValue() {
        return getValue().enumValue().toString();
    }

    @Override
    public String getGenericName() {
        return ID;
    }
}