modspec 0.1.0 → 0.1.2

data/spec/conformance_class.liquid

@@ -0,0 +1,98 @@
+{% assign count = 0 %}
+{% for scope in group.scopes %}
+{% assign count = count | plus: 1 %}
+[[cc-{{prefix}}-{{count}}]]
+.{{scope.name}}
+[conformance_class]
+====
+[%metadata]
+identifier:: {{scope.identifier}}
+description::
++
+--
+{{scope.description}}
+--
+
+target:: {{scope.target}}
+
+{% for depend in {{scope.dependencies}} %}
+inherit:: {{depend}}
+{% endfor %}
+
+{% for test in {{scope.tests}} %}
+conformance-test:: {{test.identifier}}
+{% endfor %}
+
+{% if {{scope.guidance}} %}
+guidance::
++
+--
+{% for rec in {{scope.guidance}} %}
+* {{rec}}
+{% endfor %}
+--
+{% endif %}
+
+{% if {{scope.clause}} %}
+Clause::
++
+--
+{{scope.clause}}
+--
+{% endif %}
+====
+
+{% for test in {{scope.tests}} %}
+{% if {{test.name}} %}
+.{{test.name}}
+{% endif %}
+[conformance_test]
+====
+[%metadata]
+identifier:: {{test.identifier}}
+description::
++
+--
+{{test.description}}
+--
+
+{% for target in {{test.targets}} %}
+target:: {{target}}
+
+{% endfor %}
+
+{% for depend in {{test.dependencies}} %}
+inherit:: {{depend}}
+{% endfor %}
+
+{% if {{test.guidance}} %}
+guidance::
++
+--
+{% for rec in {{test.guidance}} %}
+* {{rec}}
+{% endfor %}
+--
+{% endif %}
+
+
+{% if {{test.purpose}} %}
+test-purpose:: {{test.purpose}}
+{% endif %}
+
+{% if {{test.method}} %}
+test-method::
++
+--
+{{test.method}}
+--
+{% endif %}
+
+{% if {{test.type}} %}
+Test type:: {{test.type}}
+{% endif %}
+====
+
+{% endfor %}
+
+{% endfor %}

data/spec/fixtures/advanced-cc.yaml

@@ -0,0 +1,52 @@
+---
+conformance_classes:
+- name: Basic-YPR logical model SDU conformance
+  identifier: /conf/advanced
+  target:
+  - /req/advanced
+  classification: "Target Type: SDU"
+  description: |
+    To confirm that an implementation of the Advanced GeoPose conforms to
+    the Logical Model.
+  dependencies:
+  - /conf/global
+  - /conf/frame-spec
+  - /conf/time
+
+  tests:
+  - name: Verify expression of valid time as GeoPose_Instant
+    identifier: /conf/advanced/valid-time
+    targets:
+    - /req/advanced/valid-time
+    dependencies:
+    - /conf/time/instant
+    description: |
+      To confirm the correct properties of a GeoPose_Instant.
+    purpose: |
+      Confirm that the `Advanced.validTime` attribute is represented by a
+      `GeoPose_Instant` object.
+    method: Inspection
+
+  - name: Verify expression of outer frame
+    identifier: /conf/advanced/frame-spec
+    targets:
+    - /req/advanced/frame-spec
+    description: |
+      To confirm that an implementation of an Advanced SDU contains an explicit
+      frame specification in frameSpecification using the `ExplicitFrameSpec`
+      object.
+    purpose: |
+      Verify that this requirement is satisfied.
+    method: Inspection
+
+  - name: Verify expression of inner frame
+    identifier: /conf/advanced/quaternion
+    targets:
+    - /req/advanced/quaternion
+    description: |
+      To confirm that the unit quaternion consists of four representations of
+      real number values and that the square root of the sum of the squares of
+      those numbers is approximately 1.
+    purpose: |
+      To confirm the correct properties of a quaternion.
+    method: Inspection

data/spec/fixtures/advanced-json-cc.yaml

