org.lsst.ccs.subsystem.metrology

Class MetrologySubSys

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystem.metrology.MetrologySubSys

All Implemented Interfaces:

Observer, org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, org.lsst.ccs.messaging.AgentPresenceListener, org.lsst.ccs.messaging.MessageListener, org.lsst.ccs.messaging.StatusMessageListener, org.lsst.ccs.subsystem.monitor.Monitor.AlarmHandler, org.lsst.ccs.UsesSubsystem

public class MetrologySubSys
extends org.lsst.ccs.framework.Module
implements org.lsst.ccs.subsystem.monitor.Monitor.AlarmHandler, org.lsst.ccs.messaging.StatusMessageListener, org.lsst.ccs.messaging.AgentPresenceListener

Implements the metrology subsystem for use with Aerotech positioners subsystem.

Author:

Homer Neal * *****************************************************************************

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

name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
MetrologySubSys(String name, int tickMillis, String configName) Main constructor.

Method Summary

Modifier and Type	Method and Description
void	abortMotion() /** Plot the scan data
void	connecting(org.lsst.ccs.bus.data.AgentInfo agent)
void	disconnecting(org.lsst.ccs.bus.data.AgentInfo agent)
void	doreps(String filename, int nreps, double period) Perform repetitions - repeated measurements at the same positions
int	getDisp_mode()
MetrologyFullState	getFullState() Gets the full state of the aerotech module.
int	getState() Gets the operating state word.
void	initModule() Initializes the aerotech subsystem.
void	noStepScan(String filename) Perform smooth scan
void	noStepScan(String filename, double startx, double stopx, double dx, double starty, double stopy, double dy, double z) Perform scan
void	noStepScan(String filename, double startx, double stopx, double dx, double starty, double stopy, double dy, double z, double speed) Perform scan
void	onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage msg)
void	plotscan() /** Plot the scan data
void	plotscan(double rotx, double roty, double rotz)
String	printFullState() Prints the full state of aerotech * * **************************************************************************
void	processAlarm(int event, int parm) Handles alarm events.
void	publishState() Publishes the state of the aerotech This is intended to be called whenever any element of the state is * changed.
void	reinit() reinit devices
void	resetTrip()
void	saveConfiguration() Saves the configuration data.
void	scan() Perform scan
void	scan(String filename, double startx, double stopx, double dx, double starty, double stopy, double dy, double z) Perform scan
void	scan(String filename, double startx, double stopx, double dx, double starty, double stopy, double dy, double z, double speed) Perform scan
void	scanfl(String filename) Perform scan to a specified file
void	scanPL(String filename) Perform PointList scan
void	scanPL(String filename, double speed) Perform PointList scan
protected Object	sendSyncMetrologyCommand(String name, Object... params)
void	setCfgState(int cstate)
void	setCfgStateByName(String selectedstate)
void	setDisp_mode(int disp_mode)
void	setState(int state) Sets the Metrology Subsystem state word.
void	setTickMillis(int value) Sets the tick period.
void	Sleep(double secs) Sleep - what a waste **************************************************************************
void	soundAlarm()
void	soundBleep()
void	start()
void	startSubSys() startSubSys: **************************************************************************
void	stopSubSys() stopSubSys: put TS sub system into the ready state * * @param value The enabled state value to set: 0 = off, ~0 = on.
void	tick() Performs periodic trending data broadcast.

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

getNObserverThreads, getObservables, getTickMillis, init, listens, processUpdate, sendSignal, sendSignalWithTimeLimit, setNObserverThreads, setObservables, shutdownNow, signal, startTicking, 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, getChildren, getComponentByName, getEnvironment, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, printConfigurableParameters, setBulkParameter, submitChange, submitChanges, validateBulkChange

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

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

postStart

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Constructor Detail

MetrologySubSys

public MetrologySubSys(String name,
                       int tickMillis,
                       String configName)

Main constructor. * **************************************************************************

Method Detail

reinit

@Command(type=ACTION,
         description="reinit devices")
public void reinit()

reinit devices

scan

@Command(type=QUERY,
         description="scan a region")
public void scan()
                                                                     throws org.lsst.ccs.drivers.commons.DriverException,
                                                                            InterruptedException,
                                                                            ExecutionException

Perform scan

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

scanfl

@Command(type=QUERY,
         description="scan a region to the specified file")
public void scanfl(@Argument(name="filename",description="filename for storing measurement (.csv)")
                                                                                                    String filename)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException,
                                                                                                    InterruptedException,
                                                                                                    ExecutionException

Perform scan to a specified file

Parameters:

filename -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

scan

@Command(type=QUERY,
         description="scan a region")
public void scan(@Argument(name="filename",description="filename for storing measurement (.csv)")
                                                                            String filename,
                                                                            @Argument(name="startx",description="x start position")
                                                                            double startx,
                                                                            @Argument(name="stopx",description="x stop position")
                                                                            double stopx,
                                                                            @Argument(name="dx",description="x step size")
                                                                            double dx,
                                                                            @Argument(name="starty",description="y start position")
                                                                            double starty,
                                                                            @Argument(name="stopy",description="y stop position")
                                                                            double stopy,
                                                                            @Argument(name="dy",description="y step size")
                                                                            double dy,
                                                                            @Argument(name="z",description="z position")
                                                                            double z)
                                                                     throws org.lsst.ccs.drivers.commons.DriverException,
                                                                            InterruptedException,
                                                                            ExecutionException

Perform scan

Parameters:

startx -

stopx -

starty -

stopy -

dx -

dy -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

scan

@Command(type=QUERY,
         description="scan a region")
public void scan(@Argument(name="filename",description="filename for storing measurement (.csv)")
                                                                            String filename,
                                                                            @Argument(name="startx",description="x start position")
                                                                            double startx,
                                                                            @Argument(name="stopx",description="x stop position")
                                                                            double stopx,
                                                                            @Argument(name="dx",description="x step size")
                                                                            double dx,
                                                                            @Argument(name="starty",description="y start position")
                                                                            double starty,
                                                                            @Argument(name="stopy",description="y stop position")
                                                                            double stopy,
                                                                            @Argument(name="dy",description="y step size")
                                                                            double dy,
                                                                            @Argument(name="dy",description="z position")
                                                                            double z,
                                                                            @Argument(name="speed",description="speed")
                                                                            double speed)
                                                                     throws org.lsst.ccs.drivers.commons.DriverException,
                                                                            InterruptedException,
                                                                            ExecutionException

Perform scan

Parameters:

startx -

stopx -

starty -

stopy -

dx -

dy -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

scanPL

@Command(type=QUERY,
         description="scan a region")
public void scanPL(@Argument(name="filename",description="filename for storing measurement (.csv)")
                                                                              String filename)
                                                                       throws org.lsst.ccs.drivers.commons.DriverException,
                                                                              InterruptedException,
                                                                              ExecutionException

Perform PointList scan

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

scanPL

@Command(type=QUERY,
         description="scan a region")
public void scanPL(@Argument(name="filename",description="filename for storing measurement (.csv)")
                                                                              String filename,
                                                                              @Argument(name="speed",description="speed")
                                                                              double speed)
                                                                       throws org.lsst.ccs.drivers.commons.DriverException,
                                                                              InterruptedException,
                                                                              ExecutionException

Perform PointList scan

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

noStepScan

@Command(type=QUERY,
         description="scan a region")
public void noStepScan(@Argument(name="filename",description="filename for storing measurement (.csv)")
                                                                                  String filename)
                                                                           throws org.lsst.ccs.drivers.commons.DriverException,
                                                                                  InterruptedException,
                                                                                  ExecutionException

Perform smooth scan

Parameters:

filename -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

noStepScan

@Command(type=QUERY,
         description="scan a region")
public void noStepScan(@Argument(name="filename",description="filename for storing measurement (.csv)")
                                                                                  String filename,
                                                                                  @Argument(name="startx",description="x start position")
                                                                                  double startx,
                                                                                  @Argument(name="stopx",description="x stop position")
                                                                                  double stopx,
                                                                                  @Argument(name="dx",description="x step size")
                                                                                  double dx,
                                                                                  @Argument(name="starty",description="y start position")
                                                                                  double starty,
                                                                                  @Argument(name="stopy",description="y stop position")
                                                                                  double stopy,
                                                                                  @Argument(name="dy",description="y step size")
                                                                                  double dy,
                                                                                  @Argument(name="z",description="z position")
                                                                                  double z)
                                                                           throws org.lsst.ccs.drivers.commons.DriverException,
                                                                                  InterruptedException,
                                                                                  ExecutionException

Perform scan

Parameters:

filename -

startx -

stopx -

starty -

stopy -

dx -

dy -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

noStepScan

@Command(type=QUERY,
         description="scan a region")
public void noStepScan(@Argument(name="filename",description="filename for storing measurement (.csv)")
                                                                                  String filename,
                                                                                  @Argument(name="startx",description="x start position")
                                                                                  double startx,
                                                                                  @Argument(name="stopx",description="x stop position")
                                                                                  double stopx,
                                                                                  @Argument(name="dx",description="x step size")
                                                                                  double dx,
                                                                                  @Argument(name="starty",description="y start position")
                                                                                  double starty,
                                                                                  @Argument(name="stopy",description="y stop position")
                                                                                  double stopy,
                                                                                  @Argument(name="dy",description="y step size")
                                                                                  double dy,
                                                                                  @Argument(name="z",description="z position")
                                                                                  double z,
                                                                                  @Argument(name="speed",description="speed")
                                                                                  double speed)
                                                                           throws org.lsst.ccs.drivers.commons.DriverException,
                                                                                  InterruptedException,
                                                                                  ExecutionException

Perform scan

Parameters:

filename -

startx -

stopx -

starty -

stopy -

dx -

dy -

speed -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

ExecutionException

doreps

@Command(type=QUERY,
         description="do repeated measurements at the same positions")
public void doreps(@Argument(name="filename",description="filename for storing measurement ")
                                                                                                               String filename,
                                                                                                               @Argument(name="nreps",description="number of repetitions")
                                                                                                               int nreps,
                                                                                                               @Argument(name="period",description="period in seconds")
                                                                                                               double period)
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Perform repetitions - repeated measurements at the same positions

Parameters:

startx -

nreps -

Throws:

org.lsst.ccs.drivers.commons.DriverException

plotscan

@Command(description="plot the scan data")
public void plotscan()
                                                         throws org.lsst.ccs.drivers.commons.DriverException

/** Plot the scan data

Throws:

org.lsst.ccs.drivers.commons.DriverException

abortMotion

@Command(description="abort motion")
public void abortMotion()
                                                      throws org.lsst.ccs.drivers.commons.DriverException

/** Plot the scan data

Throws:

org.lsst.ccs.drivers.commons.DriverException

sendSyncMetrologyCommand

protected Object sendSyncMetrologyCommand(String name,
                                          Object... params)

plotscan

@Command(description="plot the scan data")
public void plotscan(@Argument(name="rotation_x",description="rotation about the x axis")
                                                                double rotx,
                                                                @Argument(name="rotation_y",description="rotation about the y axis")
                                                                double roty,
                                                                @Argument(name="rotation_z",description="rotation about the z axis")
                                                                double rotz)
                                                         throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

initModule

public void initModule()

Initializes the aerotech subsystem. ccdDevc; BiasDevice biasDevc; PhotoDiodeDevice pdDevc; CryoDevice cryoDevc; VacuumGaugeDevice vacDevc; MonochromatorDevice monoDevc; Fe55Device fe55Devc; EnviroDevice envDevc;

Overrides:

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

start

public void start()

Specified by:

start in interface org.lsst.ccs.framework.HasLifecycle

tick

public void tick()

Performs periodic trending data broadcast. * **************************************************************************

Overrides:

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

setTickMillis

@Command(type=ACTION,
         description="Sets the tick interval")
public void setTickMillis(int value)

Sets the tick period. * * Overrides the method in Module in order to publish a status update. * * @param value The tick period (milliseconds) to set. * **************************************************************************

Overrides:

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

Parameters:

value -

processAlarm

public void processAlarm(int event,
                         int parm)

Handles alarm events. * **************************************************************************

Specified by:

processAlarm in interface org.lsst.ccs.subsystem.monitor.Monitor.AlarmHandler

soundAlarm

@Command(name="soundAlarm")
public void soundAlarm()

soundBleep

@Command(name="soundBleep")
public void soundBleep()

resetTrip

@Command(name="resetTrip",
         description="reset trips etc...")
public void resetTrip()

startSubSys

@Command(type=ACTION,
         description="Start the metrology subsystem")
public void startSubSys()
                                                                                             throws Exception

startSubSys: **************************************************************************

Throws:

Exception

stopSubSys

@Command(name="stopsubsys",
         type=ACTION,
         description="Stop and set the Aerotech sub system into the ready state")
public void stopSubSys()

stopSubSys: put TS sub system into the ready state * * @param value The enabled state value to set: 0 = off, ~0 = on. * * @param publish If true, publish the new state on the status bus. * **************************************************************************

saveConfiguration

@Command(name="saveconfig",
         type=ACTION,
         description="Saves the current configuration")
public void saveConfiguration()
                                                                                                                                 throws IOException

Saves the configuration data. * **************************************************************************

Throws:

IOException

getFullState

@Command(type=QUERY,
         description="Gets the full aerotech state")
public MetrologyFullState getFullState()

Gets the full state of the aerotech module. * * This is intended to be called by GUIs during initialization * **************************************************************************

printFullState

@Command(name="printfullstate",
         type=QUERY,
         description="Prints the full aerotech state")
public String printFullState()

Prints the full state of aerotech * * **************************************************************************

getState

@Command(name="getstate",
         type=QUERY,
         description="Returns the current value of the TS state")
public int getState()

Gets the operating state word. * * @return The current value of the operating state * **************************************************************************

setCfgState

@Command(description="Sets the configuration state.")
public void setCfgState(int cstate)

setCfgStateByName

@Command(description="Sets the configuration state.")
public void setCfgStateByName(String selectedstate)

setState

@Command(name="setstate",
         type=QUERY,
         description="sets the current value of the TS state")
public void setState(int state)

Sets the Metrology Subsystem state word. **************************************************************************

Sleep

public void Sleep(double secs)

Sleep - what a waste **************************************************************************

publishState

@Command(name="publishState",
         type=QUERY,
         description="publishes the Aerotech state")
public void publishState()

Publishes the state of the aerotech This is intended to be called whenever any element of the state is * changed. **************************************************************************

onStatusMessage

public void onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage msg)

Specified by:

onStatusMessage in interface org.lsst.ccs.messaging.StatusMessageListener

connecting

public void connecting(org.lsst.ccs.bus.data.AgentInfo agent)

Specified by:

connecting in interface org.lsst.ccs.messaging.AgentPresenceListener

disconnecting

public void disconnecting(org.lsst.ccs.bus.data.AgentInfo agent)

Specified by:

disconnecting in interface org.lsst.ccs.messaging.AgentPresenceListener

getDisp_mode

@Command(type=QUERY,
         description="get displacememt summing mode")
public int getDisp_mode()

Returns:

setDisp_mode

@Command(type=QUERY,
         description="set displacememt summing mode")
public void setDisp_mode(int disp_mode)

Parameters:

disp_mode -