Skip to content

Commit

Permalink
Add class definition and initial docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
awalter-bnl committed Jun 21, 2024
1 parent dcbb62c commit 046ef14
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions src/ari_sxn_common/common_bluesky.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
from bluesky import plans
from bluesky.plan_stubs import mv, mvr

class PlanCollector:
"""
A class used to collect together the plans to be used at ARI and SXN,
This is a 'collector' class that is designed to hold together the plans that
are used at both ARI and SXN. It will include all of the builtin
`bluesky.plans` (but only one alias of each) as well as the builtin
`bluesky.plan_stubs` mv (as `plan.move`) and mvr (as `plan.relative_move`).
Additional, ARI & SXN specific, plans can/will also be added (see attribute
list below).
Attributes
----------
built-ins : many
All of the built-in plans from `bluesky.plans` (but not aliases) as well
as the `bluesky.plan_stubs` mv (as move) and mvr (as relative_move).
"""

0 comments on commit 046ef14

Please sign in to comment.