PluginActions (LSST CCS - Shutter Subsystem (Pom) 4.7 API)

All Known Implementing Classes:

Commander, ControlPanel, Dispatcher, DisplayPanel, StatusListener
```
public interface PluginActions
```
All the actions that the may be performed by the shutter GUI on itself, the CCS status bus, the shutter worker, etc.

Author:

tether

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default void`	`calibrate()` Command the shutter worker to start a calibration.
`default void`	`center()` Command the shutter worker to start centering the blade sets.
`default void`	`changeBrakeState(ShutterSide side, boolean brakeEngaged)` Command the shutter to engage or release one of the blade set brakes.
`default void`	`closeShutter()` Command the shutter worker to start closing the shutter.
`default void`	`connect()` Connect to the CCS buses and check that the worker is online..
`default void`	`disconnect()` Disconnect from the CCS buses.
`default void`	`openShutter()` Command the shutter worker to start opening the shutter.
`default void`	`prodMode()` Command the shutter worker to go into production mode.
`default void`	`resync()` Command the shutter worker to resynchronize its state with that of the shutter controller.
`default void`	`showCommandFailure(String message)` Show that the last attempt to command the shutter worker failed.
`default void`	`showCommandSuccess()` Show that the shutter worker accepted the last command.
`default void`	`showStateBundle(PhysicalState phys, SoftwareState soft)` Update the display of worker state bundle elements.
`default void`	`showStatus(ShutterStatus status)` Update displays according to the latest `ShutterStatus` message received
`default void`	`showTrajectory(MotionDone motion)` Update displays using the latest `MotionDone` message received.
`default void`	`showWorkerIsReachable()` Show that we're connected to the buses and that the worker is online.
`default void`	`showWorkerIsUnreachable(String message)` Show that the worker subsystem can't be communicated with.
`default void`	`stopMotion()` Command the shutter worker to stop all blade set motion and reset the controller.
`default void`	`takeExposure(double exposureTime)` Command the shutter worker to start taking an exposure.

- Method Detail
  - calibrate
```
default void calibrate()
```
    Command the shutter worker to start a calibration.
  - center
```
default void center()
```
    Command the shutter worker to start centering the blade sets.
  - changeBrakeState
```
default void changeBrakeState(ShutterSide side,
                              boolean brakeEngaged)
```
    Command the shutter to engage or release one of the blade set brakes.
    
    Parameters:
    
    side - The blade set to be affected.
    
    brakeEngaged - True if the brake is to be engaged, else false.
  - closeShutter
```
default void closeShutter()
```
    Command the shutter worker to start closing the shutter.
  - connect
```
default void connect()
```
    Connect to the CCS buses and check that the worker is online..
  - disconnect
```
default void disconnect()
```
    Disconnect from the CCS buses.
  - prodMode
```
default void prodMode()
```
    Command the shutter worker to go into production mode.
  - openShutter
```
default void openShutter()
```
    Command the shutter worker to start opening the shutter.
  - resync
```
default void resync()
```
    Command the shutter worker to resynchronize its state with that of the shutter controller.
  - showCommandSuccess
```
default void showCommandSuccess()
```
    Show that the shutter worker accepted the last command.
  - showCommandFailure
```
default void showCommandFailure(String message)
```
    Show that the last attempt to command the shutter worker failed.
    
    Parameters:
    
    message - A short explanation of the failure..
  - showStateBundle
```
default void showStateBundle(PhysicalState phys,
                             SoftwareState soft)
```
    Update the display of worker state bundle elements.
    
    Parameters:
    
    phys - The PhysicalState value to display.
    
    soft - The SoftwareState value to display.
  - showStatus
```
default void showStatus(ShutterStatus status)
```
    Update displays according to the latest ShutterStatus message received
    
    Parameters:
    
    status - The ShutterStatus message.
  - showWorkerIsReachable
```
default void showWorkerIsReachable()
```
    Show that we're connected to the buses and that the worker is online.
  - showWorkerIsUnreachable
```
default void showWorkerIsUnreachable(String message)
```
    Show that the worker subsystem can't be communicated with. It could be that we can't connect to the buses, that the worker isn't online or that the worker is unresponsive..
    
    Parameters:
    
    message - A short message describing the problem.
  - showTrajectory
```
default void showTrajectory(MotionDone motion)
```
    Update displays using the latest MotionDone message received.
    
    Parameters:
    
    motion - The MotionDone message.
  - stopMotion
```
default void stopMotion()
```
    Command the shutter worker to stop all blade set motion and reset the controller.
  - takeExposure
```
default void takeExposure(double exposureTime)
```
    Command the shutter worker to start taking an exposure.
    
    Parameters:
    
    exposureTime - The exposure time in seconds.

Interface PluginActions

Method Summary

Method Detail

calibrate

center

changeBrakeState

closeShutter

connect

disconnect

prodMode

openShutter

resync

showCommandSuccess

showCommandFailure

showStateBundle

showStatus

showWorkerIsReachable

showWorkerIsUnreachable

showTrajectory

stopMotion

takeExposure