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

Go to download

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;


/**
 * The activation state of any ALERT SYSTEM ELEMENT, i.e., pm:AlertSystemState, pm:AlertConditionState, pm:LimitAlertConditionState, and pm:AlertSignalState.
 * 
 * Special meanings MAY apply depending on the ALERT SYSTEM ELEMENT.
 * 
 * Java class for AlertActivation.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "AlertActivation", namespace = "http://standards.ieee.org/downloads/11073/11073-10207-2017/participant")
@XmlEnum
public enum AlertActivation {


    /**
     * The ALERT SYSTEM ELEMENT is operating.
     * 
     */
    @XmlEnumValue("On")
    ON("On"),

    /**
     * The ALERT SYSTEM ELEMENT is not operating.
     * 
     */
    @XmlEnumValue("Off")
    OFF("Off"),

    /**
     * Psd = Paused. The ALERT SYSTEM ELEMENT is temporarily not operating.
     * 
     */
    @XmlEnumValue("Psd")
    PSD("Psd");
    private final String value;

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

}