org.omg.space.xtce.schema.doc.SpaceSystemV1.2-27Feb2014-mods_BaseTimeDataType.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 - BaseTimeDataType
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
	
	
		
			 
			complexType 
			BaseTimeDataType
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					extension of xtce:NameDescriptionType
				
				
					properties
					base  xtce:NameDescriptionType
abstract  true
				
				
					children
					xtce:LongDescription xtce:AliasSet xtce:AncillaryDataSet xtce:Encoding xtce:ReferenceTime
				
				
					used by
					complexTypes  AbsoluteTimeDataType RelativeTimeDataType
				
				
					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          
				
				
					annotation
					documentation
An abstract type used by within the schema to describe derive other data types by the ground system.  
				
				
					source
					<complexType name="BaseTimeDataType" abstract="true">

  <annotation>

    <documentation xml:lang="en">An abstract type used by within the schema to describe derive other data types by the ground system.  </documentation>

  </annotation>

  <complexContent>

    <extension base="xtce:NameDescriptionType">

      <sequence>

        <sequence minOccurs="0">

          <element name="Encoding">

            <annotation>

              <documentation xml:lang="en">Scale and offset are used in a y =mx +b type relationship (m is the scale and b is the offset) to make adjustments to the encoded value to that it matches the time units.  Binary Encoded time is typically used with a user supplied transform algorithm to convert time data formats that are too difficult to describe in XTCE.</documentation>

            </annotation>

            <complexType>

              <choice>

                <element name="BinaryDataEncoding" type="xtce:BinaryDataEncodingType"/>

                <element name="FloatDataEncoding" type="xtce:FloatDataEncodingType"/>

                <element name="IntegerDataEncoding" type="xtce:IntegerDataEncodingType"/>

                <element name="StringDataEncoding" type="xtce:StringDataEncodingType"/>

              </choice>

              <attribute name="units" type="xtce:TimeUnits" default="seconds"/>

              <attribute name="scale" type="double" default="1"/>

              <attribute name="offset" type="double" default="0"/>

            </complexType>

          </element>

        </sequence>

        <sequence minOccurs="0">

          <element name="ReferenceTime" type="xtce:ReferenceTimeType"/>

        </sequence>

      </sequence>

    </extension>

  </complexContent>

</complexType>
				
			
			

			 
			element 
			BaseTimeDataType/Encoding
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					properties
					content  complex
				
				
					children
					xtce:BinaryDataEncoding xtce:FloatDataEncoding xtce:IntegerDataEncoding xtce:StringDataEncoding
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
units   xtce:TimeUnits      seconds       
scale   double      1       
offset   double      0       
				
				
					annotation
					documentation
Scale and offset are used in a y =mx +b type relationship (m is the scale and b is the offset) to make adjustments to the encoded value to that it matches the time units.  Binary Encoded time is typically used with a user supplied transform algorithm to convert time data formats that are too difficult to describe in XTCE.
				
				
					source
					<element name="Encoding">

  <annotation>

    <documentation xml:lang="en">Scale and offset are used in a y =mx +b type relationship (m is the scale and b is the offset) to make adjustments to the encoded value to that it matches the time units.  Binary Encoded time is typically used with a user supplied transform algorithm to convert time data formats that are too difficult to describe in XTCE.</documentation>

  </annotation>

  <complexType>

    <choice>

      <element name="BinaryDataEncoding" type="xtce:BinaryDataEncodingType"/>

      <element name="FloatDataEncoding" type="xtce:FloatDataEncodingType"/>

      <element name="IntegerDataEncoding" type="xtce:IntegerDataEncodingType"/>

      <element name="StringDataEncoding" type="xtce:StringDataEncodingType"/>

    </choice>

    <attribute name="units" type="xtce:TimeUnits" default="seconds"/>

    <attribute name="scale" type="double" default="1"/>

    <attribute name="offset" type="double" default="0"/>

  </complexType>

</element>
				
			
			

			 
			attribute 
			BaseTimeDataType/Encoding/@units
			
				
					type
					xtce:TimeUnits
				
				
					properties
					default  seconds
				
				
					facets
					Kind  Value  Annotation
