modspec 0.1.0 → 0.1.2

data/spec/fixtures/frame-spec-cc.yaml

@@ -0,0 +1,43 @@
+---
+conformance_classes:
+- name: Frame specification requirements
+  identifier: /conf/frame-spec
+  target:
+  - /req/frame-spec
+  classification: "Target Type: SDU"
+  description: Conformance with frame specification requirements
+
+  tests:
+  - name: Verify frame specification authority uniquely specifies source of reference frame specification
+    identifier: /conf/frame-spec/authority
+    targets:
+    - /req/frame-spec/authority
+    description: |
+      To confirm the correct properties of a Frame Specification Authority.
+    purpose: |
+      To confirm that a FrameSpecification.authority attribute contains a string
+      uniquely specifying a source of reference frame specifications.
+    method: Inspection
+
+  - name: Frame specification ID uniquely defines frame within authority
+    identifier: /conf/frame-spec/id
+    targets:
+    - /req/frame-spec/id
+    description: |
+      To confirm the correct properties of a Frame Specification ID.
+    purpose: |
+      To confirm that a FrameSpecification.id attribute contains a string
+      uniquely specifying the identity of a reference frame specification as
+      defined by that authority.
+    method: Inspection
+
+  - name: Frame specification parameter contains all parameters needed
+    identifier: /conf/frame-spec/parameters
+    targets:
+    - /req/frame-spec/parameters
+    description: |
+      To confirm the correct properties of Frame Specification Parameters.
+    purpose: |
+      To confirm that a FrameSpecification.parameters attribute contains contain
+      all parameters needed for the corresponding authority and ID.
+    method: Inspection

data/spec/fixtures/frame-spec-rc.yaml

@@ -0,0 +1,27 @@
+---
+normative_statements_classes:
+- name: Frame specification requirements
+  identifier: /req/frame-spec
+  description: |
+    Common frame specification requirements for SDUs that include frames.
+  normative_statements:
+
+  - name: Frame specification authority uniquely specifies source of reference frame specification
+    identifier: /req/frame-spec/authority
+    statement: |
+      The FrameSpecification.authority attribute SHALL contain a string uniquely
+      specifying a source of reference frame specifications.
+
+  - name: Frame specification ID uniquely defines frame within authority
+    identifier: /req/frame-spec/id
+    statement: |
+      The FrameSpecification.ID attribute SHALL be a string uniquely defining a
+      frame within the authority.
+
+  - name: Frame specification parameter contains all parameters needed
+    identifier: /req/frame-spec/parameters
+    statement: |
+      The FrameSpecification.parameter attribute SHALL contain all parameters
+      needed for the corresponding authority and ID.
+    guidance:
+    - The definition of these parameters is outside the scope of GeoPose.

data/spec/fixtures/global-cc.yaml

@@ -0,0 +1,38 @@
+---
+conformance_classes:
+- name: Global SDU conformance
+  identifier: /conf/global
+  target:
+  - /req/global
+  classification: "Target Type: SDU"
+  description: Conformance with global SDU requirements
+
+  tests:
+  - name: Verify individual standardization targets are independent
+    identifier: /conf/global/target-independence
+    targets:
+    - /req/global/target-independence
+    purpose: Verify standardization targets are independent.
+    method: Inspection
+
+  - name: Verify implementation conforms to the logical model
+    identifier: /conf/global/logical-model
+    targets:
+    - /req/global/logical-model
+    description: |
+      Implementations of concrete data conforming to this standard SHALL
+      conform to all dependent or inherited classes, attributes, and
+      associations, multiplicities, and data types in the Logical Model.
+    purpose: Verify implementation conforms to the logical model.
+    method: Inspection
+
+  - name: Verify SDU conforms to the "Structural Data Unit - SDU" stereotype
+    identifier: /conf/global/sdu
+    targets:
+    - /req/global/sdu
+    description: |
+      Implementations using encoded SDUs SHALL conform to the logical
+      description of the Logical Model elements with the "Structural Data Unit
+      - SDU" stereotype.
+    purpose: Verify SDU conforms to the "Structural Data Unit - SDU" stereotype.
+    method: Inspection

data/spec/fixtures/global-rc.yaml

