Skip to content

YAN-1025 Add and document scan-related classes

Rodrigo Tobar requested to merge yan-1025 into main

The new module contains the base dataclasses used to represent Scans, ScanTypes and their constituent parts. These are based on the current version of ADR-54, and thus might be subject to change. Unit tests have been added, and the RTD documentation updated to show these classes.

My first instinct was to try starting from the changes in !12 (merged), but two things pushed me back:

  • The Scan classes were based on the pre-ADR-54 definitions, and thus would have needed updating
  • The changes also included the addition of an Antenna class (plus all related changes throughout to code to use them), which isn't part of this story, and was therefore too invasive.

I thus decided to start anew with a clean, new module, and build from that.

Note that this story doesn't yet integrate these classes with the rest of the code, that's part of our other stories within the feature.

Merge request reports