org.omg.space.xtce.schema.doc.SpaceSystemV1.2-27Feb2014-mods_NumericAlarmType.html Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xtcetools Show documentation
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.
SpaceSystemV1.2-27Feb2014-mods - NumericAlarmType
complexType
NumericAlarmType
diagram
namespace
http://www.omg.org/space/xtce
type
extension of xtce:AlarmType
properties
base xtce:AlarmType
children
xtce:LongDescription xtce:AliasSet xtce:AncillaryDataSet xtce:AlarmConditions xtce:CustomAlarm xtce:StaticAlarmRanges xtce:ChangeAlarmRanges
used by
elements ParameterTypeSetType/IntegerParameterType/DefaultAlarm ParameterTypeSetType/FloatParameterType/DefaultAlarm complexType NumericContextAlarmType
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="NumericAlarmType">
<annotation>
<documentation xml:lang="en">Alarms associated with numeric data types</documentation>
</annotation>
<complexContent>
<extension base="xtce:AlarmType">
<sequence>
<element name="StaticAlarmRanges" minOccurs="0">
<annotation>
<documentation xml:lang="en">StaticAlarmRanges are used to trigger alarms when the parameter value passes some threshold value. The default inside form, places the unspecified normal range inside all the other ranges, and the range ends of each range point to the infinities. If the form is set to outside, the range ends point to each other and the unspecified normal range is outside all the ranges.</documentation>
</annotation>
<complexType>
<complexContent>
<extension base="xtce:AlarmRangesType">
<attribute name="alarmForm" default="inside">
<simpleType>
<restriction base="string">
<enumeration value="inside"/>
<enumeration value="outside"/>
</restriction>
</simpleType>
</attribute>
</extension>
</complexContent>
</complexType>
</element>
<element name="ChangeAlarmRanges" minOccurs="0">
<annotation>
<documentation xml:lang="en">ChangeAlarmRanges are used to trigger alarms when the parameter value's rate-of-change is either too fast or too slow. The change may be with respect to time (the default) or with respect to samples (delta alarms) - the changeType attribute determines this. The change may also be ether relative (as a percentage change) or absolute as set by the changeBasis attribute. The alarm also requires the spanOfInterest in both samples and seconds to have passed before it is to trigger. For time based rate of change alarms, the time specified in spanOfInterestInSeconds is used to calculate the change. For sample based rate of change alarms, the change is calulated over the number of samples specified in spanOfInterestInSeconds.</documentation>
</annotation>
<complexType>
<complexContent>
<extension base="xtce:AlarmRangesType">
<attribute name="changeType" default="changePerSecond">
<simpleType>
<restriction base="string">
<enumeration value="changePerSecond"/>
<enumeration value="changePerSample"/>
</restriction>
</simpleType>
</attribute>
<attribute name="changeBasis" default="absoluteChange">
<simpleType>
<restriction base="string">
<enumeration value="absoluteChange"/>
<enumeration value="percentageChange"/>
</restriction>
</simpleType>
</attribute>
<attribute name="spanOfInterestInSamples" type="positiveInteger" default="1"/>
<attribute name="spanOfInterestInSeconds" type="decimal" default="0"/>
</extension>
</complexContent>
</complexType>
</element>
</sequence>
</extension>
</complexContent>
</complexType>
element
NumericAlarmType/StaticAlarmRanges
diagram
namespace
http://www.omg.org/space/xtce
type
extension of xtce:AlarmRangesType
properties
minOcc 0 maxOcc 1 content complex
children
xtce:WatchRange xtce:WarningRange xtce:DistressRange xtce:CriticalRange xtce:SevereRange
attributes
Name Type Use Default Fixed Annotation alarmForm derived by: string inside
annotation
documentation StaticAlarmRanges are used to trigger alarms when the parameter value passes some threshold value. The default inside form, places the unspecified normal range inside all the other ranges, and the range ends of each range point to the infinities. If the form is set to outside, the range ends point to each other and the unspecified normal range is outside all the ranges.
source
<element name="StaticAlarmRanges" minOccurs="0">
<annotation>
<documentation xml:lang="en">StaticAlarmRanges are used to trigger alarms when the parameter value passes some threshold value. The default inside form, places the unspecified normal range inside all the other ranges, and the range ends of each range point to the infinities. If the form is set to outside, the range ends point to each other and the unspecified normal range is outside all the ranges.</documentation>
</annotation>
<complexType>
<complexContent>
<extension base="xtce:AlarmRangesType">
<attribute name="alarmForm" default="inside">
<simpleType>
<restriction base="string">
<enumeration value="inside"/>
<enumeration value="outside"/>
</restriction>
</simpleType>
</attribute>
</extension>
</complexContent>
</complexType>
</element>
attribute
NumericAlarmType/StaticAlarmRanges/@alarmForm
type
restriction of string
properties
default inside
facets
Kind Value Annotation enumeration inside enumeration outside
source
<attribute name="alarmForm" default="inside">
<simpleType>
<restriction base="string">
<enumeration value="inside"/>
<enumeration value="outside"/>
</restriction>
</simpleType>
</attribute>
element
NumericAlarmType/ChangeAlarmRanges
diagram
namespace
http://www.omg.org/space/xtce
type
extension of xtce:AlarmRangesType
properties
minOcc 0 maxOcc 1 content complex
children
xtce:WatchRange xtce:WarningRange xtce:DistressRange xtce:CriticalRange xtce:SevereRange
attributes
Name Type Use Default Fixed Annotation changeType derived by: string changePerSecond changeBasis derived by: string absoluteChange spanOfInterestInSamples positiveInteger 1 spanOfInterestInSeconds decimal 0
annotation
documentation ChangeAlarmRanges are used to trigger alarms when the parameter value's rate-of-change is either too fast or too slow. The change may be with respect to time (the default) or with respect to samples (delta alarms) - the changeType attribute determines this. The change may also be ether relative (as a percentage change) or absolute as set by the changeBasis attribute. The alarm also requires the spanOfInterest in both samples and seconds to have passed before it is to trigger. For time based rate of change alarms, the time specified in spanOfInterestInSeconds is used to calculate the change. For sample based rate of change alarms, the change is calulated over the number of samples specified in spanOfInterestInSeconds.
source
<element name="ChangeAlarmRanges" minOccurs="0">
<annotation>
<documentation xml:lang="en">ChangeAlarmRanges are used to trigger alarms when the parameter value's rate-of-change is either too fast or too slow. The change may be with respect to time (the default) or with respect to samples (delta alarms) - the changeType attribute determines this. The change may also be ether relative (as a percentage change) or absolute as set by the changeBasis attribute. The alarm also requires the spanOfInterest in both samples and seconds to have passed before it is to trigger. For time based rate of change alarms, the time specified in spanOfInterestInSeconds is used to calculate the change. For sample based rate of change alarms, the change is calulated over the number of samples specified in spanOfInterestInSeconds.</documentation>
</annotation>
<complexType>
<complexContent>
<extension base="xtce:AlarmRangesType">
<attribute name="changeType" default="changePerSecond">
<simpleType>
<restriction base="string">
<enumeration value="changePerSecond"/>
<enumeration value="changePerSample"/>
</restriction>
</simpleType>
</attribute>
<attribute name="changeBasis" default="absoluteChange">
<simpleType>
<restriction base="string">
<enumeration value="absoluteChange"/>
<enumeration value="percentageChange"/>
</restriction>
</simpleType>
</attribute>
<attribute name="spanOfInterestInSamples" type="positiveInteger" default="1"/>
<attribute name="spanOfInterestInSeconds" type="decimal" default="0"/>
</extension>
</complexContent>
</complexType>
</element>
attribute
NumericAlarmType/ChangeAlarmRanges/@changeType
type
restriction of string
properties
default changePerSecond
facets
Kind Value Annotation enumeration changePerSecond enumeration changePerSample
source
<attribute name="changeType" default="changePerSecond">
<simpleType>
<restriction base="string">
<enumeration value="changePerSecond"/>
<enumeration value="changePerSample"/>
</restriction>
</simpleType>
</attribute>
attribute
NumericAlarmType/ChangeAlarmRanges/@changeBasis
type
restriction of string
properties
default absoluteChange
facets
Kind Value Annotation enumeration absoluteChange enumeration percentageChange
source
<attribute name="changeBasis" default="absoluteChange">
<simpleType>
<restriction base="string">
<enumeration value="absoluteChange"/>
<enumeration value="percentageChange"/>
</restriction>
</simpleType>
</attribute>
attribute
NumericAlarmType/ChangeAlarmRanges/@spanOfInterestInSamples
type
positiveInteger
properties
default 1
source
<attribute name="spanOfInterestInSamples" type="positiveInteger" default="1"/>
attribute
NumericAlarmType/ChangeAlarmRanges/@spanOfInterestInSeconds
type
decimal
properties
default 0
source
<attribute name="spanOfInterestInSeconds" type="decimal" default="0"/>
XML Schema documentation generated by
XMLSpy
Schema Editor
http://www.altova.com/xmlspy