@@ -0,0 +1,24 @@
+---
+conformance_classes:
+- name: JSON encoding of Advanced SDU
+  identifier: /conf/advanced-encoding-json
+  target:
+  - /req/advanced-encoding-json
+  classification: "Target Type: JSON SDU"
+  description: |
+    Confirm that a JSON-encoded Advanced GeoPose conforms to the
+    relevant elements of the Logical Model and a corresponding JSON-Schema
+    document.
+
+  tests:
+  - name: Verify conformance via JSON schema
+    identifier: /conf/advanced-encoding-json/definition
+    targets:
+    - /req/advanced-encoding-json/definition
+    description: |
+      To confirm that a Advanced GeoPose in JSON validates against the JSON schema.
+    purpose: |
+      Verify that data validates against the corresponding JSON schema.
+    method: |
+      Validate the JSON data against the Advanced JSON-Schema 2019-9 definition
+      (<<advanced_geopose_json_schema>>).

data/spec/fixtures/advanced-json-rc.yaml

@@ -0,0 +1,16 @@
+---
+normative_statements_classes:
+- name: JSON encoding of Advanced SDU
+  identifier: /req/advanced-encoding-json
+  description: |
+    Requirements for the JSON encoding of a Advanced SDU.
+  implements:
+  - /req/advanced
+
+  normative_statements:
+
+  - name: Specification as JSON schema
+    identifier: /req/advanced-encoding-json/definition
+    statement: |
+      A JSON-encoded Advanced GeoPose SHALL conform to the
+      Advanced JSON-Schema 2019-9 definition (<<advanced_geopose_json_schema>>).

data/spec/fixtures/advanced-rc.yaml

@@ -0,0 +1,43 @@
+---
+normative_statements_classes:
+- name: Advanced logical model SDU
+  identifier: /req/advanced
+  description: |
+    The Advanced Target has a more general structure than Basic-YPR and
+    Basic-Quaternion, supporting flexible specification of Outer Frame and a
+    Valid Time.
+
+  dependencies:
+  - /req/global
+  - /req/frame-spec
+  - /req/time
+  normative_statements:
+
+  - name: Expression of valid time as GeoPose_Instant
+    identifier: /req/advanced/valid-time
+    dependencies:
+    - /req/time/instant
+
+    statement: |
+      The `Advanced.validTime` attribute shall be represented by a
+      `GeoPose_Instant` object.
+
+  - name: Expression of outer frame
+    identifier: /req/advanced/frame-spec
+    dependencies:
+    - /req/frame-spec
+    statement: |
+      The `Advanced.frameSpecification` attribute shall represent an explicit
+      frame specification with the `ExplicitFrameSpec` object.
+
+  - name: Expression of inner frame
+    identifier: /req/advanced/quaternion
+    statement: |
+      The `Advanced.quaternion` attribute shall contain a quaternion expressed
+      using the UnitQuaternion datatype value expressed as four real numbers,
+      representing four quaternion components w, x, y, z, in that sequential
+      order. The sum of the squares of the individual components SHALL be as
+      close to 1.0 as the real number representation allows. The quaternion
+      SHALL be applied to an initial reference frame oriented East-North-Up
+      (ENU) coordinate system where the coordinate axes East, North, and Up
+      correspond to the axes X, Y, Z.

data/spec/fixtures/basic-quaternion-cc.yaml

