Skip to content

WIP: First for-discussion draft of a Beamline object

Marcus Oskarsson requested to merge github/fork/rhfogh/BeamlineObject into master

Created by: rhfogh

This just to start discussion. Some points:

  • Defining the roles as properties makes them visible to linters, and guarantees that roles have the right spelling.

  • The hierarchy is an alternative to putting everything into a single object (simple, but crowded). It does require that people can find things easily, and the right place to put things will surely change under discussion. I propose to have a 'beam' object; alternatively its contents could be moved to the top level, but that would be rather more confused.

  • All hardwareObjects are configured in only one place, either at the top level (here) or within one of the objects given here.

  • All properties in this file are mandatory, lower in the hierarchy they can be optional.

  • A related discussion is to what extent we want people to access objects lower in the hierarchy, as opposed to putting wrapper functions in the top level object. I.e., should it be 'detector.set_distance(value)' or detector.distance_motor.set_position(value)'?

Merge request reports