Cornerstone260Device (LSST Camera Control Software - Test Stand Subsystem 1.1.18 API)

java.lang.Object
- org.lsst.ccs.framework.ConfigurableComponent
- - org.lsst.ccs.subsystem.monitor.Device
  - - org.lsst.ccs.subsystem.teststand.Cornerstone260Device

All Implemented Interfaces:

org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HasLifecycle, MonochromatorDevice, org.lsst.ccs.UsesSubsystem

Direct Known Subclasses:

Cornerstone260SimDevice
```
public class Cornerstone260Device
extends org.lsst.ccs.subsystem.monitor.Device
implements MonochromatorDevice
```
Provides access to the Cornerstone260 methods for the teststand subsystem * @author Homer Neal * **************************************************************************

Nested Class Summary
- 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.subsystem.monitor.Device
  chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, online

Constructor Summary

Constructors
Constructor and Description
`Cornerstone260Device()`
`Cornerstone260Device(String host, int baud)` Constructor * **************************************************************************
`Cornerstone260Device(String host, int baud, int waitForLock)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort()` abort: * **************************************************************************
`void`	`advanceSteps(int param)` advanceSteps: * **************************************************************************
`protected int[]`	`checkChannel(String name, int hwChan, String type, String subtype)` Checks a channel's parameters for validity.
`void`	`close()` Closes connection to a device.
`void`	`closeShutter()` closeShutter: * **************************************************************************
`double`	`getBandpass()` getBandpass: * **************************************************************************
`String`	`getError()` getError: * **************************************************************************
`int`	`getErrorCondition()` getErrorCondition: * * -1 denotes No Error **************************************************************************
`int`	`getFilter()` getFilter: * **************************************************************************
`String`	`getFilterLabel(int filter)` getFilterLabel: * **************************************************************************
`String`	`getGrating()` getGrating: * **************************************************************************
`double`	`getGratingFactor(int grat)` getGratingFactor: * **************************************************************************
`String`	`getGratingLabel(int grat)` getGratingLabel: * **************************************************************************
`int`	`getGratingLines(int grat)` getGratingLines: * **************************************************************************
`double`	`getGratingOffset(int grat)` getGratingOffset: * **************************************************************************
`String`	`getHandshake()` getHandshake: * **************************************************************************
`String`	`getInfo()` getInfo: returns information about the Monochromator
`double`	`getLastband()`
`int`	`getLastfltpos()`
`int`	`getLastgrat()`
`int`	`getLastshut()`
`int`	`getLaststep()`
`int`	`getLastSW1()`
`int`	`getLastSW2()`
`double`	`getLastwl()`
`double`	`getRunWave()` Returns the wl value for acquisition * **************************************************************************
`String`	`getShutter()` getShutter: * **************************************************************************
`int`	`getSlitSize(int slit)` getSlitSize: * **************************************************************************
`int`	`getStep()` getStep: * **************************************************************************
`String`	`getUnits()` getUnits: * **************************************************************************
`double`	`getWave()` getWave: * **************************************************************************
`protected void`	`initChannel(int chan, int type, int subtype)` Initializes a channel.
`protected void`	`initialize()` Initializes the connection.
`boolean`	`isShutterOpen()` isShutterOpen: * **************************************************************************
`void`	`open(String host)` Opens connection to a device.
`void`	`openShutter()` openShutter: * **************************************************************************
`protected double`	`readChannel(int chan, int type)` Reads a channel.
`void`	`setBandpass(double bandpass)` setBandpass: * **************************************************************************
`void`	`setCalibrate(double val)` setCalibrate: * **************************************************************************
`void`	`setFilter(int pos)` setFilter: * **************************************************************************
`void`	`setFilterEdges(double[] edges)` setFilterLabel: * **************************************************************************
`void`	`setFilterLabel(int filter, String label)` setFilterLabel: * **************************************************************************
`void`	`setFilterLabels(String[] labels)` setFilterLabel: * **************************************************************************
`void`	`setGrating(int param)` setGrating: * **************************************************************************
`void`	`setGratingFactor(int grat, double param)` setGratingFactor: * **************************************************************************
`void`	`setGratingLabel(int param, String label)` setGratingLabel: * **************************************************************************
`void`	`setGratingLines(int grat, int param)` setGratingLines: * **************************************************************************
`void`	`setGratingOffset(int grat, double param)` setGratingOffset: * **************************************************************************
`void`	`setHandshake(int flag)` setHandshake: * **************************************************************************
`void`	`setOutport(int num)` setOutport: * **************************************************************************
`void`	`setRunWave(double runWave)` Sets the wl value for acquisition * **************************************************************************
`void`	`setShutter(String param)` setShutter: * **************************************************************************
`void`	`setSlitSize(int slit, int microns)` setSlitSize: * **************************************************************************
`void`	`setTimeout(double tko)` setTimeout: - set the read timeout in sec
`void`	`setUnits(String param)` setUnits: * **************************************************************************
`void`	`setWave(double wv)` setWave: * **************************************************************************
`double`	`setWaveAndFilter(double wv)` setWave: * **************************************************************************