@@ -0,0 +1,23 @@
+---
+normative_statements_classes:
+- name: Global SDU requirements
+  identifier: /req/global
+  description: Global requirements apply to all SDUs and Standardization Targets.
+  normative_statements:
+  - name: Individual standardization targets are independent
+    identifier: /req/global/target-independence
+    statement: |
+      There shall be no dependency between or among the individual
+      Standardization Targets.
+  - name: Implementation conforms to the logical model
+    identifier: /req/global/logical-model
+    statement: |
+      Implementations of concrete data conforming to this standard SHALL
+      conform to all dependent or inherited classes, attributes, and
+      associations, multiplicities, and data types in the Logical Model.
+  - name: SDU conforms to the "Structural Data Unit - SDU" stereotype
+    identifier: /req/global/sdu
+    statement: |
+      Implementations using encoded SDUs SHALL conform to the logical
+      description of the Logical Model elements with the
+      "Structural Data Unit - SDU" stereotype.

data/spec/fixtures/graph-cc.yaml

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

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

@@ -0,0 +1,24 @@
+---
+conformance_classes:
+- name: JSON encoding of Graph SDU
+  identifier: /conf/graph-encoding-json
+  target:
+  - /req/graph-encoding-json
+  classification: "Target Type: JSON SDU"
+  description: |
+    Confirm that a JSON-encoded GeoPose Graph conforms to the
+    relevant elements of the Logical Model and a corresponding JSON-Schema
+    document.
+
+  tests:
+  - name: Verify conformance via JSON schema
+    identifier: /conf/graph-encoding-json/definition
+    targets:
+    - /req/graph-encoding-json/definition
+    description: |
+      To confirm that a GeoPose Graph 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 Graph JSON-Schema 2019-9
+      definition (<<graph_json_schema>>).

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

