@aeroswarm/codec 0.0.0-stage → 0.1.9

package/src/config/eurocontroll_version/asterix-spec.xsd

@@ -0,0 +1,343 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ===========================================================================
+  asterix-spec.xsd
+
+  A schema for describing an ASTERIX Category specification.
+
+  IMPORTANT: EUROCONTROL does NOT publish an official ASTERIX XML schema.
+  ASTERIX Categories are published only as free-text PDF documents
+  (SPEC-149 Part 1 + one Part per Category). There is therefore no
+  authoritative XSD to validate against.
+
+  This schema is modelled directly on the structural rules of
+  EUROCONTROL Specification for Surveillance Data Exchange, Part 1
+  (SPEC-149, Ed. 3.0): Data Block / Record / FSPEC / FRN / UAP /
+  Data Item, and the five standard Data Field formats
+  (Fixed, Extended, Repetitive, Compound, Explicit).
+
+  It is intentionally minimal: it constrains the ASTERIX *infrastructure*
+  and leaves item structure open so a Category under development can be
+  filled in incrementally.
+  ===========================================================================
+-->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns="urn:local:asterix:spec:1.0"
+           xmlns:ast="urn:local:asterix:spec:1.0"
+           targetNamespace="urn:local:asterix:spec:1.0"
+           elementFormDefault="qualified"
+           attributeFormDefault="unqualified"
+           version="1.0">
+
+  <!-- =================== simple types =================== -->
+
+  <xs:simpleType name="CategoryNumber">
+    <xs:restriction base="xs:unsignedByte">
+      <xs:minInclusive value="0"/>
+      <xs:maxInclusive value="255"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <xs:simpleType name="BitPosition">
+    <xs:restriction base="xs:positiveInteger">
+      <xs:minInclusive value="1"/>
+      <xs:maxInclusive value="8"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <!-- Item reference, e.g. I094/010, or the two special fields RE / SP -->
+  <xs:simpleType name="ItemRef">
+    <xs:restriction base="xs:string">
+      <xs:pattern value="I[0-9]{3}/[0-9]{3}|RE|SP"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <xs:simpleType name="CategoryStatus">
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="working-draft"/>
+      <xs:enumeration value="released-issue"/>
+      <xs:enumeration value="released-standard"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <xs:simpleType name="SlotStatus">
+    <xs:restriction base="xs:string">
+      <!-- item is fully specified in this file -->
+      <xs:enumeration value="defined"/>
+      <!-- FRN reserved, item structure still TODO -->
+      <xs:enumeration value="placeholder"/>
+      <!-- FRN not allocated; FSPEC bit shall be set to 0 -->
+      <xs:enumeration value="spare"/>
+      <!-- Reserved Expansion Field / Special Purpose Field -->
+      <xs:enumeration value="special"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <xs:simpleType name="Presence">
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="mandatory"/>
+      <xs:enumeration value="optional"/>
+      <xs:enumeration value="unknown"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <xs:simpleType name="Encoding">
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="unsigned"/>
+      <xs:enumeration value="signed"/>          <!-- two's complement -->
+      <xs:enumeration value="octal"/>
+      <xs:enumeration value="hex"/>
+      <xs:enumeration value="ascii"/>
+      <xs:enumeration value="icao6bit"/>        <!-- 6-bit char set, Annex 10 -->
+      <xs:enumeration value="boolean"/>
+      <xs:enumeration value="enumerated"/>
+      <xs:enumeration value="spare"/>
+      <xs:enumeration value="raw"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <!-- =================== metadata =================== -->
+
+  <xs:complexType name="CategoryMetadataType">
+    <xs:sequence>
+      <xs:element name="CategoryNumber" type="CategoryNumber"/>
+      <xs:element name="Name"           type="xs:string"/>
+      <xs:element name="Part"           type="xs:positiveInteger" minOccurs="0"/>
+      <xs:element name="DataSource"     type="xs:string"  minOccurs="0"/>
+      <xs:element name="Purpose"        type="xs:string"  minOccurs="0"/>
+      <!-- SPEC-149 Part 1, 5.2.2: blocking of records into one Data Block -->
+      <xs:element name="BlockingAllowed" type="xs:boolean"/>
+      <xs:element name="Status"          type="CategoryStatus"/>
+      <xs:element name="Note"            type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+  </xs:complexType>
+
+  <xs:complexType name="ReferenceDocumentType">
+    <xs:simpleContent>
+      <xs:extension base="xs:string">
+        <xs:attribute name="id"   type="xs:string" use="required"/>
+        <xs:attribute name="href" type="xs:anyURI"/>
+      </xs:extension>
+    </xs:simpleContent>
+  </xs:complexType>
+
+  <xs:complexType name="ChangeType">
+    <xs:simpleContent>
+      <xs:extension base="xs:string">
+        <xs:attribute name="edition" type="xs:string" use="required"/>
+        <xs:attribute name="date"    type="xs:date"   use="required"/>
+        <xs:attribute name="author"  type="xs:string"/>
+      </xs:extension>
+    </xs:simpleContent>
+  </xs:complexType>
+
+  <xs:complexType name="EditionMetadataType">
+    <xs:sequence>
+      <xs:element name="Edition" type="xs:string"/>
+      <xs:element name="Date"    type="xs:date"/>
+      <xs:element name="ReferenceDocument" type="ReferenceDocumentType"
+                  minOccurs="0" maxOccurs="unbounded"/>
+      <xs:element name="ChangeRecord" minOccurs="0">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element name="Change" type="ChangeType" maxOccurs="unbounded"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+    </xs:sequence>
+  </xs:complexType>
+
+  <!-- =================== FSPEC =================== -->
+  <!--
+    SPEC-149 Part 1, 4.3: the FSPEC is a variable-length bitmap. Bits 8..2 of
+    each octet map to seven consecutive FRNs; bit 1 is the Field Extension
+    Indicator (FX). FX=1 means at least one further FSPEC octet follows.
+  -->
+  <xs:complexType name="FspecType">
+    <xs:sequence>
+      <xs:element name="Note" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <xs:attribute name="maxOctets"      type="xs:positiveInteger" use="required"/>
+    <xs:attribute name="frnsPerOctet"   type="xs:positiveInteger" default="7"/>
+    <xs:attribute name="extensionBit"   type="BitPosition"        default="1"/>
+  </xs:complexType>
+
+  <!-- =================== UAP =================== -->
+
+  <xs:complexType name="UapItemType">
+    <xs:sequence>
+      <xs:element name="Comment" type="xs:string" minOccurs="0"/>
+    </xs:sequence>
+    <xs:attribute name="frn"        type="xs:positiveInteger" use="required"/>
+    <xs:attribute name="fspecOctet" type="xs:positiveInteger" use="required"/>
+    <xs:attribute name="fspecBit"   type="BitPosition"        use="required"/>
+    <xs:attribute name="itemRef"    type="ItemRef"/>
+    <xs:attribute name="status"     type="SlotStatus"         use="required"/>
+    <xs:attribute name="presence"   type="Presence"           default="unknown"/>
+    <!-- length in octets, when known and fixed; omit for variable-length items -->
+    <xs:attribute name="octets"     type="xs:positiveInteger"/>
+  </xs:complexType>
+
+  <xs:complexType name="UapType">
+    <xs:sequence>
+      <xs:element name="UapItem" type="UapItemType" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <!-- SPEC-149 Part 1, 4.3.2: the UAP shall be unique per Category -->
+    <xs:attribute name="name" type="xs:string" default="default"/>
+  </xs:complexType>
+
+  <!-- =================== data field structures =================== -->
+
+  <xs:complexType name="ValueType">
+    <xs:simpleContent>
+      <xs:extension base="xs:string">
+        <xs:attribute name="val" type="xs:integer" use="required"/>
+      </xs:extension>
+    </xs:simpleContent>
+  </xs:complexType>
+
+  <xs:complexType name="FieldType">
+    <xs:sequence>
+      <xs:element name="Value" type="ValueType" minOccurs="0" maxOccurs="unbounded"/>
+      <xs:element name="Note"  type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <xs:attribute name="name"     type="xs:string"  use="required"/>
+    <xs:attribute name="longName" type="xs:string"/>
+    <!-- bit numbering is MSB-first within the data field, per SPEC-149 -->
+    <xs:attribute name="from"     type="xs:positiveInteger" use="required"/>
+    <xs:attribute name="to"       type="xs:positiveInteger" use="required"/>
+    <xs:attribute name="encoding" type="Encoding" default="unsigned"/>
+    <xs:attribute name="lsb"      type="xs:double"/>
+    <xs:attribute name="unit"     type="xs:string"/>
+    <xs:attribute name="fx"       type="xs:boolean" default="false"/>
+  </xs:complexType>
+
+  <xs:complexType name="FixedType">
+    <xs:sequence>
+      <xs:element name="Field" type="FieldType" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <xs:attribute name="octets" type="xs:positiveInteger" use="required"/>
+  </xs:complexType>
+
+  <!-- Extended = variable length with FX-terminated extents -->
+  <xs:complexType name="ExtendedType">
+    <xs:sequence>
+      <xs:element name="Extent" type="FixedType" maxOccurs="unbounded"/>
+    </xs:sequence>
+  </xs:complexType>
+
+  <!-- Repetitive = REP counter octet followed by N identical extents -->
+  <xs:complexType name="RepetitiveType">
+    <xs:sequence>
+      <xs:element name="Extent" type="FixedType"/>
+    </xs:sequence>
+    <xs:attribute name="repOctets" type="xs:positiveInteger" default="1"/>
+  </xs:complexType>
+
+  <!-- Compound = primary subfield bitmap + present subfields, in order -->
+  <xs:complexType name="SubfieldType">
+    <xs:sequence>
+      <xs:choice minOccurs="0">
+        <xs:element name="Fixed"      type="FixedType"/>
+        <xs:element name="Extended"   type="ExtendedType"/>
+        <xs:element name="Repetitive" type="RepetitiveType"/>
+        <xs:element name="Explicit"   type="ExplicitType"/>
+        <xs:element name="Undefined"  type="UndefinedType"/>
+      </xs:choice>
+    </xs:sequence>
+    <xs:attribute name="index" type="xs:positiveInteger" use="required"/>
+    <xs:attribute name="name"  type="xs:string"          use="required"/>
+    <xs:attribute name="longName" type="xs:string"/>
+  </xs:complexType>
+
+  <xs:complexType name="CompoundType">
+    <xs:sequence>
+      <xs:element name="PrimarySubfield" type="ExtendedType"/>
+      <xs:element name="Subfield" type="SubfieldType" maxOccurs="unbounded"/>
+    </xs:sequence>
+  </xs:complexType>
+
+  <!-- Explicit = one length octet, then opaque contents -->
+  <xs:complexType name="ExplicitType">
+    <xs:sequence>
+      <xs:element name="Note" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <xs:attribute name="lengthOctets" type="xs:positiveInteger" default="1"/>
+  </xs:complexType>
+
+  <!--
+    Undefined = the item is allocated but its structure is not yet known.
+    A decoder MUST refuse to parse a record whose FSPEC sets an Undefined
+    item, because item lengths in ASTERIX are not self-describing and the
+    parse would desynchronise.
+  -->
+  <xs:complexType name="UndefinedType">
+    <xs:sequence>
+      <xs:element name="Todo" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <xs:attribute name="reason" type="xs:string"/>
+  </xs:complexType>
+
+  <xs:complexType name="StructureType">
+    <xs:choice>
+      <xs:element name="Fixed"      type="FixedType"/>
+      <xs:element name="Extended"   type="ExtendedType"/>
+      <xs:element name="Repetitive" type="RepetitiveType"/>
+      <xs:element name="Compound"   type="CompoundType"/>
+      <xs:element name="Explicit"   type="ExplicitType"/>
+      <xs:element name="Undefined"  type="UndefinedType"/>
+    </xs:choice>
+  </xs:complexType>
+
+  <!-- =================== data items =================== -->
+
+  <xs:complexType name="DataItemType">
+    <xs:sequence>
+      <xs:element name="Name"       type="xs:string"/>
+      <xs:element name="Definition" type="xs:string" minOccurs="0"/>
+      <xs:element name="Format"     type="xs:string" minOccurs="0"/>
+      <xs:element name="Structure"  type="StructureType"/>
+      <xs:element name="EncodingRule" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+      <xs:element name="Note"         type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <xs:attribute name="ref"      type="ItemRef"  use="required"/>
+    <xs:attribute name="presence" type="Presence" default="unknown"/>
+    <xs:attribute name="status"   type="SlotStatus" use="required"/>
+  </xs:complexType>
+
+  <xs:complexType name="DataItemsType">
+    <xs:sequence>
+      <xs:element name="DataItem" type="DataItemType" maxOccurs="unbounded"/>
+    </xs:sequence>
+  </xs:complexType>
+
+  <!-- =================== document root =================== -->
+
+  <xs:element name="AsterixCategory">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="CategoryMetadata" type="CategoryMetadataType"/>
+        <xs:element name="EditionMetadata"  type="EditionMetadataType"/>
+        <xs:element name="Fspec"            type="FspecType"/>
+        <xs:element name="UAP"              type="UapType"/>
+        <xs:element name="DataItems"        type="DataItemsType"/>
+      </xs:sequence>
+    </xs:complexType>
+
+    <!-- every UAP slot that names an item must resolve to a DataItem -->
+    <xs:key name="DataItemKey">
+      <xs:selector xpath="ast:DataItems/ast:DataItem"/>
+      <xs:field xpath="@ref"/>
+    </xs:key>
+    <xs:keyref name="UapItemRef" refer="DataItemKey">
+      <xs:selector xpath="ast:UAP/ast:UapItem"/>
+      <xs:field xpath="@itemRef"/>
+    </xs:keyref>
+    <!-- FRNs must be unique within the UAP -->
+    <xs:unique name="UniqueFrn">
+      <xs:selector xpath="ast:UAP/ast:UapItem"/>
+      <xs:field xpath="@frn"/>
+    </xs:unique>
+  </xs:element>
+
+</xs:schema>