Methods inherited from class org.lsst.ccs.subsystem.monitor.Device
addChannel, addConfigValues, addLine, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getConfigValues, getFullName, getOutputLines, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannelGroup, readChannelNow, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

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, init, isParameterConfigurable, postStart, printConfigurableParameters, setBulkParameter, shutdownNow, start, submitChange, submitChanges, validateBulkChange

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

Methods inherited from interface org.lsst.ccs.UsesSubsystem
getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Constructor Detail

Cornerstone260Device
```
public Cornerstone260Device(String host,
                            int baud)
                     throws org.lsst.ccs.drivers.commons.DriverException
```
Constructor * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

Cornerstone260Device

public Cornerstone260Device(String host,
                            int baud,
                            int waitForLock)
                     throws org.lsst.ccs.drivers.commons.DriverException

Throws:: org.lsst.ccs.drivers.commons.DriverException

Cornerstone260Device

public Cornerstone260Device()
                     throws org.lsst.ccs.drivers.commons.DriverException

Throws:: org.lsst.ccs.drivers.commons.DriverException

Method Detail

open

@Command(name="open",
         description="Open connection to device")
public void open(@Argument(name="host",description="Host name")
                                                                                         String host)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device. * **************************************************************************

Specified by:: open in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

close
```
public void close()
```
Closes connection to a device. * **************************************************************************

Specified by:

close in class org.lsst.ccs.subsystem.monitor.Device

initialize
```
protected void initialize()
```
Initializes the connection. * **************************************************************************

Specified by:

initialize in class org.lsst.ccs.subsystem.monitor.Device

abort

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

abort: * **************************************************************************

Specified by:: abort in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getBandpass

@Command(type=QUERY,
         name="getBandpass",
         description="")
public double getBandpass()
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

getBandpass: * **************************************************************************

Specified by:: getBandpass in interface MonochromatorDevice
Returns:
Throws:: org.lsst.ccs.drivers.commons.DriverException

setBandpass

@Command(name="setBandpass",
         description="")
public void setBandpass(double bandpass)
                                                                       throws org.lsst.ccs.drivers.commons.DriverException

setBandpass: * **************************************************************************

Specified by:: setBandpass in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setCalibrate

@Command(name="setCalibrate",
         description="")
public void setCalibrate(double val)
                                                                         throws org.lsst.ccs.drivers.commons.DriverException

setCalibrate: * **************************************************************************

Specified by:: setCalibrate in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getError

@Command(type=QUERY,
         name="getError",
         description="")
public String getError()
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

getError: * **************************************************************************

Specified by:: getError in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getFilter

@Command(type=QUERY,
         name="getFilter",
         description="")
