GOOSE quality mappings - Githubissues

emgre commented 5 years ago

Closes #57.

gooseStructure:  # GOOSE structure definition
  - bitstring: "A.q"
  - utc_time: "A.t"
  - bitstring: "A.tq"
quality-templates:  # Quality templates
  - template-id: default-quality  # unique id
    validity: ValidityKind_good  # {ValidityKind_good, ValidityKind_invalid, ValidityKind_reserved, ValidityKind_questionable}
    overflow: false
    out_of_range: false
    bad_reference: false
    oscillatory: false
    failure: false
    old_data: false
    inconsistent: false
    inaccurate: false
    source: SourceKind_process  # {SourceKind_process, SourceKind_substituted}
    test: false
    operator_blocked: false
time-quality-templates:  # Time quality templates
  - template-id: default-time-quality  # unique id
    clock_failure: false
    clock_not_synchronized: false
    leap_seconds_known: false
    time_accuracy: TimeAccuracyKind_T0  # {TimeAccuracyKind_UNDEFINED, TimeAccuracyKind_T0, TimeAccuracyKind_T1, TimeAccuracyKind_T2, TimeAccuracyKind_T3, TimeAccuracyKind_T4, TimeAccuracyKind_T5, TimeAccuracyKind_unspecified}

[...]

        A:
          net:
            cVal:
            q:
              quality-field-type: mapped
              name: "A.q"
              quality-mapping-type: copy
              template-id: default-quality
            t:
              timestamp-field-type: mapped
              name: "A.t"

              time-quality-name: "A.tq"
              quality-mapping-type: constant
              template-id: default-time-quality

When a quality is mapped, you need to specify the following things:
- name: The name that appears in gooseStructure (must be a bitstring), where the value will be written to.
- quality-mapping-type: Enumeration specifying how the value is obtained.
- copy: The value will be copied from the OpenFMB proto.
- constant: The value will be constant, based on the template template-id.
- constant_if_absent: If there is a value in the OpenFMB proto, it is used. Otherwise, it uses the constant based on the template template-id.
- template-id (only for constant and constant_if_absent): ID of the template used.
When a timestamp is mapped, you can specify the following things:
- name: The name that appears in gooseStructure (must be a time type) where the timestamp value (not the quality!) will be written to.
- time-quality-name: The name that appears in gooseStructure (must be a bitstring) where the timestamp quality will be written to.
- quality-mapping-type: Enumeration specifying how the value is obtained.
- copy: The value will be copied from the OpenFMB proto.
- constant: The value will be constant, based on the template template-id.
- constant_if_absent: If there is a value in the OpenFMB proto, it is used. Otherwise, it uses the constant based on the template template-id.
- template-id (only for constant and constant_if_absent): ID of the template used.
The constant templates are defined at the top of the YAML. You give each of them an unique ID and assign the different values.
❓ @larrylackey: I don't know how to map the TimeAccuracyKind into the bitstring. Do you have info on that?

larrylackey commented 5 years ago

My understanding is TimeAccuracyKind is a 5 bit integer 0..31 for the values below, where for example the enum T0 has the integer value of 7

On Wednesday, August 14, 2019, 11:00:14 AM MDT, Émile Grégoire <notifications@github.com> wrote:

Closes #57. gooseStructure: # GOOSE structure definition

bitstring: "A.q"
utc_time: "A.t"
bitstring: "A.tq" quality-templates: # Quality templates
template-id: default-quality # unique id validity: ValidityKind_good # {ValidityKind_good, ValidityKind_invalid, ValidityKind_reserved, ValidityKind_questionable} overflow: false out_of_range: false bad_reference: false oscillatory: false failure: false old_data: false inconsistent: false inaccurate: false source: SourceKind_process # {SourceKind_process, SourceKind_substituted} test: false operator_blocked: false time-quality-templates: # Time quality templates
template-id: default-time-quality # unique id clock_failure: false clock_not_synchronized: false leap_seconds_known: false time_accuracy: TimeAccuracyKind_T0 # {TimeAccuracyKind_UNDEFINED, TimeAccuracyKind_T0, TimeAccuracyKind_T1, TimeAccuracyKind_T2, TimeAccuracyKind_T3, TimeAccuracyKind_T4, TimeAccuracyKind_T5, TimeAccuracyKind_unspecified}

