org.omg.space.xtce.schema.doc.SpaceSystemV1.2-27Feb2014-mods_ParameterSetType.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 - ParameterSetType
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
	
	
		
			 
			complexType 
			ParameterSetType
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					children
					xtce:Parameter xtce:ParameterRef
				
				
					used by
					elements  CommandMetaDataType/ParameterSet TelemetryMetaDataType/ParameterSet
				
				
					annotation
					documentation
Used by both the TelemetryMetaData and the CommandMetaData components each may be built independently.
				
				
					source
					<complexType name="ParameterSetType">

  <annotation>

    <documentation xml:lang="en">Used by both the TelemetryMetaData and the CommandMetaData components each may be built independently.</documentation>

  </annotation>

  <choice maxOccurs="unbounded">

    <element name="Parameter">

      <annotation>

        <appinfo>Need to ensure that the named types actually exist</appinfo>

      </annotation>

      <complexType>

        <complexContent>

          <extension base="xtce:NameDescriptionType">

            <sequence>

              <element name="ParameterProperties" type="xtce:ParameterPropertiesType" minOccurs="0"/>

            </sequence>

            <attribute name="parameterTypeRef" type="xtce:NameReferenceType" use="required"/>

            <attribute name="initialValue" type="string" use="optional">

              <annotation>

                <documentation xml:lang="en">Used to set the initial calibrated values of Parameters.  Will overwrite an initial value defined for the ParameterType.  For integer types base 10 (decimal) form is assumed unless: if proceeded by a 0b or 0B, value is in base two (binary form, if proceeded by a 0o or 0O, values is in base 8 (octal) form, or if proceeded by a 0x or 0X, value is in base 16 (hex) form.  Floating point types may be specified in normal (100.0) or scientific (1.0e2) form.  Time types are specified using the ISO 8601 formats described for XTCE time data types.  Initial values for string types, may include C language style (\n, \t, \", \\, etc.) escape sequences.  Initial values for Array or Aggregate types may not be set.</documentation>

                <appinfo>The value type must match the Parameter type</appinfo>

              </annotation>

            </attribute>

          </extension>

        </complexContent>

      </complexType>

    </element>

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

      <annotation>

        <documentation xml:lang="en">Used to include a Parameter defined in another sub-system in this sub-system.</documentation>

      </annotation>

    </element>

  </choice>

</complexType>
				
			
			

			 
			element 
			ParameterSetType/Parameter
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					extension of xtce:NameDescriptionType
				
				
					properties
					content  complex
				
				
					children
					xtce:LongDescription xtce:AliasSet xtce:AncillaryDataSet xtce:ParameterProperties
				
				
					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          
parameterTypeRef   xtce:NameReferenceType   required          
initialValue   string   optional         documentation
Used to set the initial calibrated values of Parameters.  Will overwrite an initial value defined for the ParameterType.  For integer types base 10 (decimal) form is assumed unless: if proceeded by a 0b or 0B, value is in base two (binary form, if proceeded by a 0o or 0O, values is in base 8 (octal) form, or if proceeded by a 0x or 0X, value is in base 16 (hex) form.  Floating point types may be specified in normal (100.0) or scientific (1.0e2) form.  Time types are specified using the ISO 8601 formats described for XTCE time data types.  Initial values for string types, may include C language style (\n, \t, \", \\, etc.) escape sequences.  Initial values for Array or Aggregate types may not be set.
appinfo
The value type must match the Parameter type
				
				
					annotation
					appinfo
Need to ensure that the named types actually exist
				
				
					source
					<element name="Parameter">

  <annotation>

    <appinfo>Need to ensure that the named types actually exist</appinfo>

  </annotation>

  <complexType>

    <complexContent>

      <extension base="xtce:NameDescriptionType">

        <sequence>

          <element name="ParameterProperties" type="xtce:ParameterPropertiesType" minOccurs="0"/>

        </sequence>

        <attribute name="parameterTypeRef" type="xtce:NameReferenceType" use="required"/>

        <attribute name="initialValue" type="string" use="optional">

          <annotation>

            <documentation xml:lang="en">Used to set the initial calibrated values of Parameters.  Will overwrite an initial value defined for the ParameterType.  For integer types base 10 (decimal) form is assumed unless: if proceeded by a 0b or 0B, value is in base two (binary form, if proceeded by a 0o or 0O, values is in base 8 (octal) form, or if proceeded by a 0x or 0X, value is in base 16 (hex) form.  Floating point types may be specified in normal (100.0) or scientific (1.0e2) form.  Time types are specified using the ISO 8601 formats described for XTCE time data types.  Initial values for string types, may include C language style (\n, \t, \", \\, etc.) escape sequences.  Initial values for Array or Aggregate types may not be set.</documentation>

            <appinfo>The value type must match the Parameter type</appinfo>

          </annotation>

        </attribute>

      </extension>

    </complexContent>

  </complexType>

</element>
				
			
			

			 
			attribute 
			ParameterSetType/Parameter/@parameterTypeRef
			
				
					type
					xtce:NameReferenceType
				
				
					properties
					use  required
				
				
					source
					<attribute name="parameterTypeRef" type="xtce:NameReferenceType" use="required"/>
				
			
			

			 
			attribute 
			ParameterSetType/Parameter/@initialValue
			
				
					type
					string
				
				
					properties
					use  optional
				
				
					annotation
					documentation
Used to set the initial calibrated values of Parameters.  Will overwrite an initial value defined for the ParameterType.  For integer types base 10 (decimal) form is assumed unless: if proceeded by a 0b or 0B, value is in base two (binary form, if proceeded by a 0o or 0O, values is in base 8 (octal) form, or if proceeded by a 0x or 0X, value is in base 16 (hex) form.  Floating point types may be specified in normal (100.0) or scientific (1.0e2) form.  Time types are specified using the ISO 8601 formats described for XTCE time data types.  Initial values for string types, may include C language style (\n, \t, \", \\, etc.) escape sequences.  Initial values for Array or Aggregate types may not be set.
appinfo
The value type must match the Parameter type
				
				
					source
					<attribute name="initialValue" type="string" use="optional">

  <annotation>

    <documentation xml:lang="en">Used to set the initial calibrated values of Parameters.  Will overwrite an initial value defined for the ParameterType.  For integer types base 10 (decimal) form is assumed unless: if proceeded by a 0b or 0B, value is in base two (binary form, if proceeded by a 0o or 0O, values is in base 8 (octal) form, or if proceeded by a 0x or 0X, value is in base 16 (hex) form.  Floating point types may be specified in normal (100.0) or scientific (1.0e2) form.  Time types are specified using the ISO 8601 formats described for XTCE time data types.  Initial values for string types, may include C language style (\n, \t, \", \\, etc.) escape sequences.  Initial values for Array or Aggregate types may not be set.</documentation>

    <appinfo>The value type must match the Parameter type</appinfo>

  </annotation>

</attribute>
				
			
			

			 
			element 
			ParameterSetType/Parameter/ParameterProperties
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:ParameterPropertiesType
				
				
					properties
					minOcc  0
maxOcc  1
content  complex
mixed  false
				
				
					children
					xtce:SystemName xtce:ValidityCondition xtce:PhysicalAddressSet xtce:TimeAssociation
				
				
					attributes
					Name   Type   Use   Default   Fixed   Annotation
dataSource   derived by: string   optional         documentation
A telemetered Parameter is one that will have values in telemetry.  A derived Parameter is one that is calculated, usually be an Algorithm.  A constant Parameter is  one that is used as a constant in the system (e.g. a vehicle id).  A local Parameter is one that is used purely on the ground (e.g. a ground command counter).
readOnly   boolean   optional   false      documentation
A Parameter marked as 'readOnly' true is constant and non-settable
				
				
					source
					<element name="ParameterProperties" type="xtce:ParameterPropertiesType" minOccurs="0"/>
				
			
			

			 
			element 
			ParameterSetType/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          
				
				
					annotation
					documentation
Used to include a Parameter defined in another sub-system in this sub-system.
				
				
					source
					<element name="ParameterRef" type="xtce:ParameterRefType">

  <annotation>

    <documentation xml:lang="en">Used to include a Parameter defined in another sub-system in this sub-system.</documentation>

  </annotation>

</element>
				
			
			

			

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