public int getFilter()
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

getFilter: * **************************************************************************

Specified by:: getFilter in interface MonochromatorDevice
Returns:
Throws:: org.lsst.ccs.drivers.commons.DriverException

setFilter

@Command(name="setFilter",
         description="")
public void setFilter(int pos)
                                                                   throws org.lsst.ccs.drivers.commons.DriverException

setFilter: * **************************************************************************

Specified by:: setFilter in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getFilterLabel
```
@Command(type=QUERY,
         name="getFilterLabel",
         description="")
public String getFilterLabel(int filter)
```
getFilterLabel: * **************************************************************************

Specified by:

getFilterLabel in interface MonochromatorDevice

Parameters:

filter -

Returns:

setFilterLabel

@Command(name="setFilterLabel",
         description="")
public void setFilterLabel(int filter,
                                                                                    String label)

setFilterLabel: * **************************************************************************

Specified by:: setFilterLabel in interface MonochromatorDevice

setFilterLabels
```
@Command(name="setFilterLabels",
         description="")
public void setFilterLabels(String[] labels)
```
setFilterLabel: * **************************************************************************

Specified by:

setFilterLabels in interface MonochromatorDevice

setFilterEdges
```
@Command(name="setFilterEdges",
         description="")
public void setFilterEdges(double[] edges)
```
setFilterLabel: * **************************************************************************

Specified by:

setFilterEdges in interface MonochromatorDevice

getGrating

@Command(type=QUERY,
         name="getGrating",
         description="")
public String getGrating()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

getGrating: * **************************************************************************

Specified by:: getGrating in interface MonochromatorDevice
Returns:
Throws:: org.lsst.ccs.drivers.commons.DriverException

setGrating

@Command(name="setGrating",
         description="")
public void setGrating(int param)
                                                                     throws org.lsst.ccs.drivers.commons.DriverException

setGrating: * **************************************************************************

Specified by:: setGrating in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getGratingLabel

@Command(name="getGratingLabel",
         description="")
public String getGratingLabel(int grat)
                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

getGratingLabel: * **************************************************************************

Specified by:: getGratingLabel in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setGratingLabel

@Command(name="setGratingLabel",
         description="")
public void setGratingLabel(int param,
                                                                                      String label)
                                                                               throws org.lsst.ccs.drivers.commons.DriverException

setGratingLabel: * **************************************************************************

Specified by:: setGratingLabel in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getGratingLines

@Command(name="getGratingLines",
         description="")
public int getGratingLines(int grat)
                                                                              throws org.lsst.ccs.drivers.commons.DriverException

getGratingLines: * **************************************************************************

Specified by:: getGratingLines in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setGratingLines

@Command(name="setGratingLines",
         description="")
public void setGratingLines(int grat,
                                                                                      int param)
                                                                               throws org.lsst.ccs.drivers.commons.DriverException

setGratingLines: * **************************************************************************

Specified by:: setGratingLines in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getGratingFactor

@Command(name="getGratingFactor",
         description="")
public double getGratingFactor(int grat)
                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

getGratingFactor: * **************************************************************************

Specified by:: getGratingFactor in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setGratingFactor

@Command(name="setGratingFactor",
         description="")
public void setGratingFactor(int grat,
                                                                                        double param)
                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

setGratingFactor: * **************************************************************************

Specified by:: setGratingFactor in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getGratingOffset

@Command(name="getGratingOffset",
         description="")
public double getGratingOffset(int grat)
                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

getGratingOffset: * **************************************************************************

Specified by:: getGratingOffset in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setGratingOffset

@Command(name="setGratingOffset",
         description="")
public void setGratingOffset(int grat,
                                                                                        double param)
                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

setGratingOffset: * **************************************************************************

Specified by:: setGratingOffset in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getHandshake

@Command(name="getHandshake",
         description="")
public String getHandshake()
                                                                           throws org.lsst.ccs.drivers.commons.DriverException