enumeration  seconds  
enumeration  picoSeconds  
enumeration  days  
enumeration  months  
enumeration  years  
				
				
					source
					<attribute name="units" type="xtce:TimeUnits" default="seconds"/>
				
			
			

			 
			attribute 
			BaseTimeDataType/Encoding/@scale
			
				
					type
					double
				
				
					properties
					default  1
				
				
					source
					<attribute name="scale" type="double" default="1"/>
				
			
			

			 
			attribute 
			BaseTimeDataType/Encoding/@offset
			
				
					type
					double
				
				
					properties
					default  0
				
				
					source
					<attribute name="offset" type="double" default="0"/>
				
			
			

			 
			element 
			BaseTimeDataType/Encoding/BinaryDataEncoding
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:BinaryDataEncodingType
				
				
					properties
					content  complex
				
				
					children
					xtce:ErrorDetectCorrect xtce:ByteOrderList xtce:SizeInBits xtce:FromBinaryTransformAlgorithm xtce:ToBinaryTransformAlgorithm
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
bitOrder   derived by: string      mostSignificantBitFirst       
				
				
					source
					<element name="BinaryDataEncoding" type="xtce:BinaryDataEncodingType"/>
				
			
			

			 
			element 
			BaseTimeDataType/Encoding/FloatDataEncoding
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:FloatDataEncodingType
				
				
					properties
					content  complex
				
				
					children
					xtce:ErrorDetectCorrect xtce:ByteOrderList xtce:DefaultCalibrator xtce:ContextCalibratorList
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
bitOrder   derived by: string      mostSignificantBitFirst       
encoding   derived by: string      IEEE754_1985       
sizeInBits   derived by: positiveInteger      32       
changeThreshold   decimal   optional         documentation
A changeThreshold may optionally be specified to inform systems of the minimum change in value that is significant.  This is used by some systems to limit the telemetry processing and/or recording requirements, such as for an analog-to-digital converter that dithers in the least significant bit. If the value is unspecified or zero, any change is significant.
				
				
					source
					<element name="FloatDataEncoding" type="xtce:FloatDataEncodingType"/>
				
			
			

			 
			element 
			BaseTimeDataType/Encoding/IntegerDataEncoding
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:IntegerDataEncodingType
				
				
					properties
					content  complex
				
				
					children
					xtce:ErrorDetectCorrect xtce:ByteOrderList xtce:DefaultCalibrator xtce:ContextCalibratorList
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
bitOrder   derived by: string      mostSignificantBitFirst       
encoding   derived by: string      unsigned       
sizeInBits   positiveInteger      8       
changeThreshold   nonNegativeInteger   optional         documentation
A changeThreshold may optionally be specified to inform systems of the minimum change in value that is significant.  This is used by some systems to limit the telemetry processing and/or recording requirements, such as for an analog-to-digital converter that dithers in the least significant bit. If the value is unspecified or zero, any change is significant.
				
				
					source
					<element name="IntegerDataEncoding" type="xtce:IntegerDataEncodingType"/>
				
			
			

			 
			element 
			BaseTimeDataType/Encoding/StringDataEncoding
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:StringDataEncodingType
				
				
					properties
					content  complex
				
				
					children
					xtce:ErrorDetectCorrect xtce:ByteOrderList xtce:SizeInBits
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
bitOrder   derived by: string      mostSignificantBitFirst       
encoding   derived by: string      UTF-8       
				
				
					source
					<element name="StringDataEncoding" type="xtce:StringDataEncodingType"/>
				
			
			

			 
			element 
			BaseTimeDataType/ReferenceTime
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:ReferenceTimeType
				
				
					properties
					content  complex
				
				
					children
					xtce:OffsetFrom xtce:Epoch
				
				
					source
					<element name="ReferenceTime" type="xtce:ReferenceTimeType"/>
				
			
			

			

			XML Schema documentation generated by 
			
				XMLSpy
			
			 Schema Editor 
			
				http://www.altova.com/xmlspy