org.somda.sdc.biceps.model.participant.MeasurementValidity 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;


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


    /**
     * Vld = Valid. A measured value that is correct from the perspective of the measuring device.
     * 
     */
    @XmlEnumValue("Vld")
    VLD("Vld"),

    /**
     * Vldated = Validated Data. A measured value where the validity has been confirmed by an external actor, e.g., an operator, other than the POC MEDICAL DEVICE.
     * 
     */
    @XmlEnumValue("Vldated")
    VLDATED("Vldated"),

    /**
     * Ong = Measurement Ongoing. Indicates that a new measurement is just being taken and therefore measured value is not available.
     * 
     */
    @XmlEnumValue("Ong")
    ONG("Ong"),

    /**
     * Qst = Questionable. A measured value where correctness can not be guaranteed.
     * 
     */
    @XmlEnumValue("Qst")
    QST("Qst"),

    /**
     * Calib = Calibration Ongoing. A measured value where correctness can not be guaranteed, because a calibration is currently going on.
     * 
     */
    @XmlEnumValue("Calib")
    CALIB("Calib"),

    /**
     * Inv = Invalid. A measured value that is incorrect from the perspective of the measuring device.
     * 
     */
    @XmlEnumValue("Inv")
    INV("Inv"),

    /**
     * Oflw = Overflow. A measured value where correctness cannot be guaranteed as it is above all defined technical ranges.
     * 
     */
    @XmlEnumValue("Oflw")
    OFLW("Oflw"),

    /**
     * Uflw = Underflow. A measured value where correctness cannot be guaranteed as it is below all defined technical ranges.
     * 
     */
    @XmlEnumValue("Uflw")
    UFLW("Uflw"),

    /**
     * NA = Not Available. No value can be derived, e.g., if a sensor is not placed correctly.
     * 
     */
    NA("NA");
    private final String value;

    MeasurementValidity(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 MeasurementValidity fromValue(String v) {
        for (MeasurementValidity c: MeasurementValidity.values()) {
            if (c.value.equals(v)) {
                return c;
            }
        }
        throw new IllegalArgumentException(v);
    }

}