getHandshake: * **************************************************************************

Specified by:: getHandshake in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setHandshake

@Command(name="setHandshake",
         description="")
public void setHandshake(int flag)
                                                                         throws org.lsst.ccs.drivers.commons.DriverException

setHandshake: * **************************************************************************

Specified by:: setHandshake in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getInfo

@Command(name="getInfo",
         description="return information about the C260")
public String getInfo()
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

getInfo: returns information about the Monochromator

Specified by:: getInfo in interface MonochromatorDevice
Returns:
Throws:: org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

setOutport

@Command(name="setOutport",
         description="")
public void setOutport(int num)
                                                                     throws org.lsst.ccs.drivers.commons.DriverException

setOutport: * **************************************************************************

Specified by:: setOutport in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getShutter

@Command(type=QUERY,
         name="getShutter",
         description="")
public String getShutter()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

getShutter: * **************************************************************************

Specified by:: getShutter in interface MonochromatorDevice
Returns:
Throws:: org.lsst.ccs.drivers.commons.DriverException

openShutter

@Command(name="openShutter",
         description="")
public void openShutter()
                                                                       throws org.lsst.ccs.drivers.commons.DriverException

openShutter: * **************************************************************************

Specified by:: openShutter in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

closeShutter

@Command(name="closeShutter",
         description="")
public void closeShutter()
                                                                         throws org.lsst.ccs.drivers.commons.DriverException

closeShutter: * **************************************************************************

Specified by:: closeShutter in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

isShutterOpen

@Command(name="isShutterOpen",
         description="")
public boolean isShutterOpen()
                                                                              throws org.lsst.ccs.drivers.commons.DriverException

isShutterOpen: * **************************************************************************

Specified by:: isShutterOpen in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setShutter

@Command(name="setShutter",
         description="")
public void setShutter(String param)
                                                                     throws org.lsst.ccs.drivers.commons.DriverException

setShutter: * **************************************************************************

Specified by:: setShutter in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setSlitSize

@Command(name="setSlitSize",
         description="")
public void setSlitSize(int slit,
                                                                              int microns)
                                                                       throws org.lsst.ccs.drivers.commons.DriverException

setSlitSize: * **************************************************************************

Specified by:: setSlitSize in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getSlitSize

@Command(type=QUERY,
         name="getSlitSize",
         description="")
public int getSlitSize(int slit)
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

getSlitSize: * **************************************************************************

Specified by:: getSlitSize in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getLastwl
```
public double getLastwl()
```
Specified by:

getLastwl in interface MonochromatorDevice

getLastband
```
public double getLastband()
```

getLastfltpos
```
public int getLastfltpos()
```
Specified by:

getLastfltpos in interface MonochromatorDevice

getLastshut
```
public int getLastshut()
```
Specified by:

getLastshut in interface MonochromatorDevice

getLastSW1
```
public int getLastSW1()
```
Specified by:

getLastSW1 in interface MonochromatorDevice

getLastSW2
```
public int getLastSW2()
```
Specified by:

getLastSW2 in interface MonochromatorDevice

getLastgrat
```
public int getLastgrat()
```

getLaststep
```
public int getLaststep()
```

getErrorCondition

@Command(type=QUERY,
         name="getErrorCondition",
         description="")
public int getErrorCondition()
                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

getErrorCondition: * * -1 denotes No Error **************************************************************************

Specified by:: getErrorCondition in interface MonochromatorDevice
Returns:
Throws:: org.lsst.ccs.drivers.commons.DriverException

getStep

@Command(name="getStep",
         description="")
public int getStep()
                                                              throws org.lsst.ccs.drivers.commons.DriverException

getStep: * **************************************************************************

Specified by:: getStep in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

advanceSteps

@Command(name="advanceSteps",
         description="")
public void advanceSteps(int param)
                                                                         throws org.lsst.ccs.drivers.commons.DriverException

