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


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


    /**
     * Dis = Disabled. Object is disabled.
     * 
     */
    @XmlEnumValue("Dis")
    DIS("Dis"),

    /**
     * En = Enabled. Object is enabled
     * 
     */
    @XmlEnumValue("En")
    EN("En"),

    /**
     * NA = Not Available. Object is not available for interaction. This means that it is defined but currently not in a mode so that it can be interacted with.
     * 
     */
    NA("NA");
    private final String value;

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

}