@@ -0,0 +1,20 @@
+---
+normative_statements_classes:
+- name: JSON encoding of Graph SDU
+  identifier: /req/graph-encoding-json
+  description: |
+    Requirements for the JSON encoding of a Graph SDU.
+  implements:
+  - /req/graph
+
+  normative_statements:
+
+  - name: Specification as JSON schema
+    identifier: /req/graph-encoding-json/definition
+    statement: |
+      A JSON-encoded GeoPose Graph SHALL conform to the GeoPose Chain
+      JSON-Schema 2019-9 definition (<<graph_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/graph-rc.yaml

@@ -0,0 +1,38 @@
+---
+normative_statements_classes:
+- name: Graph logical model SDU
+  identifier: /req/graph
+  description: |
+    The Graph Target supports a network of object relative poses. The graph is a
+    directed acyclic graph, each node must either be an Extrinsic Frame or
+    reachable from an Extrinsic Frame.
+
+  dependencies:
+  - /req/global
+  - /req/frame-spec
+  - /req/time
+
+  normative_statements:
+
+  - name: Expression of valid time as GeoPose_Instant
+    identifier: /req/graph/valid-time
+    dependencies:
+    - /req/time/instant
+    statement: |
+      The `Graph.validTime` attribute shall be represented by a
+      `GeoPose_Instant` object.
+
+  - name: List of frame specifications
+    identifier: /req/graph/frame-list
+    statement: |
+      The `Graph.frameList` attribute shall represent a list of explicit
+      frame specifications with an array of `ExplicitFrameSpec` objects.
+
+  - name: Transforms for frame specification list
+    identifier: /req/graph/transform-list
+    statement: |
+      The `Graph.transformList` attribute shall have a value of type
+      `FrameTransformIndexPair`.
+      Each index value in a `FrameListTransformPair` SHALL be a distinct integer
+      value between 0 and one less than the number of elements in the
+      `frameList` property.

data/spec/fixtures/series-irregular-cc.yaml

@@ -0,0 +1,58 @@
+---
+conformance_classes:
+- name: Irregular_Series logical model SDU conformance
+  identifier: /conf/series-irregular
+  target:
+  - /req/series-irregular
+  classification: "Target Type: SDU"
+  description: To confirm that components of a Irregular_Series conform to the Logical Model.
+  dependencies:
+  - /conf/global
+  - /conf/frame-spec
+  - /conf/time
+
+  tests:
+
+  - name: Verify expression of inner frames and time series
+    identifier: /conf/series-irregular/inner-frame-and-time
+    targets:
+    - /req/series-irregular/inner-frame-and-time
+    dependencies:
+    - /conf/time/instant
+    description: |
+      Confirm that the `Irregular_Series.innerFrameAndTime` attribute is
+      implemented as an array of `FrameAndTimeElement` objects, each of which is
+      a pair of `ExplicitFrameSpec` and `GeoPoseInstant` objects.
+    purpose: |
+      To confirm that the `innerFrameAndTime` attribute values are implemented
+      in accordance with the Logical Model.
+
+  - name: Verify expression of outer frame
+    identifier: /conf/series-irregular/outer-frame
+    targets:
+    - /req/series-irregular/outer-frame
+    purpose: |
+      The `Irregular_Series.outerFrame` attribute shall represent the first
+      frame in the series expressed by the `innerFrameAndTime` attribute.
+
+  - name: Verify expression of series header
+    identifier: /conf/series-irregular/header
+    targets:
+    - /req/series-irregular/header
+    description: |
+      Verify that the `Irregular_Series.header` attribute is implemented as an
+      instance of SeriesHeader.
+    purpose: |
+      To confirm that the implementation of Series Header conforms to the
+      Logical Model.
+
+  - name: Verify expression of series trailer
+    identifier: /conf/series-irregular/trailer
+    targets:
+    - /req/series-irregular/trailer
+    description: |
+      Verify that the `Irregular_Series.trailer` attribute is implemented as an
+      instance of SeriesTrailer.
+    purpose: |
+      To confirm that the implementation of SeriesTrailer conforms to the
+      Logical Model.

data/spec/fixtures/series-irregular-json-cc.yaml

@@ -0,0 +1,24 @@
+---
+conformance_classes:
+- name: JSON encoding of Irregular Series SDU
+  identifier: /conf/series-irregular-encoding-json
+  target:
+  - /req/series-irregular-encoding-json
+  classification: "Target Type: JSON SDU"
+  description: |
+    Confirm that a JSON-encoded GeoPose Irregular Series conforms to the
+    relevant elements of the Logical Model and a corresponding JSON-Schema
+    document.
+
+  tests:
+  - name: Verify conformance via JSON schema
+    identifier: /conf/series-irregular-encoding-json/definition
+    targets:
+    - /req/series-irregular-encoding-json/definition
+    description: |
+      To confirm that a GeoPose Irregular Series 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 Irregular Series JSON-Schema 2019-9
+      definition (<<irregular_series_json_schema>>).

data/spec/fixtures/series-irregular-json-rc.yaml

@@ -0,0 +1,20 @@
+---
+normative_statements_classes:
+- name: JSON encoding of Irregular Series SDU
+  identifier: /req/series-irregular-encoding-json
+  description: |
+    Requirements for the JSON encoding of a Irregular Series SDU.
+  implements:
+  - /req/series-irregular
+
+  normative_statements:
+
+  - name: Specification as JSON schema
+    identifier: /req/series-irregular-encoding-json/definition
+    statement: |
+      A JSON-encoded GeoPose Irregular Series SHALL conform to the GeoPose Chain
+      JSON-Schema 2019-9 definition (<<irregular_series_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/series-irregular-rc.yaml

@@ -0,0 +1,41 @@
+---
+normative_statements_classes:
+- name: Irregular_Series logical model SDU
+  identifier: /req/series-irregular
+  description: |
+    The Irregular_Series Target represents the time evolution of a single
+    GeoPose, with a variable time duration between successive inner frames.
+
+  dependencies:
+  - /req/global
+  - /req/frame-spec
+  - /req/time
+
+  normative_statements:
+
+  - name: Expression of inner frames and time series
+    identifier: /req/series-irregular/inner-frame-and-time
+    dependencies:
+    - /req/time/instant
+    statement: |
+      The `Irregular_Series.innerFrameAndTime` attribute SHALL be implemented as
+      an array of `FrameAndTimeElement` objects, each of which is a pair of
+      `ExplicitFrameSpec` and `GeoPoseInstant` objects.
+
+  - name: Expression of outer frame
+    identifier: /req/series-irregular/outer-frame
+    statement: |
+      The `Irregular_Series.outerFrame` attribute shall represent the first
+      frame in the series expressed by the `innerFrameAndTime` attribute.
+
+  - name: Expression of series header
+    identifier: /req/series-irregular/header
+    statement: |
+      The `Irregular_Series.header` attribute shall be implemented as an instance
+      of SeriesHeader.
+
+  - name: Expression of series trailer
+    identifier: /req/series-irregular/trailer
+    statement: |
+      The `Irregular_Series.trailer` attribute shall be implemented as an instance
+      of SeriesTrailer.

data/spec/fixtures/series-regular-cc.yaml

@@ -0,0 +1,63 @@
+---
+conformance_classes:
+- name: Regular_Series logical model SDU conformance
+  identifier: /conf/series-regular
+  target:
+  - /req/series-regular
+  classification: "Target Type: SDU"
+  description: To confirm that components of a Regular Series conform to the Logical Model.
+  dependencies:
+  - /conf/global
+  - /conf/frame-spec
+  - /conf/time
+
+  tests:
+
+  - name: Verify expression of duration as GeoPose_Duration
+    identifier: /conf/series-regular/duration
+    targets:
+    - /req/series-regular/duration
+    dependencies:
+    - /conf/time/duration
+    description: |
+      To confirm that the `Regular_Series.interPoseDuration` attribute is
+      represented by an instance of the `GeoPose_Duration` object.
+    purpose: To confirm the correct properties of a GeoPose Duration.
+
+  - name: Verify expression of outer frame
+    identifier: /conf/series-regular/outer-frame
+    targets:
+    - /req/series-regular/outer-frame
+    purpose: |
+      The `Regular_Series.outerFrame` attribute shall represent the first frame
+      in the series with the `ExplicitFrameSpec` object.
+
+  - name: Verify expression of inner frames
+    identifier: /conf/series-regular/inner-frame-series
+    targets:
+    - /req/series-regular/inner-frame-series
+    purpose: |
+      The `Regular_Series.innerFrameSeries` attribute shall represent the
+      succession of inner frames as an array of `ExplicitFrameSpec` objects.
+
+  - name: Verify expression of series header
+    identifier: /conf/series-regular/header
+    targets:
+    - /req/series-regular/header
+    description: |
+      Verify that the `Regular_Series.header` attribute is implemented as an
+      instance of SeriesHeader.
+    purpose: |
+      To confirm that the implementation of Series Header conforms to the
+      Logical Model.
+
+  - name: Verify expression of series trailer
+    identifier: /conf/series-regular/trailer
+    targets:
+    - /req/series-regular/trailer
+    description: |
+      Verify that the `Regular_Series.trailer` attribute is implemented as an
+      instance of SeriesTrailer.
+    purpose: |
+      To confirm that the implementation of SeriesTrailer conforms to the
+      Logical Model.

data/spec/fixtures/series-regular-json-cc.yaml

@@ -0,0 +1,24 @@
+---
+conformance_classes:
+- name: JSON encoding of Regular Series SDU
+  identifier: /conf/series-regular-encoding-json
+  target:
+  - /req/series-regular-encoding-json
+  classification: "Target Type: JSON SDU"
+  description: |
+    Confirm that a JSON-encoded GeoPose Regular Series conforms to the
+    relevant elements of the Logical Model and a corresponding JSON-Schema
+    document.
+
+  tests:
+  - name: Verify conformance via JSON schema
+    identifier: /conf/series-regular-encoding-json/definition
+    targets:
+    - /req/series-regular-encoding-json/definition
+    description: |
+      To confirm that a GeoPose Regular Series 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 Regular Series JSON-Schema 2019-9
+      definition (<<regular_series_json_schema>>).

data/spec/fixtures/series-regular-json-rc.yaml

@@ -0,0 +1,20 @@
+---
+normative_statements_classes:
+- name: JSON encoding of Regular Series SDU
+  identifier: /req/series-regular-encoding-json
+  description: |
+    Requirements for the JSON encoding of a Regular Series SDU.
+  implements:
+  - /req/series-regular
+
+  normative_statements:
+
+  - name: Specification as JSON schema
+    identifier: /req/series-regular-encoding-json/definition
+    statement: |
+      A JSON-encoded GeoPose Regular Series SHALL conform to the GeoPose Chain
+      JSON-Schema 2019-9 definition (<<regular_series_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/series-regular-rc.yaml

@@ -0,0 +1,46 @@
+---
+normative_statements_classes:
+- name: Regular_Series logical model SDU
+  identifier: /req/series-regular
+  description: |
+    The Regular_Series Target represents the time evolution of a single GeoPose,
+    with a constant time duration between successive inner frames.
+
+  dependencies:
+  - /req/global
+  - /req/frame-spec
+  - /req/time
+
+  normative_statements:
+
+  - name: Expression of duration as GeoPose_Duration
+    identifier: /req/series-regular/duration
+    dependencies:
+    - /req/time/duration
+    statement: |
+      The `Regular_Series.interPoseDuration` attribute shall be represented by
+      an instance of the `GeoPose_Duration` object.
+
+  - name: Expression of outer frame
+    identifier: /req/series-regular/outer-frame
+    statement: |
+      The `Regular_Series.outerFrame` attribute shall represent the first frame
+      in the series with the `ExplicitFrameSpec` object.
+
+  - name: Expression of inner frames
+    identifier: /req/series-regular/inner-frame-series
+    statement: |
+      The `Regular_Series.innerFrameSeries` attribute shall represent the
+      succession of inner frames as an array of `ExplicitFrameSpec` objects.
+
+  - name: Expression of series header
+    identifier: /req/series-regular/header
+    statement: |
+      The `Regular_Series.header` attribute shall be implemented as an instance
+      of SeriesHeader.
+
+  - name: Expression of series trailer
+    identifier: /req/series-regular/trailer
+    statement: |
+      The `Regular_Series.trailer` attribute shall be implemented as an instance
+      of SeriesTrailer.

data/spec/fixtures/stream-cc.yaml

@@ -0,0 +1,49 @@
+---
+conformance_classes:
+- name: StreamHeader and StreamElement logical model SDUs conformance
+  identifier: /conf/stream
+  target:
+  - /req/stream
+  classification: "Target Type: SDU"
+  description: To confirm that an implementation of the GeoPose Stream SDUs conforms to the Logical Model.
+  dependencies:
+  - /conf/global
+  - /conf/frame-spec
+
+  tests:
+
+  - name: Verify outer frame in StreamHeader
+    identifier: /conf/stream/header-initial-frame
+    targets:
+    - /req/stream/header-initial-frame
+    description: |
+      To confirm the correct specification of the `StreamHeader.outerFrame`.
+    purpose: |
+      To confirm the initial frame is specified as an instance of the
+      `ExplicitFrameSpec` object.
+    method: Inspection
+
+  - name: Verify transition model in StreamHeader
+    identifier: /conf/stream/header-transition-model
+    targets:
+    - /req/stream/header-transition-model
+    description: |
+      To confirm the correct specification of the `StreamHeader.transitionModel`.
+    purpose: |
+      To confirm the `transitionModel` is specified as an instance of the
+      `TransitionModel` enumeration.
+    method: Inspection
+
+  - name: Verify stream elements in StreamElement
+    identifier: /conf/stream/element
+    targets:
+    - /req/stream/element
+    dependencies:
+    - /conf/time/instant
+    description: |
+      To confirm the correct specification of the `StreamElement`.
+    purpose: |
+      To confirm the StreamElement is implemented as an array of
+      `FrameAndTimeElement` objects, each of which is a pair of
+      `ExplicitFrameSpec` and `GeoPoseInstant` objects.
+    method: Inspection

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

@@ -0,0 +1,48 @@
+---
+conformance_classes:
+- name: JSON encoding of Stream SDUs
+  identifier: /conf/stream-encoding-json
+  target:
+  - /req/stream-encoding-json
+  classification: "Target Type: JSON SDU"
+  description: |
+    Confirm that a JSON-encoded GeoPose Stream conforms to the
+    relevant elements of the Logical Model and a corresponding JSON-Schema
+    document.
+
+  tests:
+  - name: Verify Stream Element conformance to JSON schema
+    identifier: /conf/stream-encoding-json/element
+    targets:
+    - /req/stream-encoding-json/element
+    description: |
+      To confirm that a GeoPose Stream Element in JSON validates against the JSON schema.
+    purpose: |
+      Verify JSON data conforms to the JSON schema.
+    method: |
+      Validate the JSON data against the GeoPose Stream Element
+      JSON-Schema 2019-9 definition (<<streamelement_json_schema>>).
+
+  - name: Verify Stream Header conformance to JSON schema
+    identifier: /conf/stream-encoding-json/header
+    targets:
+    - /req/stream-encoding-json/header
+    description: |
+      To confirm that a GeoPose Stream Header in JSON validates against the JSON schema.
+    purpose: |
+      Verify JSON data conforms to the JSON schema.
+    method: |
+      Validate the JSON data against the GeoPose Stream Header
+      JSON-Schema 2019-9 definition (<<streamheader_json_schema>>).
+
+  - name: Verify Stream Record conformance to JSON schema
+    identifier: /conf/stream-encoding-json/record
+    targets:
+    - /req/stream-encoding-json/record
+    description: |
+      To confirm that a GeoPose Stream Record in JSON validates against the JSON schema.
+    purpose: |
+      Verify JSON data conforms to the JSON schema.
+    method: |
+      Validate the JSON data against the GeoPose Stream Record
+      JSON-Schema 2019-9 definition (<<streamrecord_json_schema>>).