Events (LSST CCS - Shutter Subsystem (Pom) 4.3 API)

All Known Implementing Classes:

StateMachine
```
public interface Events
```
The set of all events that are recognized by the state machine used by the CCS subsystem to control the camera shutter. An event may cause actions to be performed and may also trigger a state transition. An EventReply instance is returned by each event method indicating acceptance or rejection. Events are the inputs to the state machine.

Author:

tether

See Also:

EventReply

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`EventReply`	`calibDone(CalibDone calibResults)` Indicates that a Hall calibration operation has been successful.
`EventReply`	`calibrate(Calibrate calibParams)` Requests a Hall calibration.
`EventReply`	`changeAxisEnable(org.lsst.ccs.subsystem.motorplatform.bus.ChangeAxisEnable req)` Requests that the enable state of the given axis be changed.
`EventReply`	`changeBrakeState(Axis ax, ChangeBrakeState.State newState)` Requests that the brake state on a given axis be changed.
`EventReply`	`clearAllFaults(org.lsst.ccs.subsystem.motorplatform.bus.ClearAllFaults req)` Requests that fault conditions be cleared for both axes.
`EventReply`	`clearAxisFaults(org.lsst.ccs.subsystem.motorplatform.bus.ClearAxisFaults req)` Requests that fault conditions be cleared for the given axis.
`EventReply`	`closeShutter()` Requests that a closing of the shutter be started.
`EventReply`	`contactLost()` Indicates that the subsystem can't communicate properly with the shutter PLC.
`EventReply`	`disable()` Indicates that the shutter hardware protection is forbidding shutter operation.
`EventReply`	`disableAllAxes(org.lsst.ccs.subsystem.motorplatform.bus.DisableAllAxes req)` Requests that both axes be disabled.
`EventReply`	`enable()` Indicates that the shutter hardware protection is is allowing shutter operation.
`EventReply`	`enableAllAxes(org.lsst.ccs.subsystem.motorplatform.bus.EnableAllAxes req)` Requests that both axes be enabled.
`EventReply`	`error()` Indicates that the shutter tried and failed to carry out a requested operation.
`EventReply`	`gotoCenter()` Requests that the shutter prepare for power-down by placing both blade sets in the center position.
`EventReply`	`gotoProd()` Requests that the shutter, if it's ready to do so, accept subsequent requests to take exposures.
`EventReply`	`ignored(Ignored.Reason reason)` Indicates that the shutter PLC state machine has ignored an event sent to it.
`EventReply`	`motionDone(MotionDonePLC profileData)` Indicates that a blade set has successfully completed a motion.
`EventReply`	`moveAxisAbsolute(org.lsst.ccs.subsystem.motorplatform.bus.MoveAxisAbsolute req)` Requests that the given axis be moved to a given absolute position.
`EventReply`	`moveAxisRelative(org.lsst.ccs.subsystem.motorplatform.bus.MoveAxisRelative req)` Requests that an axis change its position by a certain offset.
`EventReply`	`openShutter()` Requests that an opening of the shutter be started.
`EventReply`	`plcIsDisabled()` Indicates that shutter controller has sent a status message in which the reported state is Enabled.
`EventReply`	`plcIsEnabled()` Indicates that the shutter controller has sent a status message in which reported state is Disabled.
`EventReply`	`reset()` Requests that the shutter controller stop any motion in progress and reset its state machine to its initial state.
`EventReply`	`resync()` Triggers another attempt to synchronize states with the PLC.
`EventReply`	`syncTimeout()` Indicates that after a reset the PLC has taken too long to reach one of the designated after-reset states.
`EventReply`	`takeExposure(Duration exposureTime)` Requests that an exposure of the given duration be started.
`EventReply`	`timer()` Indicates that an exposure in progress has run for its allotted time.

- Method Detail
  - contactLost
```
EventReply contactLost()
```
    Indicates that the subsystem can't communicate properly with the shutter PLC.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - plcIsEnabled
```
EventReply plcIsEnabled()
```
    Indicates that the shutter controller has sent a status message in which reported state is Disabled. This event is ignored save when synchronizing the subsystem state and the PLC state. At other times we rely on explicit enable() and disable() event messages sent from the controller.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - plcIsDisabled
```
EventReply plcIsDisabled()
```
    Indicates that shutter controller has sent a status message in which the reported state is Enabled. At other times we rely on explicit enable() and disable() event messages sent from the controller.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - resync
```
EventReply resync()
```
    Triggers another attempt to synchronize states with the PLC.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - syncTimeout
```
EventReply syncTimeout()
```
    Indicates that after a reset the PLC has taken too long to reach one of the designated after-reset states.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - enable
```
EventReply enable()
```
    Indicates that the shutter hardware protection is is allowing shutter operation.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - disable