advanceSteps: * **************************************************************************

Specified by:: advanceSteps in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getUnits

@Command(name="getUnits",
         description="")
public String getUnits()
                                                                   throws org.lsst.ccs.drivers.commons.DriverException

getUnits: * **************************************************************************

Specified by:: getUnits in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setUnits

@Command(name="setUnits",
         description="")
public void setUnits(String param)
                                                                 throws org.lsst.ccs.drivers.commons.DriverException

setUnits: * **************************************************************************

Specified by:: setUnits in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

getWave

@Command(type=QUERY,
         name="getWave",
         description="")
public double getWave()
                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

getWave: * **************************************************************************

Specified by:: getWave in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setWave

@Command(name="setWave",
         description="")
public void setWave(double wv)
                                                               throws org.lsst.ccs.drivers.commons.DriverException

setWave: * **************************************************************************

Specified by:: setWave in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setTimeout

@Command(name="setTimeout",
         description="set the read timeout")
public void setTimeout(double tko)
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

setTimeout: - set the read timeout in sec

Parameters:: tko -
Throws:: org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

setWaveAndFilter

@Command(name="setWaveAndFilter",
         description="sets wavelength and the corresponding appropriate filter")
public double setWaveAndFilter(double wv)
                                                                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

setWave: * **************************************************************************

Specified by:: setWaveAndFilter in interface MonochromatorDevice
Throws:: org.lsst.ccs.drivers.commons.DriverException

setRunWave
```
@Command(name="setrunwave",
         description="Sets the wl value for acquisition")
public void setRunWave(double runWave)
```
Sets the wl value for acquisition * **************************************************************************

Specified by:

setRunWave in interface MonochromatorDevice

getRunWave
```
@Command(name="getrunwave",
         description="Returns the wl value for acquisition")
public double getRunWave()
```
Returns the wl value for acquisition * **************************************************************************

Specified by:

getRunWave in interface MonochromatorDevice

checkChannel

protected int[] checkChannel(String name,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a channel's parameters for validity. * **************************************************************************

Overrides:: checkChannel in class org.lsst.ccs.subsystem.monitor.Device
Throws:: Exception

initChannel
```
protected void initChannel(int chan,
                           int type,
                           int subtype)
```
Initializes a channel. * **************************************************************************

Overrides:

initChannel in class org.lsst.ccs.subsystem.monitor.Device

readChannel
```
protected double readChannel(int chan,
                             int type)
```
Reads a channel. * **************************************************************************

Overrides:

readChannel in class org.lsst.ccs.subsystem.monitor.Device

Class Cornerstone260Device

Nested Class Summary

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

Field Summary

Fields inherited from class org.lsst.ccs.subsystem.monitor.Device

Constructor Summary

Method Summary

Methods inherited from class org.lsst.ccs.subsystem.monitor.Device

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface org.lsst.ccs.UsesSubsystem

Constructor Detail

Cornerstone260Device

Cornerstone260Device

Cornerstone260Device

Method Detail

open

close

initialize

abort

getBandpass

setBandpass

setCalibrate

getError

getFilter

setFilter

getFilterLabel

setFilterLabel

setFilterLabels

setFilterEdges

getGrating

setGrating

getGratingLabel

setGratingLabel

getGratingLines

setGratingLines

getGratingFactor

setGratingFactor

getGratingOffset

setGratingOffset

getHandshake

setHandshake

getInfo

setOutport

getShutter

openShutter

closeShutter

isShutterOpen

setShutter

setSlitSize

getSlitSize

getLastwl

getLastband

getLastfltpos

getLastshut

getLastSW1

getLastSW2

getLastgrat

getLaststep

getErrorCondition

getStep

advanceSteps

getUnits

setUnits

getWave

setWave

setTimeout

setWaveAndFilter

setRunWave

getRunWave

checkChannel

initChannel

readChannel