org.lsst.ccs.subsystem.shutter.statemachine

Interface Actions

All Known Implementing Classes:

SimulatedActions

public interface Actions

The set of basic actions that the state machine can perform on its environment. An action may be directed at the CCS subsystem framework, at components in the subsystem build tree or at the shutter controller. Actions are the outputs of the state machine.

Author:

tether

Method Summary

Modifier and Type	Method and Description
void	cancelSyncTimer() Cancels the sync timer if it's still running.
boolean	isBadExposureTime(Duration exposureTime) Determines whether the exposure time has an invalid value, for example, it's below the minimum.
void	lowerSyncAlert() Sets the severity of the SYNC alert to NOMINAL so that it may be cleared.
boolean	makeFullContact() Widens the link to the shutter controller, allowing the full exchange of all message types.
boolean	makePartialContact() Makes a link to the shutter controller, just enough to sent rest messages and receive shutter status messages.
void	raiseSyncAlert() Changes the severity of the SYNC alert to ALARM.
boolean	readyForCalibration() Determines if the shutter is ready for calibration.
void	relay(MsgToPLC eventMsg) Relays an event to the PLC via the given message instance.
void	resetPLC() Sends a reset() event to the PLC.
void	saveCalib(CalibDone cal) Saves the calibration data to a filesystem on the CCS network.
void	sendProfile(MotionDone mot) Sends the motion profile out on the CCS status bus.
void	setPhysicalState(PhysicalState newBstate) Sets the state the appears in the subsystems state bundle.
boolean	shutterIsReady() Determines if the shutter is ready for production data-taking.
void	startFirstCentering() Sends an event to the PLC that will start it moving one of the blade sets to its center position.
void	startSecondCentering() Sends an event to the PLC that will start it moving the second blade set to be centered, which is the one that wasn't moved by startFirstCentering().
void	startSyncTimer() Starts a timer which will generate a syncYimeout() when it expires.
void	terminateContact() Close any connection we may have to the shutter controller and stop decoding any messages we have already received.

Method Detail

cancelSyncTimer

void cancelSyncTimer()

Cancels the sync timer if it's still running.

See Also:

startSyncTimer()

isBadExposureTime

boolean isBadExposureTime(Duration exposureTime)

Determines whether the exposure time has an invalid value, for example, it's below the minimum.

Parameters:

exposureTime - The time to check.

Returns:

true if the time is OK, else false.

lowerSyncAlert

void lowerSyncAlert()

Sets the severity of the SYNC alert to NOMINAL so that it may be cleared.

makePartialContact

boolean makePartialContact()

Makes a link to the shutter controller, just enough to sent rest messages and receive shutter status messages.

Returns:

true if the operation succeeded, else false.

makeFullContact

boolean makeFullContact()

Widens the link to the shutter controller, allowing the full exchange of all message types.

Returns:

true if the operation succeeded, else false.

setPhysicalState

void setPhysicalState(PhysicalState newBstate)

Sets the state the appears in the subsystems state bundle.

Parameters:

newBstate - The new state value.

raiseSyncAlert

void raiseSyncAlert()

Changes the severity of the SYNC alert to ALARM.

readyForCalibration

boolean readyForCalibration()

Determines if the shutter is ready for calibration. Both axes must be enabled, have the brakes off and be homed.

Returns:

true if the conditions are met, else false.

resetPLC

void resetPLC()

Sends a reset() event to the PLC.

relay

void relay(MsgToPLC eventMsg)

Relays an event to the PLC via the given message instance.

saveCalib

void saveCalib(CalibDone cal)

Saves the calibration data to a filesystem on the CCS network.

sendProfile

void sendProfile(MotionDone mot)

Sends the motion profile out on the CCS status bus.

startFirstCentering

void startFirstCentering()

Sends an event to the PLC that will start it moving one of the blade sets to its center position. The CCS subsystem chooses which blade set to move in order to avoid collision.

See Also:

startSecondCentering()

startSecondCentering

void startSecondCentering()

Sends an event to the PLC that will start it moving the second blade set to be centered, which is the one that wasn't moved by startFirstCentering().

See Also:

startFirstCentering()

shutterIsReady

boolean shutterIsReady()

Determines if the shutter is ready for production data-taking. It has to be closed with both axes enabled, homed and having the brake released.

Returns:

The state of shutter readiness.

startSyncTimer

void startSyncTimer()

Starts a timer which will generate a syncYimeout() when it expires.

See Also:

cancelSyncTimer()

terminateContact

void terminateContact()

Close any connection we may have to the shutter controller and stop decoding any messages we have already received.