All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

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.BigDecimal;
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.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlType;
import javax.xml.datatype.Duration;


/**
 * A command verifier is used to check that the command has been successfully executed. Command Verifiers may be either a Custom Algorithm or a Boolean Check or the presence of a Container for a relative change in the value of a Parameter.  The CheckWindow is a time period where the verification must test true to pass.
 * 
 * 

Java class for CommandVerifierType complex type. * *

The following schema fragment specifies the expected content contained within this class. * *

 * <complexType name="CommandVerifierType">
 *   <complexContent>
 *     <extension base="{http://www.omg.org/space/xtce}OptionalNameDescriptionType">
 *       <sequence>
 *         <choice>
 *           <element name="ComparisonList">
 *             <complexType>
 *               <complexContent>
 *                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *                   <sequence>
 *                     <element name="Comparison" type="{http://www.omg.org/space/xtce}ComparisonType" maxOccurs="unbounded"/>
 *                   </sequence>
 *                 </restriction>
 *               </complexContent>
 *             </complexType>
 *           </element>
 *           <element name="ContainerRef" type="{http://www.omg.org/space/xtce}ContainerRefType"/>
 *           <element name="ParameterValueChange">
 *             <complexType>
 *               <complexContent>
 *                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *                   <sequence>
 *                     <element name="ParameterRef" type="{http://www.omg.org/space/xtce}ParameterRefType"/>
 *                     <element name="Change">
 *                       <complexType>
 *                         <complexContent>
 *                           <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *                             <attribute name="value" use="required" type="{http://www.w3.org/2001/XMLSchema}decimal" />
 *                           </restriction>
 *                         </complexContent>
 *                       </complexType>
 *                     </element>
 *                   </sequence>
 *                 </restriction>
 *               </complexContent>
 *             </complexType>
 *           </element>
 *           <element name="CustomAlgorithm" type="{http://www.omg.org/space/xtce}InputAlgorithmType"/>
 *           <element name="BooleanExpression" type="{http://www.omg.org/space/xtce}BooleanExpressionType"/>
 *           <element name="Comparison" type="{http://www.omg.org/space/xtce}ComparisonType"/>
 *         </choice>
 *         <choice>
 *           <element name="CheckWindow">
 *             <complexType>
 *               <complexContent>
 *                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *                   <attribute name="timeToStartChecking" type="{http://www.omg.org/space/xtce}RelativeTimeType" />
 *                   <attribute name="timeToStopChecking" use="required" type="{http://www.omg.org/space/xtce}RelativeTimeType" />
 *                   <attribute name="timeWindowIsRelativeTo" default="timeLastVerifierPassed">
 *                     <simpleType>
 *                       <restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *                         <enumeration value="commandRelease"/>
 *                         <enumeration value="timeLastVerifierPassed"/>
 *                       </restriction>
 *                     </simpleType>
 *                   </attribute>
 *                 </restriction>
 *               </complexContent>
 *             </complexType>
 *           </element>
 *           <element name="CheckWindowAlgorithms">
 *             <complexType>
 *               <complexContent>
 *                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *                   <sequence>
 *                     <element name="StartCheck" type="{http://www.omg.org/space/xtce}InputAlgorithmType"/>
 *                     <element name="StopTime" type="{http://www.omg.org/space/xtce}InputAlgorithmType"/>
 *                   </sequence>
 *                 </restriction>
 *               </complexContent>
 *             </complexType>
 *           </element>
 *         </choice>
 *       </sequence>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * 
* * */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "CommandVerifierType", propOrder = { "comparisonList", "containerRef", "parameterValueChange", "customAlgorithm", "booleanExpression", "comparison", "checkWindow", "checkWindowAlgorithms" }) @XmlSeeAlso({ org.omg.space.xtce.MetaCommandType.VerifierSet.TransferredToRangeVerifier.class, org.omg.space.xtce.MetaCommandType.VerifierSet.SentFromRangeVerifier.class, org.omg.space.xtce.MetaCommandType.VerifierSet.ReceivedVerifier.class, org.omg.space.xtce.MetaCommandType.VerifierSet.AcceptedVerifier.class, org.omg.space.xtce.MetaCommandType.VerifierSet.QueuedVerifier.class, org.omg.space.xtce.MetaCommandType.VerifierSet.ExecutionVerifier.class, org.omg.space.xtce.MetaCommandType.VerifierSet.CompleteVerifier.class }) public class CommandVerifierType extends OptionalNameDescriptionType { @XmlElement(name = "ComparisonList") protected CommandVerifierType.ComparisonList comparisonList; @XmlElement(name = "ContainerRef") protected ContainerRefType containerRef; @XmlElement(name = "ParameterValueChange") protected CommandVerifierType.ParameterValueChange parameterValueChange; @XmlElement(name = "CustomAlgorithm") protected InputAlgorithmType customAlgorithm; @XmlElement(name = "BooleanExpression") protected BooleanExpressionType booleanExpression; @XmlElement(name = "Comparison") protected ComparisonType comparison; @XmlElement(name = "CheckWindow") protected CommandVerifierType.CheckWindow checkWindow; @XmlElement(name = "CheckWindowAlgorithms") protected CommandVerifierType.CheckWindowAlgorithms checkWindowAlgorithms; /** * Gets the value of the comparisonList property. * * @return * possible object is * {@link CommandVerifierType.ComparisonList } * */ public CommandVerifierType.ComparisonList getComparisonList() { return comparisonList; } /** * Sets the value of the comparisonList property. * * @param value * allowed object is * {@link CommandVerifierType.ComparisonList } * */ public void setComparisonList(CommandVerifierType.ComparisonList value) { this.comparisonList = value; } /** * Gets the value of the containerRef property. * * @return * possible object is * {@link ContainerRefType } * */ public ContainerRefType getContainerRef() { return containerRef; } /** * Sets the value of the containerRef property. * * @param value * allowed object is * {@link ContainerRefType } * */ public void setContainerRef(ContainerRefType value) { this.containerRef = value; } /** * Gets the value of the parameterValueChange property. * * @return * possible object is * {@link CommandVerifierType.ParameterValueChange } * */ public CommandVerifierType.ParameterValueChange getParameterValueChange() { return parameterValueChange; } /** * Sets the value of the parameterValueChange property. * * @param value * allowed object is * {@link CommandVerifierType.ParameterValueChange } * */ public void setParameterValueChange(CommandVerifierType.ParameterValueChange value) { this.parameterValueChange = value; } /** * Gets the value of the customAlgorithm property. * * @return * possible object is * {@link InputAlgorithmType } * */ public InputAlgorithmType getCustomAlgorithm() { return customAlgorithm; } /** * Sets the value of the customAlgorithm property. * * @param value * allowed object is * {@link InputAlgorithmType } * */ public void setCustomAlgorithm(InputAlgorithmType value) { this.customAlgorithm = value; } /** * Gets the value of the booleanExpression property. * * @return * possible object is * {@link BooleanExpressionType } * */ public BooleanExpressionType getBooleanExpression() { return booleanExpression; } /** * Sets the value of the booleanExpression property. * * @param value * allowed object is * {@link BooleanExpressionType } * */ public void setBooleanExpression(BooleanExpressionType value) { this.booleanExpression = value; } /** * Gets the value of the comparison property. * * @return * possible object is * {@link ComparisonType } * */ public ComparisonType getComparison() { return comparison; } /** * Sets the value of the comparison property. * * @param value * allowed object is * {@link ComparisonType } * */ public void setComparison(ComparisonType value) { this.comparison = value; } /** * Gets the value of the checkWindow property. * * @return * possible object is * {@link CommandVerifierType.CheckWindow } * */ public CommandVerifierType.CheckWindow getCheckWindow() { return checkWindow; } /** * Sets the value of the checkWindow property. * * @param value * allowed object is * {@link CommandVerifierType.CheckWindow } * */ public void setCheckWindow(CommandVerifierType.CheckWindow value) { this.checkWindow = value; } /** * Gets the value of the checkWindowAlgorithms property. * * @return * possible object is * {@link CommandVerifierType.CheckWindowAlgorithms } * */ public CommandVerifierType.CheckWindowAlgorithms getCheckWindowAlgorithms() { return checkWindowAlgorithms; } /** * Sets the value of the checkWindowAlgorithms property. * * @param value * allowed object is * {@link CommandVerifierType.CheckWindowAlgorithms } * */ public void setCheckWindowAlgorithms(CommandVerifierType.CheckWindowAlgorithms value) { this.checkWindowAlgorithms = value; } /** *

Java class for anonymous complex type. * *

The following schema fragment specifies the expected content contained within this class. * *

     * <complexType>
     *   <complexContent>
     *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
     *       <attribute name="timeToStartChecking" type="{http://www.omg.org/space/xtce}RelativeTimeType" />
     *       <attribute name="timeToStopChecking" use="required" type="{http://www.omg.org/space/xtce}RelativeTimeType" />
     *       <attribute name="timeWindowIsRelativeTo" default="timeLastVerifierPassed">
     *         <simpleType>
     *           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     *             <enumeration value="commandRelease"/>
     *             <enumeration value="timeLastVerifierPassed"/>
     *           </restriction>
     *         </simpleType>
     *       </attribute>
     *     </restriction>
     *   </complexContent>
     * </complexType>
     * 
* * */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "") public static class CheckWindow { @XmlAttribute(name = "timeToStartChecking") protected Duration timeToStartChecking; @XmlAttribute(name = "timeToStopChecking", required = true) protected Duration timeToStopChecking; @XmlAttribute(name = "timeWindowIsRelativeTo") protected String timeWindowIsRelativeTo; /** * Gets the value of the timeToStartChecking property. * * @return * possible object is * {@link Duration } * */ public Duration getTimeToStartChecking() { return timeToStartChecking; } /** * Sets the value of the timeToStartChecking property. * * @param value * allowed object is * {@link Duration } * */ public void setTimeToStartChecking(Duration value) { this.timeToStartChecking = value; } /** * Gets the value of the timeToStopChecking property. * * @return * possible object is * {@link Duration } * */ public Duration getTimeToStopChecking() { return timeToStopChecking; } /** * Sets the value of the timeToStopChecking property. * * @param value * allowed object is * {@link Duration } * */ public void setTimeToStopChecking(Duration value) { this.timeToStopChecking = value; } /** * Gets the value of the timeWindowIsRelativeTo property. * * @return * possible object is * {@link String } * */ public String getTimeWindowIsRelativeTo() { if (timeWindowIsRelativeTo == null) { return "timeLastVerifierPassed"; } else { return timeWindowIsRelativeTo; } } /** * Sets the value of the timeWindowIsRelativeTo property. * * @param value * allowed object is * {@link String } * */ public void setTimeWindowIsRelativeTo(String value) { this.timeWindowIsRelativeTo = value; } } /** *

Java class for anonymous complex type. * *

The following schema fragment specifies the expected content contained within this class. * *

     * <complexType>
     *   <complexContent>
     *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
     *       <sequence>
     *         <element name="StartCheck" type="{http://www.omg.org/space/xtce}InputAlgorithmType"/>
     *         <element name="StopTime" type="{http://www.omg.org/space/xtce}InputAlgorithmType"/>
     *       </sequence>
     *     </restriction>
     *   </complexContent>
     * </complexType>
     * 
* * */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "", propOrder = { "startCheck", "stopTime" }) public static class CheckWindowAlgorithms { @XmlElement(name = "StartCheck", required = true) protected InputAlgorithmType startCheck; @XmlElement(name = "StopTime", required = true) protected InputAlgorithmType stopTime; /** * Gets the value of the startCheck property. * * @return * possible object is * {@link InputAlgorithmType } * */ public InputAlgorithmType getStartCheck() { return startCheck; } /** * Sets the value of the startCheck property. * * @param value * allowed object is * {@link InputAlgorithmType } * */ public void setStartCheck(InputAlgorithmType value) { this.startCheck = value; } /** * Gets the value of the stopTime property. * * @return * possible object is * {@link InputAlgorithmType } * */ public InputAlgorithmType getStopTime() { return stopTime; } /** * Sets the value of the stopTime property. * * @param value * allowed object is * {@link InputAlgorithmType } * */ public void setStopTime(InputAlgorithmType value) { this.stopTime = value; } } /** *

Java class for anonymous complex type. * *

The following schema fragment specifies the expected content contained within this class. * *

     * <complexType>
     *   <complexContent>
     *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
     *       <sequence>
     *         <element name="Comparison" type="{http://www.omg.org/space/xtce}ComparisonType" maxOccurs="unbounded"/>
     *       </sequence>
     *     </restriction>
     *   </complexContent>
     * </complexType>
     * 
* * */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "", propOrder = { "comparison" }) public static class ComparisonList { @XmlElement(name = "Comparison", required = true) protected List comparison; /** * Gets the value of the comparison 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 comparison property. * *

* For example, to add a new item, do as follows: *

         *    getComparison().add(newItem);
         * 
* * *

* Objects of the following type(s) are allowed in the list * {@link ComparisonType } * * */ public List getComparison() { if (comparison == null) { comparison = new ArrayList(); } return this.comparison; } } /** *

Java class for anonymous complex type. * *

The following schema fragment specifies the expected content contained within this class. * *

     * <complexType>
     *   <complexContent>
     *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
     *       <sequence>
     *         <element name="ParameterRef" type="{http://www.omg.org/space/xtce}ParameterRefType"/>
     *         <element name="Change">
     *           <complexType>
     *             <complexContent>
     *               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
     *                 <attribute name="value" use="required" type="{http://www.w3.org/2001/XMLSchema}decimal" />
     *               </restriction>
     *             </complexContent>
     *           </complexType>
     *         </element>
     *       </sequence>
     *     </restriction>
     *   </complexContent>
     * </complexType>
     * 
* * */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "", propOrder = { "parameterRef", "change" }) public static class ParameterValueChange { @XmlElement(name = "ParameterRef", required = true) protected ParameterRefType parameterRef; @XmlElement(name = "Change", required = true) protected CommandVerifierType.ParameterValueChange.Change change; /** * Gets the value of the parameterRef property. * * @return * possible object is * {@link ParameterRefType } * */ public ParameterRefType getParameterRef() { return parameterRef; } /** * Sets the value of the parameterRef property. * * @param value * allowed object is * {@link ParameterRefType } * */ public void setParameterRef(ParameterRefType value) { this.parameterRef = value; } /** * Gets the value of the change property. * * @return * possible object is * {@link CommandVerifierType.ParameterValueChange.Change } * */ public CommandVerifierType.ParameterValueChange.Change getChange() { return change; } /** * Sets the value of the change property. * * @param value * allowed object is * {@link CommandVerifierType.ParameterValueChange.Change } * */ public void setChange(CommandVerifierType.ParameterValueChange.Change value) { this.change = value; } /** *

Java class for anonymous complex type. * *

The following schema fragment specifies the expected content contained within this class. * *

         * <complexType>
         *   <complexContent>
         *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
         *       <attribute name="value" use="required" type="{http://www.w3.org/2001/XMLSchema}decimal" />
         *     </restriction>
         *   </complexContent>
         * </complexType>
         * 
* * */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "") public static class Change { @XmlAttribute(name = "value", required = true) protected BigDecimal value; /** * Gets the value of the value property. * * @return * possible object is * {@link BigDecimal } * */ public BigDecimal getValue() { return value; } /** * Sets the value of the value property. * * @param value * allowed object is * {@link BigDecimal } * */ public void setValue(BigDecimal value) { this.value = value; } } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy