org.omg.space.xtce.schema.doc.SpaceSystemV1.2-27Feb2014-mods_CommandVerifierType.html 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



	
		SpaceSystemV1.2-27Feb2014-mods - CommandVerifierType
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
	
	
		
			 
			complexType 
			CommandVerifierType
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					extension of xtce:OptionalNameDescriptionType
				
				
					properties
					base  xtce:OptionalNameDescriptionType
				
				
					children
					xtce:LongDescription xtce:AliasSet xtce:AncillaryDataSet xtce:ComparisonList xtce:ContainerRef xtce:ParameterValueChange xtce:CustomAlgorithm xtce:BooleanExpression xtce:Comparison xtce:CheckWindow xtce:CheckWindowAlgorithms
				
				
					used by
					elements  MetaCommandType/VerifierSet/AcceptedVerifier MetaCommandType/VerifierSet/CompleteVerifier MetaCommandType/VerifierSet/ExecutionVerifier MetaCommandType/VerifierSet/FailedVerifier MetaCommandType/VerifierSet/QueuedVerifier MetaCommandType/VerifierSet/ReceivedVerifier MetaCommandType/VerifierSet/SentFromRangeVerifier MetaCommandType/VerifierSet/TransferredToRangeVerifier
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
shortDescription   string   optional         documentation
It is strongly recommended that the short description be kept under 80 characters in length
name   xtce:NameType   optional          
				
				
					annotation
					documentation
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.
				
				
					source
					<complexType name="CommandVerifierType">

  <annotation>

    <documentation xml:lang="en">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.</documentation>

  </annotation>

  <complexContent>

    <extension base="xtce:OptionalNameDescriptionType">

      <sequence>

        <choice>

          <element name="ComparisonList">

            <annotation>

              <documentation xml:lang="en">All comparisons must be true</documentation>

            </annotation>

            <complexType>

              <sequence>

                <element name="Comparison" type="xtce:ComparisonType" maxOccurs="unbounded"/>

              </sequence>

            </complexType>

          </element>

          <element name="ContainerRef" type="xtce:ContainerRefType">

            <annotation>

              <documentation xml:lang="en">When verification is a new instance of the referenced Container; this verifier return true when the referenced container has been received and processed.</documentation>

            </annotation>

          </element>

          <element name="ParameterValueChange">

            <annotation>

              <documentation xml:lang="en">Used to look for relative change in a Parameter value.  Only useful for numeric Parameters</documentation>

            </annotation>

            <complexType>

              <sequence>

                <element name="ParameterRef" type="xtce:ParameterRefType"/>

                <element name="Change">

                  <complexType>

                    <attribute name="value" type="decimal" use="required"/>

                  </complexType>

                </element>

              </sequence>

            </complexType>

          </element>

          <element name="CustomAlgorithm" type="xtce:InputAlgorithmType"/>

          <element name="BooleanExpression" type="xtce:BooleanExpressionType"/>

          <element name="Comparison" type="xtce:ComparisonType"/>

        </choice>

        <choice>

          <element name="CheckWindow">

            <complexType>

              <attribute name="timeToStartChecking" type="xtce:RelativeTimeType"/>

              <attribute name="timeToStopChecking" type="xtce:RelativeTimeType" use="required"/>

              <attribute name="timeWindowIsRelativeTo" default="timeLastVerifierPassed">

                <simpleType>

                  <restriction base="string">

                    <enumeration value="commandRelease"/>

                    <enumeration value="timeLastVerifierPassed"/>

                  </restriction>

                </simpleType>

              </attribute>

            </complexType>

          </element>

          <element name="CheckWindowAlgorithms">

            <annotation>

              <documentation xml:lang="en">Used when times must be calculated</documentation>

            </annotation>

            <complexType>

              <sequence>

                <element name="StartCheck" type="xtce:InputAlgorithmType"/>

                <element name="StopTime" type="xtce:InputAlgorithmType"/>

              </sequence>

            </complexType>

          </element>

        </choice>

      </sequence>

    </extension>

  </complexContent>

</complexType>
				
			
			

			 
			element 
			CommandVerifierType/ComparisonList
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					properties
					content  complex
				
				
					children
					xtce:Comparison
				
				
					annotation
					documentation
All comparisons must be true
				
				
					source
					<element name="ComparisonList">

  <annotation>

    <documentation xml:lang="en">All comparisons must be true</documentation>

  </annotation>

  <complexType>

    <sequence>

      <element name="Comparison" type="xtce:ComparisonType" maxOccurs="unbounded"/>

    </sequence>

  </complexType>

</element>
				
			
			

			 
			element 
			CommandVerifierType/ComparisonList/Comparison
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:ComparisonType
				
				
					properties
					minOcc  1
maxOcc  unbounded
content  complex
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
parameterRef   xtce:NameReferenceType   required          
instance   integer      0       
useCalibratedValue   boolean      true       
comparisonOperator   xtce:ComparisonOperatorsType      ==       
value   string   required          
				
				
					source
					<element name="Comparison" type="xtce:ComparisonType" maxOccurs="unbounded"/>
				
			
			

			 
			element 
			CommandVerifierType/ContainerRef
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:ContainerRefType
				
				
					properties
					content  complex
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
containerRef   xtce:NameReferenceType   required         documentation
name of container
				
				
					annotation
					documentation
When verification is a new instance of the referenced Container; this verifier return true when the referenced container has been received and processed.
				
				
					source
					<element name="ContainerRef" type="xtce:ContainerRefType">

  <annotation>

    <documentation xml:lang="en">When verification is a new instance of the referenced Container; this verifier return true when the referenced container has been received and processed.</documentation>

  </annotation>

</element>
				
			
			

			 
			element 
			CommandVerifierType/ParameterValueChange
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					properties
					content  complex
				
				
					children
					xtce:ParameterRef xtce:Change
				
				
					annotation
					documentation
Used to look for relative change in a Parameter value.  Only useful for numeric Parameters
				
				
					source
					<element name="ParameterValueChange">

  <annotation>

    <documentation xml:lang="en">Used to look for relative change in a Parameter value.  Only useful for numeric Parameters</documentation>

  </annotation>

  <complexType>

    <sequence>

      <element name="ParameterRef" type="xtce:ParameterRefType"/>

      <element name="Change">

        <complexType>

          <attribute name="value" type="decimal" use="required"/>

        </complexType>

      </element>

    </sequence>

  </complexType>

</element>
				
			
			

			 
			element 
			CommandVerifierType/ParameterValueChange/ParameterRef
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:ParameterRefType
				
				
					properties
					content  complex
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
parameterRef   xtce:NameReferenceType   required          
				
				
					source
					<element name="ParameterRef" type="xtce:ParameterRefType"/>
				
			
			

			 
			element 
			CommandVerifierType/ParameterValueChange/Change
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					properties
					content  complex
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
value   decimal   required          
				
				
					source
					<element name="Change">

  <complexType>

    <attribute name="value" type="decimal" use="required"/>

  </complexType>

</element>
				
			
			

			 
			attribute 
			CommandVerifierType/ParameterValueChange/Change/@value
			
				
					type
					decimal
				
				
					properties
					use  required
				
				
					source
					<attribute name="value" type="decimal" use="required"/>
				
			
			

			 
			element 
			CommandVerifierType/CustomAlgorithm
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:InputAlgorithmType
				
				
					properties
					content  complex
				
				
					children
					xtce:LongDescription xtce:AliasSet xtce:AncillaryDataSet xtce:AlgorithmText xtce:ExternalAlgorithmSet xtce:InputSet
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
shortDescription   string   optional         documentation
It is strongly recommended that the short description be kept under 80 characters in length
name   xtce:NameType   required          
				
				
					source
					<element name="CustomAlgorithm" type="xtce:InputAlgorithmType"/>
				
			
			

			 
			element 
			CommandVerifierType/BooleanExpression
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:BooleanExpressionType
				
				
					properties
					content  complex
				
				
					children
					xtce:Condition xtce:ANDedConditions xtce:ORedConditions
				
				
					source
					<element name="BooleanExpression" type="xtce:BooleanExpressionType"/>
				
			
			

			 
			element 
			CommandVerifierType/Comparison
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:ComparisonType
				
				
					properties
					content  complex
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
parameterRef   xtce:NameReferenceType   required          
instance   integer      0       
useCalibratedValue   boolean      true       
comparisonOperator   xtce:ComparisonOperatorsType      ==       
value   string   required          
				
				
					source
					<element name="Comparison" type="xtce:ComparisonType"/>
				
			
			

			 
			element 
			CommandVerifierType/CheckWindow
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					properties
					content  complex
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
timeToStartChecking   xtce:RelativeTimeType             
timeToStopChecking   xtce:RelativeTimeType   required          
timeWindowIsRelativeTo   derived by: string      timeLastVerifierPassed       
				
				
					source
					<element name="CheckWindow">

  <complexType>

    <attribute name="timeToStartChecking" type="xtce:RelativeTimeType"/>

    <attribute name="timeToStopChecking" type="xtce:RelativeTimeType" use="required"/>

    <attribute name="timeWindowIsRelativeTo" default="timeLastVerifierPassed">

      <simpleType>

        <restriction base="string">

          <enumeration value="commandRelease"/>

          <enumeration value="timeLastVerifierPassed"/>

        </restriction>

      </simpleType>

    </attribute>

  </complexType>