@@ -0,0 +1,44 @@
+---
+conformance_classes:
+- name: Basic-Quaternion logical model SDU conformance
+  identifier: /conf/basic-quaternion
+  target:
+  - /req/basic-quaternion
+  classification: "Target Type: SDU"
+  description: Conformance with Basic-Quaternion logical model SDU
+  dependencies:
+  - /conf/global
+  - /conf/tangent-point
+
+  tests:
+  - name: Verify expression of outer frame
+    identifier: /conf/basic-quaternion/position
+    targets:
+    - /req/basic-quaternion/position
+    description: |
+      To confirm that a Basic-Quaternion GeoPose contains an Outer Frame
+      specified by an implicit WGS-84 CRS and an implicit EPSG 4461-CS (LTP-ENU)
+      coordinate system and explicit parameters defining the tangent point.
+    purpose: |
+      Verify that this requirement is satisfied.
+    method: Inspection
+
+  - name: Verify expression of inner frame
+    identifier: /conf/basic-quaternion/quaternion
+    targets:
+    - /req/basic-quaternion/quaternion
+    description: |
+      To confirm that a Basic-Quaternion GeoPose contains an Inner Frame is a
+      rotation-only transformation using a unit quaternion, which is an instance
+      of a GeoPose Logical Model quaternion data type value that is expressed as
+      four real numbers, representing four quaternion components w, x, y, z, in
+      that sequential order.
+
+      The sum of the squares of the individual components is as close to 1.0 as
+      the real number representation allows. The quaternion is applied to an
+      initial reference frame oriented East-North-Up (ENU) coordinate system
+      where the coordinate axes East, North, and Up correspond to the axes X, Y,
+      Z.
+    purpose: |
+      Verify that this requirement is satisfied.
+    method: Inspection

data/spec/fixtures/basic-quaternion-json-cc.yaml

@@ -0,0 +1,24 @@
+---
+conformance_classes:
+- name: Permissive JSON encoding of Basic-Quaternion SDU
+  identifier: /conf/basic-quaternion-encoding-json
+  target:
+  - /req/basic-quaternion-encoding-json
+  classification: "Target Type: JSON SDU"
+  description: |
+    Confirm that a JSON-encoded Basic-Quaternion GeoPose conforms to the
+    relevant elements of the Logical Model and a corresponding JSON-Schema
+    document.
+
+  tests:
+  - name: Verify conformance via JSON schema
+    identifier: /conf/basic-quaternion-encoding-json/definition
+    targets:
+    - /req/basic-quaternion-encoding-json/definition
+    description: |
+      To confirm that a Basic-Quaternion GeoPose in JSON validates against the JSON schema.
+    purpose: |
+      Verify that data validates against the corresponding JSON schema.
+    method: |
+      Validate the JSON data against the Basic-Quaternion JSON Schema 2019-9 definition
+      (<<basic_quaternion_permissive_json_schema>>).

data/spec/fixtures/basic-quaternion-json-rc.yaml

@@ -0,0 +1,17 @@
+---
+normative_statements_classes:
+- name: Permissive JSON encoding of Basic-Quaternion SDU
+  identifier: /req/basic-quaternion-encoding-json
+  description: |
+    Requirements for the JSON encoding of a Basic-Quaternion SDU.
+  implements:
+  - /req/basic-quaternion
+
+  normative_statements:
+
+  - name: Specification as JSON schema
+    identifier: /req/basic-quaternion-encoding-json/definition
+    statement: |
+      A JSON-encoded Basic-Quaternion GeoPose SHALL conform to the
+      Basic-Quaternion JSON-Schema 2019-9 definition
+      (<<basic_quaternion_permissive_json_schema>>).

data/spec/fixtures/basic-quaternion-json-strict-cc.yaml

@@ -0,0 +1,22 @@
+---
+conformance_classes:
+- name: Strict JSON encoding of Basic-Quaternion SDU
+  identifier: /conf/basic-quaternion-encoding-json-strict
+  target:
+  - /req/basic-quaternion-encoding-json-strict
+  classification: "Target Type: JSON SDU"
+  description: Conformance with the strict JSON encoding of Basic-Quaternion SDU
+
+  tests:
+  - name: Verify conformance via JSON schema
+    identifier: /conf/basic-quaternion-encoding-json-strict/definition
+    targets:
+    - /req/basic-quaternion-encoding-json-strict/definition
+    description: |
+      To confirm that a Basic-Quaternion GeoPose in strict JSON encoding
+      validates against the JSON schema.
+    purpose: |
+      Verify that data validates against the corresponding JSON schema.
+    method: |
+      Validate the JSON data against the strict Basic-Quaternion JSON-Schema 2019-9 definition
+      (<<basic_quaternion_strict_json_schema>>).

data/spec/fixtures/basic-quaternion-json-strict-rc.yaml

