Schema: Propagator

(v0.0.1)

Propagator

kind: Propagator
metadata:
  name: string
  labels:
    property1: string
    property2: string
  annotations:
    ? property1
    ? property2
spec:
  options:
    direction: both
  signals:
    - signal: string
      target: string
      encoding:
        linear:
          min: 0
          max: 0
          factor: 0
          offset: 0
        mapping:
          - name: string
            source: 0
            target: 0
            range:
              min: 0
              max: 0

A propagator definition.

Properties

NameTypeRequiredDescription
kindstringtruenone
metadataobjectfalseInformation relating to an object.
» namestringfalseThe name of the object.
» labelsobjectfalseIdentifying information used to identify objects within the system (e.g. giving a specific ’label’ to an object).
»» additionalPropertiesstringfalsenone
» annotationsobjectfalseNon identifying information (i.e. information specific to the object itself).
»» additionalPropertiesanyfalsenone
specPropagatorSpectruenone

Enumerated Values

PropertyValue
kindPropagator

PropagatorSpec

options:
  direction: both
signals:
  - signal: string
    target: string
    encoding:
      linear:
        min: 0
        max: 0
        factor: 0
        offset: 0
      mapping:
        - name: string
          source: 0
          target: 0
          range:
            min: 0
            max: 0

Properties

NameTypeRequiredDescription
optionsobjectfalsenone
» directionstringfalsenone
signals[SignalEncoding]falseA list of signals belonging to this propagator.

Enumerated Values

PropertyValue
directionboth
directionforward
directionreverse

SignalEncoding

signal: string
target: string
encoding:
  linear:
    min: 0
    max: 0
    factor: 0
    offset: 0
  mapping:
    - name: string
      source: 0
      target: 0
      range:
        min: 0
        max: 0

A signal encoding definition.

Properties

NameTypeRequiredDescription
signalstringtrueThe name of the signal.
targetstringfalsenone
encodingobjectfalsenone
» linearobjectfalsenone
»» minnumberfalsenone
»» maxnumberfalsenone
»» factornumberfalsenone
»» offsetnumberfalsenone
» mapping[object]falsenone
»» namestringfalsenone
»» sourcenumberfalsenone
»» targetnumberfalsenone
»» rangeobjectfalsenone
»»» minnumberfalsenone
»»» maxnumberfalsenone

undefined