org.lsst.ccs.subsystems.shutter

Class ShutterMain

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.shutter.ShutterMain

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.SignalHandler

public class ShutterMain
extends org.lsst.ccs.framework.Module

Main module for the shutter subsystem.

This module manages two objects that implement the BladeSet interface, one for each side of the shutter. Generally these will either both be instances of BladeSetSimulator or of BladeSetDrvr. Coordinated motions of one or both the blade sets are carried out in response to commands from the CCS command bus. Motion histories for the blade sets are published on the CCS status bus.

Author:

azemoon, tether

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields inherited from class org.lsst.ccs.framework.Module

environment, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
ShutterMain(String name) Constructs the main module for the shutter subsystem.

Method Summary

Modifier and Type	Method and Description
void	calibrate() Does nothing at present.
void	closeShutter() Closes the shutter.
double	getBladeMovementTime() The default value for the number of seconds each blade set should take to move when taking an exposure.
BladeSet	getBladeSet(ShutterSide side) Gets one of the two BladeSet objects.
BladePositionResult	getBladeSetPositions() Gets the current relative position of both blade sets.
double	getMinApproach() Gets the current minimum approach distance for the blade sets (absolute position).
double	getPosTolerance(ShutterSide side) Gets the tolerance used when comparing blade set position against a known position.
void	initModule() Requires that both blade sets controllers are present and that all required configuration is present and checked.
void	moveToPosition(ShutterSide side, double targetPosition) Action command to move a single blade set.
void	openShutter() Opens the shutter.
void	shutdownNow() Shut down activity in this module.
void	start() Perform hardware initialization.
void	takeExposure(double exposureTime) An action command that opens the shutter for the given exposure time then closes it.

Methods inherited from class org.lsst.ccs.framework.Module

getComponentTree, getEnvironment, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, postStart, processUpdate, sendSignal, sendSignalWithTimeLimit, setEnvironment, setName, setNObserverThreads, setObservables, setTickMillis, signal, startTicking, tick, update

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.framework.Configurable

change, dropSubmittedChanges, getCheckedValueFromConfiguration, getChildren, getComponentByName, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, notifyChange, notifyChangeWithoutPreliminaryChecks, printConfigurableParameters, setBulkParameter, submitChange, submitChanges, validateBulkChange

Constructor Detail

ShutterMain

public ShutterMain(String name)

Constructs the main module for the shutter subsystem.

Parameters:

name - the component name (module name)

bladeSets - a map of BladeSet objects, one per shutter side.

Method Detail

initModule

public void initModule()

Requires that both blade sets controllers are present and that all required configuration is present and checked.

Overrides:

initModule in class org.lsst.ccs.framework.Module

start

public void start()

Perform hardware initialization.

shutdownNow

public void shutdownNow()

Shut down activity in this module. It uses an executor service which must be shut down.

Specified by:

shutdownNow in interface org.lsst.ccs.framework.Configurable

Overrides:

shutdownNow in class org.lsst.ccs.framework.Module

getBladeSet

public final BladeSet getBladeSet(ShutterSide side)

Gets one of the two BladeSet objects.

Parameters:

side - selects the desired BladeSet

Returns:

the selected BladeSet object

getBladeMovementTime

public double getBladeMovementTime()

The default value for the number of seconds each blade set should take to move when taking an exposure.

Returns:

the movement time

getPosTolerance

public double getPosTolerance(ShutterSide side)

Gets the tolerance used when comparing blade set position against a known position.

Returns:

The tolerance value.

getMinApproach

public double getMinApproach()

Gets the current minimum approach distance for the blade sets (absolute position).

Returns:

The min. distance.

getBladeSetPositions

@Command(type=ACTION,
         level=0,
         description="Gets the current relative positions of both blade sets")
public BladePositionResult getBladeSetPositions()

Gets the current relative position of both blade sets. See BladePosition. May cause hardware operations.

Returns:

the positions

moveToPosition

@Command(type=ACTION,
         level=1,
         description="Moves one of the blade sets")
public void moveToPosition(@Argument(name="side",description="Selects the blade set (MINUSX or PLUSX)")
                                                                                                                       ShutterSide side,
                                                                                                                       @Argument(name="targetPosition",description="The desired relative position of the blade set")
                                                                                                                       double targetPosition)

Action command to move a single blade set.

Engineering mode only. Blocks until movement is complete.

Parameters:

side - The side of the blade set to move.

targetPosition - The desired relative position after the move.

takeExposure

@Command(type=ACTION,
         level=0,
         description="Performs a timed exposure (open, wait, close)")
public void takeExposure(@Argument(name="exposureTime",description="The duration of the exposure in seconds")
                                                                                                                                       double exposureTime)

An action command that opens the shutter for the given exposure time then closes it. Normal and engineering mode. Blocks until the exposure is complete.

Parameters:

exposureTime - the exposure time in seconds

closeShutter

@Command(type=ACTION,
         level=1,
         description="Closes the shutter")
public void closeShutter()

Closes the shutter. First blade set MINUSX is retracted and then set PLUSX is extended.

openShutter

@Command(type=ACTION,
         level=1,
         description="Opens the shutter")
public void openShutter()

Opens the shutter. First blade set MINUSX is retracted, then set PLUSX.

calibrate

@Command(type=ACTION,
         level=1,
         description="Performs a shutter motion calibration")
public void calibrate()

Does nothing at present.