@@ -0,0 +1,19 @@
+---
+normative_statements_classes:
+- name: Strict JSON encoding of Basic-Quaternion SDU
+  identifier: /req/basic-quaternion-encoding-json-strict
+  description: |
+    Requirements for the JSON encoding of a Basic-Quaternion SDU in strict mode.
+    The strict encoding does not allow specification of JSON elements outside of
+    the schema.
+  implements:
+  - /req/basic-quaternion
+
+  normative_statements:
+
+  - name: Specification as JSON schema
+    identifier: /req/basic-quaternion-encoding-json-strict/definition
+    statement: |
+      A JSON-encoded Basic-Quaternion GeoPose SHALL conform to the
+      strict Basic-Quaternion JSON-Schema 2019-9 definition
+      (<<basic_quaternion_strict_json_schema>>).

data/spec/fixtures/basic-quaternion-rc.yaml

@@ -0,0 +1,34 @@
+---
+normative_statements_classes:
+- name: Basic-Quaternion logical model SDU
+  identifier: /req/basic-quaternion
+  description: |
+    The Basic-Quaternion Target has a simple structure with no options. Position
+    is specified as a point in an LTP-ENU frame and rotation is specified as a
+    unit quaternion.
+
+  dependencies:
+  - /req/global
+  - /req/tangent-point
+  normative_statements:
+
+  - name: Expression of outer frame
+    identifier: /req/basic-quaternion/position
+    statement: |
+      The `Basic_Quaternion.position` attribute shall represent the outer frame,
+      specified by an implicit WGS-84 CRS and an implicit EPSG 4461-CS (LTP-ENU)
+      coordinate system and explicit parameters to define the tangent point.
+
+  - name: Expression of inner frame
+    identifier: /req/basic-quaternion/quaternion
+    statement: |
+      The `Basic_Quaternion.quaternion` attribute shall represent the inner
+      frame, which shall be a rotation-only transformation using a unit
+      quaternion. The uniq quaternion shall be represented as an instance of a
+      GeoPose Logical Model quaternion data type, expressed as four real
+      numbers, representing four quaternion components w, x, y, z, in that
+      sequential order. The sum of the squares of the individual components
+      shall be as close to 1.0 as the real number representation allows. The
+      quaternion shall be applied to an initial reference frame oriented
+      East-North-Up (ENU) coordinate system where the coordinate axes East,
+      North, and Up correspond to the axes X, Y, Z.

data/spec/fixtures/basic-ypr-cc.yaml

@@ -0,0 +1,39 @@
+---
+conformance_classes:
+- name: Basic-YPR logical model SDU conformance
+  identifier: /conf/basic-ypr
+  target:
+  - /req/basic-ypr
+  classification: "Target Type: SDU"
+  description: Conformance with Basic-YPR logical model SDU
+  dependencies:
+  - /conf/global
+  - /conf/tangent-point
+
+  tests:
+  - name: Verify expression of outer frame
+    identifier: /conf/basic-ypr/position
+    targets:
+    - /req/basic-ypr/position
+    description: |
+      To confirm that an implementation of a Basic-YPR consists of an Outer
+      Frame specified by an implicit WGS-84 CRS and an implicit EPSG 4461-CS
+      (LTP-ENU) coordinate system and explicit parameters to define the tangent
+      point.
+    purpose: |
+      Verify that this requirement is satisfied.
+    method: Inspection
+
+  - name: Verify expression of inner frame
+    identifier: /conf/basic-ypr/angles
+    targets:
+    - /req/basic-ypr/angles
+    description: |
+      To confirm that the Inner Frame is expressed as a rotation-only
+      transformation using Yaw, Pitch, and Roll angles. To confirm that GeoPose
+      YPR angles are expressed as three consecutive rotations about the local
+      axes Z, Y, and X, in that order, corresponding to the conventional Yaw,
+      Pitch, and Roll angles and that the unit of measure is the degree.
+    purpose: |
+      Verify that this requirement is satisfied.
+    method: Inspection

data/spec/fixtures/basic-ypr-json-cc.yaml

