org.opencds.cqf.tooling.vmr.Cycle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tooling Show documentation
CQF Tooling
There is a newer version: 3.1.0
//
// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.3.0 
// See https://javaee.github.io/jaxb-v2/ 
// Any modifications to this file will be lost upon recompilation of the source schema. 
// Generated on: 2022.06.24 at 08:44:29 AM MDT 
//


package org.opencds.cqf.tooling.vmr;

import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlType;


/**
 * Represents a predictable periodic interval where events may occur at specific points within this interval. Examples may include:
 * 
 *  1. An event that may occur TID.
 *  2. An event that may occur TID but at specific times such as 8am, noon, and 3pm.
 *  3. An event that may occur three times a day but the interval is not important.
 *  4. An event that may occur three times a day where the interval between events must be 8hrs (Q8H).
 * 
 * Note that cycles may be nested. For instance, 
 * A chemotherapy regimen where a substance is administered TID on day 1,5,10 of a 10-day cycle.
 * 
 * Java class for Cycle complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="Cycle">
 *   <complexContent>
 *     <extension base="{urn:hl7-org:vmr:r2}ExtendedVmrTypeBase">
 *       <sequence>
 *         <element name="cycleLength" type="{urn:hl7-org:cdsdt:r2}IVL_PQ" minOccurs="0"/>
 *         <element name="totalCycleCount" type="{urn:hl7-org:cdsdt:r2}INT" minOccurs="0"/>
 *         <element name="endOn" type="{urn:hl7-org:cdsdt:r2}IVL_TS" minOccurs="0"/>
 *         <element name="cycleLeadTime" type="{urn:hl7-org:cdsdt:r2}IVL_PQ" minOccurs="0"/>
 *         <element name="cycleLagTime" type="{urn:hl7-org:cdsdt:r2}IVL_PQ" minOccurs="0"/>
 *         <element name="cycleTiming" type="{urn:hl7-org:vmr:r2}CycleEventTiming" maxOccurs="unbounded" minOccurs="0"/>
 *       </sequence>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Cycle", propOrder = {
    "cycleLength",
    "totalCycleCount",
    "endOn",
    "cycleLeadTime",
    "cycleLagTime",
    "cycleTiming"
})
public class Cycle
    extends ExtendedVmrTypeBase
{

    protected IVLPQ cycleLength;
    protected INT totalCycleCount;
    protected IVLTS endOn;
    protected IVLPQ cycleLeadTime;
    protected IVLPQ cycleLagTime;
    protected List cycleTiming;

    /**
     * Gets the value of the cycleLength property.
     * 
     * @return
     *     possible object is
     *     {@link IVLPQ }
     *     
     */
    public IVLPQ getCycleLength() {
        return cycleLength;
    }

    /**
     * Sets the value of the cycleLength property.
     * 
     * @param value
     *     allowed object is
     *     {@link IVLPQ }
     *     
     */
    public void setCycleLength(IVLPQ value) {
        this.cycleLength = value;
    }

    /**
     * Gets the value of the totalCycleCount property.
     * 
     * @return
     *     possible object is
     *     {@link INT }
     *     
     */
    public INT getTotalCycleCount() {
        return totalCycleCount;
    }

    /**
     * Sets the value of the totalCycleCount property.
     * 
     * @param value
     *     allowed object is
     *     {@link INT }
     *     
     */
    public void setTotalCycleCount(INT value) {
        this.totalCycleCount = value;
    }

    /**
     * Gets the value of the endOn property.
     * 
     * @return
     *     possible object is
     *     {@link IVLTS }
     *     
     */
    public IVLTS getEndOn() {
        return endOn;
    }

    /**
     * Sets the value of the endOn property.
     * 
     * @param value
     *     allowed object is
     *     {@link IVLTS }
     *     
     */
    public void setEndOn(IVLTS value) {
        this.endOn = value;
    }

    /**
     * Gets the value of the cycleLeadTime property.
     * 
     * @return
     *     possible object is
     *     {@link IVLPQ }
     *     
     */
    public IVLPQ getCycleLeadTime() {
        return cycleLeadTime;
    }

    /**
     * Sets the value of the cycleLeadTime property.
     * 
     * @param value
     *     allowed object is
     *     {@link IVLPQ }
     *     
     */
    public void setCycleLeadTime(IVLPQ value) {
        this.cycleLeadTime = value;
    }

    /**
     * Gets the value of the cycleLagTime property.
     * 
     * @return
     *     possible object is
     *     {@link IVLPQ }
     *     
     */
    public IVLPQ getCycleLagTime() {
        return cycleLagTime;
    }

    /**
     * Sets the value of the cycleLagTime property.
     * 
     * @param value
     *     allowed object is
     *     {@link IVLPQ }
     *     
     */
    public void setCycleLagTime(IVLPQ value) {
        this.cycleLagTime = value;
    }

    /**
     * Gets the value of the cycleTiming property.
     * 
     * 
     * This accessor method returns a reference to the live list,
     * not a snapshot. Therefore any modification you make to the
     * returned list will be present inside the JAXB object.
     * This is why there is not a set method for the cycleTiming property.
     * 
     * 

     * For example, to add a new item, do as follows:
     * 
     *    getCycleTiming().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link CycleEventTiming }
     * 
     * 
     */
    public List getCycleTiming() {
        if (cycleTiming == null) {
            cycleTiming = new ArrayList();
        }
        return this.cycleTiming;
    }

}