org.lsst.ccs.subsystem.metrology

Class MetrologySubSys

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.metrology.MetrologySubSys

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.CommandExecutor, org.lsst.ccs.messaging.MessageListener, org.lsst.ccs.messaging.StatusMessageListener, org.lsst.ccs.monitor.Monitor.AlarmHandler, org.lsst.ccs.ServiceLifecycle

public class MetrologySubSys
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.monitor.Monitor.AlarmHandler, org.lsst.ccs.messaging.StatusMessageListener

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.Agent

org.lsst.ccs.Agent.RunningCommand

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

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Field Summary

Fields

Modifier and Type	Field and Description
static String	BROADCAST_TASK

Fields inherited from class org.lsst.ccs.Agent

AGENT_HEARTBEAT_TASK, AGENT_RUNTIMEINFO_TASK, commandExecutorLock, currentAction, currentQueries, currentSignals, jvmShutdown, logBusHandler, stateService, treeComponentInitialized

Fields inherited from interface org.lsst.ccs.monitor.Monitor.AlarmHandler

alarms

Constructor Summary

Constructors

Constructor and Description
MetrologySubSys()

Method Summary

Modifier and Type	Method and Description
void	abortMotion() Plot the scan data
void	build() Initializes the aerotech subsystem.
void	doreps(String filename, int nreps, double period) Perform repetitions - repeated measurements at the same positions
int	getDisp_mode() Gets displacement summing mode
int	getState() Gets the operating state word.
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) Handles received status messages
protected void	periodicBroadcast() Performs periodic trending data broadcast.
void	postInit()
void	postStart()
String	printFullState() Prints the full state of aerotech
boolean	processAlarm(int event, int parm, String cause, String alarmName) 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	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) Sets displacement summing mode
void	setState(int state) Sets the Metrology Subsystem state word.
void	soundAlarm()
void	soundBleep()
void	start()
void	startSubSys() startSubSys:
void	stopSubSys() stopSubSys: put TS sub system into the ready state

Methods inherited from class org.lsst.ccs.Subsystem

getLogHandler, getNumberCommandThreads, ping, printRunningCommands, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth

Methods inherited from class org.lsst.ccs.Agent

broadcastStatus, checkAllHardwareStopped, createHelper, executeCommandRequest, getAgentInfo, getAgentPersistenceService, getAgentService, getAgentServices, getCCSVersions, getCommandCount, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getCurrentAction, getDescription, getDistributionInfo, getEnvironmentLockService, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getName, getScheduler, getStatusBroadcastPeriod, helper, initAgent, internalCheckHardware, isConnectedToTheBuses, isInEngineeringMode, populateComponentLookup, preBuild, printComponentNodeTree, publishSubsystemDataOnStatusBus, sendAck, sendNack, sendStatusMessage, setAgentName, shutdownAgent, startAgent, vetoTransitionToNormalMode

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.HasLifecycle

init, postBuild, postShutdown, shutdown

Methods inherited from interface org.lsst.ccs.monitor.Monitor.AlarmHandler

canClearAlert, getAlarmById

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, afterStart, preInit, preShutdown, preStart

Field Detail

BROADCAST_TASK

public static final String BROADCAST_TASK

See Also:

Constant Field Values

Constructor Detail

MetrologySubSys

public MetrologySubSys()

Method Detail

scan

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

Perform scan

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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

Perform scan to a specified file

Parameters:

filename -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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

Perform scan

Parameters:

filename -

startx -

stopx -

starty -

stopy -

dx -

dy -

z -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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,
                                                                            @Argument(name="speed",description="speed")
                                                                            double speed)
                                                                     throws org.lsst.ccs.drivers.commons.DriverException,
                                                                            InterruptedException

Perform scan

Parameters:

filename -

startx -

stopx -

starty -

stopy -

dx -

dy -

z -

speed -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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

Perform PointList scan

Parameters:

filename -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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

Perform PointList scan

Parameters:

filename -

speed -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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

Perform smooth scan

Parameters:

filename -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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

Perform scan

Parameters:

filename -

startx -

stopx -

starty -

stopy -

dx -

dy -

z -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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

Perform scan

Parameters:

filename -

startx -

stopx -

starty -

stopy -

dx -

dy -

z -

speed -

Throws:

org.lsst.ccs.drivers.commons.DriverException

InterruptedException

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:

filename -

nreps -

period -

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)

build

public void build()

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

Specified by:

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

postInit

public void postInit()

Specified by:

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

postStart

public void postStart()

Specified by:

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

start

public void start()

Specified by:

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

periodicBroadcast

protected void periodicBroadcast()

Performs periodic trending data broadcast.

processAlarm

public boolean processAlarm(int event,
                            int parm,
                            String cause,
                            String alarmName)

Handles alarm events.

Specified by:

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

Parameters:

event -

parm -

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

saveConfiguration

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

Saves the configuration data.

Throws:

IOException

printFullState

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

Prints the full state of aerotech

Returns:

The full state as a string

getState

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

Gets the operating state word.

Returns:

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.

Parameters:

state -

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)

Handles received status messages

Specified by:

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

Parameters:

msg -

getDisp_mode

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

Gets displacement summing mode

Returns:

setDisp_mode

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

Sets displacement summing mode

Parameters:

disp_mode -