@@ -0,0 +1,23 @@
+---
+conformance_classes:
+- name: JSON encoding of Basic-YPR SDU
+  identifier: /conf/basic-ypr-encoding-json
+  target:
+  - /req/basic-ypr-encoding-json
+  classification: "Target Type: JSON SDU"
+  description: |
+    Confirm that a JSON-encoded Basic-YPR GeoPose conforms to the relevant
+    elements of the Logical Model and a corresponding JSON-Schema document.
+
+  tests:
+  - name: Verify conformance via JSON schema
+    identifier: /conf/basic-ypr-encoding-json/definition
+    targets:
+    - /req/basic-ypr-encoding-json/definition
+    description: |
+      To confirm that a Basic-YPR GeoPose in JSON validates against the JSON schema.
+    purpose: |
+      Verify that data validates against the corresponding JSON schema.
+    method: |
+      Validate the JSON data against the Basic-YPR JSON Schema 2019-9 definition
+      (<<basic_ypr_json_schema>>).

data/spec/fixtures/basic-ypr-json-rc.yaml

@@ -0,0 +1,21 @@
+---
+normative_statements_classes:
+- name: JSON encoding of Basic-YPR SDU
+  identifier: /req/basic-ypr-encoding-json
+  description: |
+    Requirements for the JSON encoding of a Basic-YPR SDU.
+  implements:
+  - /req/basic-ypr
+
+  normative_statements:
+
+  - name: Specification as JSON schema
+    identifier: /req/basic-ypr-encoding-json/definition
+    statement: |
+      A JSON-encoded Basic-YPR GeoPose SHALL conform to the Basic-YPR
+      JSON-Schema 2019-9 definition (<<basic_ypr_json_schema>>).
+
+    guidance:
+    - |
+      This JSON encoding is extensible because the JSON-Schema
+      "additionalProperties" property is set to the default value of *true*.

data/spec/fixtures/basic-ypr-rc.yaml

@@ -0,0 +1,32 @@
+---
+normative_statements_classes:
+- name: Basic-YPR logical model SDU
+  identifier: /req/basic-ypr
+  description: |
+    The Basic-YPR Target has a simple structure with no options. Position is
+    specified as a point in an LTP-ENU frame and rotation is specified by yaw,
+    pitch, and roll angles specified in decimal degrees.
+  dependencies:
+  - /req/global
+  - /req/tangent-point
+  normative_statements:
+
+  - name: Expression of outer frame
+    identifier: /req/basic-ypr/position
+    statement: |
+      The `Basic_YPR.position` attribute shall represent the outer frame,
+      specified by an implicit WGS-84 CRS and an implicit EPSG 4461-CS (LTP-ENU)
+      coordinate system and explicit parameters to define the tangent point.
+
+  - name: Expression of inner frame
+    identifier: /req/basic-ypr/angles
+    statement: |
+      The `Basic_YPR.angles` attribute shall represent the inner frame,
+      which is a rotation-only transformation with Yaw, Pitch, and Roll (YPR)
+      angles, which expressed as three consecutive rotations of a
+      reference frame oriented East-North-Up (ENU)
+      coordinate system (where the coordinate axes East, North, and Up
+      correspond to the axes X, Y, Z) about the local (rotated) axes z, y, and
+      x, applied in that order, corresponding to the conventional Yaw, Pitch,
+      and Roll angles. The unit of measure SHALL be the degree and the angles
+      represented as signed real number values.

data/spec/fixtures/chain-cc.yaml

