org.omg.space.xtce.schema.doc.SpaceSystemV1.2-27Feb2014-mods_AlarmType.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 - AlarmType
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
	
	
		
			 
			complexType 
			AlarmType
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					extension of xtce:OptionalNameDescriptionType
				
				
					properties
					base  xtce:OptionalNameDescriptionType
abstract  true
				
				
					children
					xtce:LongDescription xtce:AliasSet xtce:AncillaryDataSet xtce:AlarmConditions xtce:CustomAlarm
				
				
					used by
					elements  ParameterTypeSetType/BinaryParameterType/ContextAlarmList/ContextAlarm ParameterTypeSetType/BinaryParameterType/DefaultAlarm
complexTypes  BinaryAlarmConditionType BooleanAlarmType EnumerationAlarmType NumericAlarmType StringAlarmType TimeAlarmConditionType TimeAlarmType
				
				
					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          
minViolations   positiveInteger      1      documentation
Number of successive instances that meet the alarm conditions for the Alarm to trigger.
				
				
					annotation
					documentation
Alarms associated with numeric data types
				
				
					source
					<complexType name="AlarmType" abstract="true">

  <annotation>

    <documentation xml:lang="en">Alarms associated with numeric data types</documentation>

  </annotation>

  <complexContent>

    <extension base="xtce:OptionalNameDescriptionType">

      <choice minOccurs="0">

        <element name="AlarmConditions" type="xtce:AlarmConditionsType">

          <annotation>

            <documentation xml:lang="en">A MatchCriteria may be specified for each of the 5 alarm levels.  Each level is optional and the alarm should be the highest level to test true.</documentation>

          </annotation>

        </element>

        <element name="CustomAlarm" type="xtce:InputAlgorithmType">

          <annotation>

            <documentation xml:lang="en">An escape for ridiculously complex alarm conditions.  Will trigger on changes to the  containing Parameter.  </documentation>

          </annotation>

        </element>

      </choice>

      <attribute name="minViolations" type="positiveInteger" default="1">

        <annotation>

          <documentation xml:lang="en">Number of successive instances that meet the alarm conditions for the Alarm to trigger.</documentation>

        </annotation>

      </attribute>

    </extension>

  </complexContent>

</complexType>
				
			
			

			 
			attribute 
			AlarmType/@minViolations
			
				
					type
					positiveInteger
				
				
					properties
					default  1
				
				
					annotation
					documentation
Number of successive instances that meet the alarm conditions for the Alarm to trigger.
				
				
					source
					<attribute name="minViolations" type="positiveInteger" default="1">

  <annotation>

    <documentation xml:lang="en">Number of successive instances that meet the alarm conditions for the Alarm to trigger.</documentation>

  </annotation>

</attribute>
				
			
			

			 
			element 
			AlarmType/AlarmConditions
			
				
					diagram
					
				
				
					namespace
					http://www.omg.org/space/xtce
				
				
					type
					xtce:AlarmConditionsType
				
				
					properties
					content  complex
				
				
					children
					xtce:WatchAlarm xtce:WarningAlarm xtce:DistressAlarm xtce:CriticalAlarm xtce:SevereAlarm
				
				
					annotation
					documentation
A MatchCriteria may be specified for each of the 5 alarm levels.  Each level is optional and the alarm should be the highest level to test true.
				
				
					source
					<element name="AlarmConditions" type="xtce:AlarmConditionsType">

  <annotation>

    <documentation xml:lang="en">A MatchCriteria may be specified for each of the 5 alarm levels.  Each level is optional and the alarm should be the highest level to test true.</documentation>

  </annotation>

</element>
				
			
			

			 
			element 
			AlarmType/CustomAlarm
			
				
					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          
				
				
					annotation
					documentation
An escape for ridiculously complex alarm conditions.  Will trigger on changes to the  containing Parameter.  
				
				
					source
					<element name="CustomAlarm" type="xtce:InputAlgorithmType">

  <annotation>

    <documentation xml:lang="en">An escape for ridiculously complex alarm conditions.  Will trigger on changes to the  containing Parameter.  </documentation>

  </annotation>

</element>
				
			
			

			

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