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


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


    /**
     * Indicates that an ALERT SIGNAL is currently generated.
     * 
     */
    @XmlEnumValue("On")
    ON("On"),

    /**
     * Indicates that an ALERT SIGNAL is currently not generated.
     * 
     */
    @XmlEnumValue("Off")
    OFF("Off"),

    /**
     * Latch = Latched. "Latched" indicates that an ALERT SIGNAL is currently generated even if the ALERT CONDITION is no longer present.
     * 
     */
    @XmlEnumValue("Latch")
    LATCH("Latch"),

    /**
     * Ack = Acknowledged. "Acknowledged" indicates that an ALERT SIGNAL is currently not generated due to an acknowledgment even if the ALERT CONDITION is still present. Acknowledged signals are those, where an auditory ALERT SIGNAL that is related to a currently active ALERT CONDITION, is inactive until the ALERT CONDITION is no longer present.
     * 
     */
    @XmlEnumValue("Ack")
    ACK("Ack");
    private final String value;

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

}