@@ -0,0 +1,50 @@
+---
+conformance_classes:
+- name: Chain logical model SDU conformance
+  identifier: /conf/chain
+  target:
+  - /req/chain
+  classification: "Target Type: SDU"
+  description: To confirm that an implementation of the GeoPose Chain conforms to the Logical Model.
+  dependencies:
+  - /conf/global
+  - /conf/frame-spec
+  - /conf/time
+
+  tests:
+  - name: Verify expression of valid time as GeoPose_Instant
+    identifier: /conf/chain/valid-time
+    targets:
+    - /req/chain/valid-time
+    dependencies:
+    - /conf/time/instant
+    description: |
+      To confirm the correct properties of a GeoPose_Instant.
+    purpose: |
+      Confirm that the `Chain.validTime` attribute is represented by a
+      `GeoPose_Instant` object.
+    method: Inspection
+
+  - name: Verify specification of initial frame
+    identifier: /conf/chain/initial-frame
+    targets:
+    - /req/chain/initial-frame
+    description: |
+      To confirm that an implementation of an Chain SDU contains an initial
+      frame under `Chain.outerFrame`.
+    purpose: |
+      Verify that this requirement is satisfied.
+    method: Inspection
+
+  - name: Verify chain of frame specifications
+    identifier: /conf/chain/frame-chain
+    targets:
+    - /req/chain/frame-chain
+    description: |
+      To confirm that each index value in `Chain.frameChain` is a distinct
+      integer value between 0 and one less than the number of elements in the
+      frameChain property.
+    purpose: |
+      To confirm that an implementation of Chain Index conforms to the Logical Model.
+    method: Inspection
+

data/spec/fixtures/chain-json-cc.yaml

@@ -0,0 +1,24 @@
+---
+conformance_classes:
+- name: JSON encoding of Chain SDU
+  identifier: /conf/chain-encoding-json
+  target:
+  - /req/chain-encoding-json
+  classification: "Target Type: JSON SDU"
+  description: |
+    Confirm that a JSON-encoded GeoPose Chain conforms to the
+    relevant elements of the Logical Model and a corresponding JSON-Schema
+    document.
+
+  tests:
+  - name: Verify conformance via JSON schema
+    identifier: /conf/chain-encoding-json/definition
+    targets:
+    - /req/chain-encoding-json/definition
+    description: |
+      To confirm that a GeoPose Chain in JSON validates against the JSON schema.
+    purpose: |
+      Verify that data validates against the corresponding JSON schema.
+    method: |
+      Validate the JSON data against the GeoPose Chain JSON-Schema 2019-9
+      definition (<<chain_json_schema>>).

data/spec/fixtures/chain-json-rc.yaml

@@ -0,0 +1,20 @@
+---
+normative_statements_classes:
+- name: JSON encoding of Chain SDU
+  identifier: /req/chain-encoding-json
+  description: |
+    Requirements for the JSON encoding of a Chain SDU.
+  implements:
+  - /req/chain
+
+  normative_statements:
+
+  - name: Specification as JSON schema
+    identifier: /req/chain-encoding-json/definition
+    statement: |
+      A JSON-encoded GeoPose Chain SHALL conform to the GeoPose Chain
+      JSON-Schema 2019-9 definition (<<chain_json_schema>>).
+    guidance:
+    - |
+      This JSON encoding is extensible because the JSON-Schema
+      "additionalProperties" property is set to the default value of *true*.

data/spec/fixtures/chain-rc.yaml

@@ -0,0 +1,36 @@
+---
+normative_statements_classes:
+- name: Chain logical model SDU
+  identifier: /req/chain
+  description: |
+    The Chain Target supports relationships between a linear sequence of pose
+    relationships. The first frame in the sequence must be an Outer Frame.
+
+  dependencies:
+  - /req/global
+  - /req/frame-spec
+  - /req/time
+
+  normative_statements:
+
+  - name: Expression of valid time as GeoPose_Instant
+    identifier: /req/chain/valid-time
+    dependencies:
+    - /req/time/instant
+    statement: |
+      The `Chain.validTime` attribute shall be represented by a
+      `GeoPose_Instant` object.
+
+  - name: Specification of initial frame
+    identifier: /req/chain/initial-frame
+    statement: |
+      The `Chain.outerFrame` attribute shall represent the first frame in the
+      sequence with the `ExplicitFrameSpec` object.
+
+  - name: Chain of frame specifications
+    identifier: /req/chain/frame-chain
+    statement: |
+      The `Chain.frameChain` attribute shall represent a list of explicit
+      frame specifications with an array of `ExplicitFrameSpec` objects.
+      Each index value shall be a distinct integer value between 0 and one less
+      than the number of elements in the frameChain property.