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


/**
 * Activation state of a component, i.e., any type that is derived from pm:AbstractComponentState and pm:AbstractMetricState.
 * 
 * Java class for ComponentActivation.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "ComponentActivation", namespace = "http://standards.ieee.org/downloads/11073/11073-10207-2017/participant")
@XmlEnum
public enum ComponentActivation {


    /**
     * The component is operating.
     * 
     */
    @XmlEnumValue("On")
    ON("On"),

    /**
     * NotRdy = Not Ready. The component is not ready to be operated and not operating, but initialization is ongoing.
     * 
     */
    @XmlEnumValue("NotRdy")
    NOT_RDY("NotRdy"),

    /**
     * StndBy = Stand By. The component is ready to be operated, but not currently operating.
     * 
     */
    @XmlEnumValue("StndBy")
    STND_BY("StndBy"),

    /**
     * The component is inactive.
     * 
     */
    @XmlEnumValue("Off")
    OFF("Off"),

    /**
     * Shtdn = Shutdown. The component is ceasing from being ready to be operated or operating, but not yet inactive.
     * 
     */
    @XmlEnumValue("Shtdn")
    SHTDN("Shtdn"),

    /**
     * Fail = Failure. The component has detected a failure and is not ready to be operated.
     * 
     */
    @XmlEnumValue("Fail")
    FAIL("Fail");
    private final String value;

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

}