```
EventReply disable()
```
    Indicates that the shutter hardware protection is forbidding shutter operation.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - motionDone
```
EventReply motionDone(MotionDonePLC profileData)
```
    Indicates that a blade set has successfully completed a motion.
    
    Parameters:
    
    profileData - The motion profile.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - calibrate
```
EventReply calibrate(Calibrate calibParams)
```
    Requests a Hall calibration.
    
    Parameters:
    
    calibParams - The calibration parameters. If null the event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - calibDone
```
EventReply calibDone(CalibDone calibResults)
```
    Indicates that a Hall calibration operation has been successful.
    
    Parameters:
    
    calibResults - The results of the calibration.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - error
```
EventReply error()
```
    Indicates that the shutter tried and failed to carry out a requested operation.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - reset
```
EventReply reset()
```
    Requests that the shutter controller stop any motion in progress and reset its state machine to its initial state.
  - takeExposure
```
EventReply takeExposure(Duration exposureTime)
```
    Requests that an exposure of the given duration be started.
    
    Parameters:
    
    exposureTime - The length of the exposure. If null or too short a duration the event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - openShutter
```
EventReply openShutter()
```
    Requests that an opening of the shutter be started. Rejected if the shutter is not closed.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - timer
```
EventReply timer()
```
    Indicates that an exposure in progress has run for its allotted time.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - closeShutter
```
EventReply closeShutter()
```
    Requests that a closing of the shutter be started. Rejected if the shutter is not open.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - ignored
```
EventReply ignored(Ignored.Reason reason)
```
    Indicates that the shutter PLC state machine has ignored an event sent to it.
    
    Parameters:
    
    reason - The reason why the event was rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - gotoProd
```
EventReply gotoProd()
```
    Requests that the shutter, if it's ready to do so, accept subsequent requests to take exposures.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - gotoCenter
```
EventReply gotoCenter()
```
    Requests that the shutter prepare for power-down by placing both blade sets in the center position.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - moveAxisAbsolute
```
EventReply moveAxisAbsolute(org.lsst.ccs.subsystem.motorplatform.bus.MoveAxisAbsolute req)
```
    Requests that the given axis be moved to a given absolute position.
    
    Parameters:
    
    req - Contains the request parameters. If null then the event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - moveAxisRelative
```
EventReply moveAxisRelative(org.lsst.ccs.subsystem.motorplatform.bus.MoveAxisRelative req)
```
    Requests that an axis change its position by a certain offset.
    
    Parameters:
    
    req - Contains the request parameters. If null then event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - clearAllFaults
```
EventReply clearAllFaults(org.lsst.ccs.subsystem.motorplatform.bus.ClearAllFaults req)
```
    Requests that fault conditions be cleared for both axes.
    
    Parameters:
    
    req - Contains the request parameters. If null then the event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - changeAxisEnable
```
EventReply changeAxisEnable(org.lsst.ccs.subsystem.motorplatform.bus.ChangeAxisEnable req)
```
    Requests that the enable state of the given axis be changed.
    
    Parameters:
    
    req - Contains the request parameters. If null then the event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - changeBrakeState
```
EventReply changeBrakeState(Axis ax,
                            ChangeBrakeState.State newState)
```
    Requests that the brake state on a given axis be changed.
    
    Parameters:
    
    ax - The PLC task axis to affect.
    
    newState - The desired brake state.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - clearAxisFaults
```
EventReply clearAxisFaults(org.lsst.ccs.subsystem.motorplatform.bus.ClearAxisFaults req)
```
    Requests that fault conditions be cleared for the given axis.
    
    Parameters:
    
    req - Contains the request parameters. If null then the event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - enableAllAxes
```
EventReply enableAllAxes(org.lsst.ccs.subsystem.motorplatform.bus.EnableAllAxes req)
```
    Requests that both axes be enabled.
    
    Parameters:
    
    req - Contains the request parameters. If null then event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected
  - disableAllAxes
```
EventReply disableAllAxes(org.lsst.ccs.subsystem.motorplatform.bus.DisableAllAxes req)
```
    Requests that both axes be disabled.
    
    Parameters:
    
    req - Contains the request parameters. If null then the event is rejected.
    
    Returns:
    
    An EventReply instance which tells whether an event was accepted or rejected

Interface Events

Method Summary

Method Detail

contactLost

plcIsEnabled

plcIsDisabled

resync

syncTimeout

enable

disable

motionDone

calibrate

calibDone

error

reset

takeExposure

openShutter

timer

closeShutter

ignored

gotoProd

gotoCenter

moveAxisAbsolute

moveAxisRelative

clearAllFaults

changeAxisEnable

changeBrakeState

clearAxisFaults

enableAllAxes

disableAllAxes