org.somda.sdc.biceps.model.participant.CalibrationState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biceps-model Show documentation

SDCri is a set of Java libraries that implements a network communication framework conforming with the IEEE 11073 SDC specifications. This project implements the model for IEEE 11073-10207.

The newest version!


package org.somda.sdc.biceps.model.participant;

import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlEnumValue;
import jakarta.xml.bind.annotation.XmlType;


/**
 * Calibration state of a component.
 * 
 * Java class for CalibrationState.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "CalibrationState", namespace = "http://standards.ieee.org/downloads/11073/11073-10207-2017/participant")
@XmlEnum
public enum CalibrationState {


    /**
     * No = Not Calibrated. Defines that a component is not calibrated.
     * 
     */
    @XmlEnumValue("No")
    NO("No"),

    /**
     * Req = Calibration Required. Defines that a component requires a calibration.
     * 
     */
    @XmlEnumValue("Req")
    REQ("Req"),

    /**
     * Run = Running. Defines that a calibration for a component is running.
     * 
     */
    @XmlEnumValue("Run")
    RUN("Run"),

    /**
     * Cal = Calibrated. Defines that a component is calibrated.
     * 
     */
    @XmlEnumValue("Cal")
    CAL("Cal"),

    /**
     * Oth = Other. The calibration state is defined by other means.
     * 
     */
    @XmlEnumValue("Oth")
    OTH("Oth");
    private final String value;

    CalibrationState(String v) {
        value = v;
    }

    /**
     * Gets the value associated to the enum constant.
     * 
     * @return
     *     The value linked to the enum.
     */
    public String value() {
        return value;
    }

    /**
     * Gets the enum associated to the value passed as parameter.
     * 
     * @param v
     *     The value to get the enum from.
     * @return
     *     The enum which corresponds to the value, if it exists.
     * @throws IllegalArgumentException
     *     If no value matches in the enum declaration.
     */
    public static CalibrationState fromValue(String v) {
        for (CalibrationState c: CalibrationState.values()) {
            if (c.value.equals(v)) {
                return c;
            }
        }
        throw new IllegalArgumentException(v);
    }

}