org.omg.space.xtce.ParameterInstanceRefType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xtcetools Show documentation

This project contains software to support the Object Management Group (OMG) Space Domain Task Force (SDTF) maintained XML Telemetry and Command Exchange (XTCE) specification.

There is a newer version: 1.1.6

Show newest version

//
// 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: 2019.03.16 at 05:52:46 PM MST 
//


package org.omg.space.xtce;

import java.math.BigInteger;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlType;


/**
 * A reference to an instance of a Parameter.   Used when the value of a parameter is required for a calculation or as an index value.  A positive value for instance is forward in time, a negative value for count is backward in time, a 0 value for count means use the current value of the parameter or the first value in a container.
 * 
 * Java class for ParameterInstanceRefType complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType name="ParameterInstanceRefType">
 *   <complexContent>
 *     <extension base="{http://www.omg.org/space/xtce}ParameterRefType">
 *       <attribute name="instance" type="{http://www.w3.org/2001/XMLSchema}integer" default="0" />
 *       <attribute name="useCalibratedValue" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
 *     </extension>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ParameterInstanceRefType")
@XmlSeeAlso({
    TimeAssociationType.class,
    org.omg.space.xtce.InputAlgorithmType.InputSet.ParameterInstanceRef.class,
    ComparisonType.class
})
public class ParameterInstanceRefType
    extends ParameterRefType
{

    @XmlAttribute(name = "instance")
    protected BigInteger instance;
    @XmlAttribute(name = "useCalibratedValue")
    protected Boolean useCalibratedValue;

    /**
     * Gets the value of the instance property.
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getInstance() {
        if (instance == null) {
            return new BigInteger("0");
        } else {
            return instance;
        }
    }

    /**
     * Sets the value of the instance property.
     * 
     * @param value
     *     allowed object is
     *     {@link BigInteger }
     *     
     */
    public void setInstance(BigInteger value) {
        this.instance = value;
    }

    /**
     * Gets the value of the useCalibratedValue property.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public boolean isUseCalibratedValue() {
        if (useCalibratedValue == null) {
            return true;
        } else {
            return useCalibratedValue;
        }
    }

    /**
     * Sets the value of the useCalibratedValue property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     */
    public void setUseCalibratedValue(Boolean value) {
        this.useCalibratedValue = value;
    }

}