[...]

    A:
      net:
        cVal:
        q:
          quality-field-type: mapped
          name: "A.q"
          quality-mapping-type: copy
          template-id: default-quality
        t:
          timestamp-field-type: mapped
          name: "A.t"

          time-quality-name: "A.tq"
          quality-mapping-type: constant
          template-id: default-time-quality

When a quality is mapped, you need to specify the following things:
- name: The name that appears in gooseStructure (must be a bitstring), where the value will be written to.
- quality-mapping-type: Enumeration specifying how the value is obtained.
  - copy: The value will be copied from the OpenFMB proto.
  - constant: The value will be constant, based on the template template-id.
  - constant_if_absent: If there is a value in the OpenFMB proto, it is used. Otherwise, it uses the constant based on the template template-id.
- template-id (only for constant and constant_if_absent): ID of the template used.
When a timestamp is mapped, you can specify the following things:
- name: The name that appears in gooseStructure (must be a time type) where the timestamp value (not the quality!) will be written to.
- time-quality-name: The name that appears in gooseStructure (must be a bitstring) where the timestamp quality will be written to.
- quality-mapping-type: Enumeration specifying how the value is obtained.
  - copy: The value will be copied from the OpenFMB proto.
  - constant: The value will be constant, based on the template template-id.
  - constant_if_absent: If there is a value in the OpenFMB proto, it is used. Otherwise, it uses the constant based on the template template-id.
- template-id (only for constant and constant_if_absent): ID of the template used.
The constant templates are defined at the top of the YAML. You give each of them an unique ID and assign the different values.
❓ @larrylackey: I don't know how to map the TimeAccuracyKind into the bitstring. Do you have info on that?

You can view, comment on, or merge this pull request online at:

https://github.com/openenergysolutions/openfmb.adapters/pull/62

Commit Summary

Working GOOSE constant quality mapping.
Added timestamp quality mapping.

File Changes

M adapter-util/include/adapter-util/config/generated/MessageVisitors.h (68)
M adapter-util/include/adapter-util/config/generated/TypedModelVisitors.h (68)
M adapter-util/include/adapter-util/util/EnumUtil.h (16)
M adapter-util/src/config/generated/MessageVisitors.cpp (768)
M adapter-util/src/config/generated/ModelVisitors.cpp (598)
M codegen/src/main/java/com/oes/openfmb/generation/enumeration/Enumerations.java (11)
M plugins/dds/twinoaks/src/twinoaks/generated/ConvertFromProto.cpp (3898)
M plugins/dds/twinoaks/src/twinoaks/generated/ConvertFromProto.h (68)
M plugins/dds/twinoaks/src/twinoaks/generated/ConvertToProto.cpp (2412)
M plugins/dds/twinoaks/src/twinoaks/generated/ConvertToProto.h (68)
M plugins/goose/CMakeLists.txt (8)
M plugins/goose/include/goose/SubscribingPluginFactory.h (2)
M plugins/goose/src/ConfigStrings.h (23)
A plugins/goose/src/generated/QualityMappingType.cpp (60)
A plugins/goose/src/generated/QualityMappingType.h (53)
A plugins/goose/src/sub/ConstantMessageAccessor.h (73)
A plugins/goose/src/sub/QualityTemplatesConfigReader.cpp (51)
A plugins/goose/src/sub/QualityTemplatesConfigReader.h (27)
M plugins/goose/src/sub/SubGooseStructureConfigReader.h (26)
M plugins/goose/src/sub/SubscribingConfigReadVisitor.h (95)
M plugins/goose/src/sub/SubscribingConfigWriteVisitor.cpp (8)
M plugins/goose/src/sub/SubscribingPlugin.cpp (4)
M plugins/goose/src/sub/SubscribingPlugin.h (2)
M plugins/goose/src/sub/SubscribingPluginFactory.cpp (52)
M plugins/goose/src/sub/SubscribingProfileReader.h (7)
A plugins/goose/src/sub/TimeQualityMessageAccessor.h (39)
A plugins/goose/src/sub/TimeQualityTemplatesConfigReader.cpp (40)
A plugins/goose/src/sub/TimeQualityTemplatesConfigReader.h (27)

Patch Links:

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

emgre commented 5 years ago

Good, I added it.

jadamcrain commented 5 years ago

@emgre Need to rebase. Same thing, need the determinism.

emgre commented 5 years ago

Done.

openenergysolutions / openfmb.adapters

GOOSE quality mappings #62