forked from NSLS-II-ARI/ari_sxn_common
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add class definition and initial docstring
- Loading branch information
1 parent
dcbb62c
commit 046ef14
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
""" |