</element>
				
			
			

			 
			attribute 
			CommandVerifierType/CheckWindow/@timeToStartChecking
			
				
					type
					xtce:RelativeTimeType
				
				
					source
					<attribute name="timeToStartChecking" type="xtce:RelativeTimeType"/>
				
			
			

			 
			attribute 
			CommandVerifierType/CheckWindow/@timeToStopChecking
			
				
					type
					xtce:RelativeTimeType
				
				
					properties
					use  required
				
				
					source
					<attribute name="timeToStopChecking" type="xtce:RelativeTimeType" use="required"/>
				
			
			

			 
			attribute 
			CommandVerifierType/CheckWindow/@timeWindowIsRelativeTo
			
				
					type
					restriction of string
				
				
					properties
					default  timeLastVerifierPassed
				
				
					facets
					Kind  Value  Annotation
enumeration  commandRelease  
enumeration  timeLastVerifierPassed  
				
				
					source
					<attribute name="timeWindowIsRelativeTo" default="timeLastVerifierPassed">

  <simpleType>

    <restriction base="string">

      <enumeration value="commandRelease"/>

      <enumeration value="timeLastVerifierPassed"/>

    </restriction>

  </simpleType>

</attribute>
				
			
			

			 
			element 
			CommandVerifierType/CheckWindowAlgorithms
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					properties
					content  complex
				
				
					children
					xtce:StartCheck xtce:StopTime
				
				
					annotation
					documentation
Used when times must be calculated
				
				
					source
					<element name="CheckWindowAlgorithms">

  <annotation>

    <documentation xml:lang="en">Used when times must be calculated</documentation>

  </annotation>

  <complexType>

    <sequence>

      <element name="StartCheck" type="xtce:InputAlgorithmType"/>

      <element name="StopTime" type="xtce:InputAlgorithmType"/>

    </sequence>

  </complexType>

</element>
				
			
			

			 
			element 
			CommandVerifierType/CheckWindowAlgorithms/StartCheck
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:InputAlgorithmType
				
				
					properties
					content  complex
				
				
					children
					xtce:LongDescription xtce:AliasSet xtce:AncillaryDataSet xtce:AlgorithmText xtce:ExternalAlgorithmSet xtce:InputSet
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
shortDescription   string   optional         documentation
It is strongly recommended that the short description be kept under 80 characters in length
name   xtce:NameType   required          
				
				
					source
					<element name="StartCheck" type="xtce:InputAlgorithmType"/>
				
			
			

			 
			element 
			CommandVerifierType/CheckWindowAlgorithms/StopTime
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:InputAlgorithmType
				
				
					properties
					content  complex
				
				
					children
					xtce:LongDescription xtce:AliasSet xtce:AncillaryDataSet xtce:AlgorithmText xtce:ExternalAlgorithmSet xtce:InputSet
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
shortDescription   string   optional         documentation
It is strongly recommended that the short description be kept under 80 characters in length
name   xtce:NameType   required          
				
				
					source
					<element name="StopTime" type="xtce:InputAlgorithmType"/>
				
			
			

			

			XML Schema documentation generated by 
			
				XMLSpy
			
			 Schema Editor 
			
				http://www.altova.com/xmlspy
type	xtce:RelativeTimeType
source	<attribute name="timeToStartChecking" type="xtce:RelativeTimeType"/>