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


/**
 * Describes whether METRIC data is generated by real measurements or under unreal settings (demo or test data).
 * 
 * Java class for GenerationMode.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "GenerationMode", namespace = "http://standards.ieee.org/downloads/11073/11073-10207-2017/participant")
@XmlEnum
public enum GenerationMode {


    /**
     * Real = Real Data. A value that is generated under real conditions.
     * 
     */
    @XmlEnumValue("Real")
    REAL("Real"),

    /**
     * Test = Test Data. A value that is arbitrary and is for testing purposes only.
     * 
     */
    @XmlEnumValue("Test")
    TEST("Test"),

    /**
     * Demo = Demo Data. A value that is arbitrary and is for demonstration purposes only.
     * 
     */
    @XmlEnumValue("Demo")
    DEMO("Demo");
    private final String value;

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

}