coordinate_system_hierarchy-1.0.0¶

Schema that describes a local coordinate system hierarchy

Description

It stores information how the different coordinate systems are arranged towards each other. The basic data structure is a tree.

Outline

Schema Definitions Original Schema

Schema Definitions ¶

This type is an object with the following properties:

name
string Required
No length restriction
root_system_name
string Required
Name of the root coordinate system

No length restriction
reference_time
tag:weldx.bam.de:weldx/time/timestamp-1.0.0
A timestamp that serves as reference point for all attached coordinate systems.
subsystem_names
array
A list containing the names of subsystems that are directly attached to the main hierarchy. Nested subsystems are excluded.

No length restriction

Items in the array are restricted to the following types:

string
No length restriction
subsystems
array
A list containing the data of all subsystems including nested structures.

No length restriction
Items in the array are restricted to the following types:
coordinate_systems
array Required
An array of all the coordinate systems’ data. This includes their name, parent system and how they are arranged towards their parent system.

No length restriction
Items in the array are restricted to the following types:

Original Schema ¶

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://weldx.bam.de/schemas/weldx/core/transformations/coordinate_system_hierarchy-1.0.0"
tag: "tag:weldx.bam.de:weldx/core/transformations/coordinate_system_hierarchy-1.0.0"

title: |
  Schema that describes a local coordinate system hierarchy
description: |
  It stores information how the different coordinate systems are arranged towards each other. The basic data structure
  is a tree.
type: object
properties:
  name:
    type: string

  root_system_name:
    description: |
      Name of the root coordinate system
    type: string

  reference_time:
    description: |
      A timestamp that serves as reference point for all attached coordinate systems.
    tag: "tag:weldx.bam.de:weldx/time/timestamp-1.0.0"

  subsystem_names:
    description: |
      A list containing the names of subsystems that are directly attached to the main hierarchy. Nested subsystems
      are excluded.
    type: array
    items:
      type: string

  subsystems:
    description: |
      A list containing the data of all subsystems including nested structures.
    type: array
    items:
      tag: "tag:weldx.bam.de:weldx/core/transformations/coordinate_system_hierarchy_subsystem-1.0.0"

  coordinate_systems:
    description: |
      An array of all the coordinate systems' data. This includes their name, parent system and how they are arranged
      towards their parent system.
    type: array
    items:
      $ref: "tag:weldx.bam.de:weldx/core/transformations/coordinate_transformation-1.0.0"

propertyOrder: [name, root_system_name, reference_time, subsystems, subsystem_data,  coordinate_systems]
required: [name, root_system_name, coordinate_systems]
flowStyle: block
...