RaftsMain (LSST CCS - Rafts Subsystem 1.5.0 API)

java.lang.Object
- java.util.Observable
- - org.lsst.ccs.framework.Module
  - - org.lsst.ccs.subsystem.rafts.RaftsMain

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.SignalHandler
```
public class RaftsMain
extends org.lsst.ccs.framework.Module
implements org.lsst.ccs.framework.HardwareController
```
Implements the rafts test subsystem.

Author:

Owen Saxton

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
`RaftsMain(String name, int tickMillis, int monMillis, String configName)` Constructor.
`RaftsMain(String name, int tickMillis, int monMillis, String configName, org.lsst.ccs.drivers.reb.ClientFactory clientFactory)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acquireImage()` Starts image acquisition.
`List<Integer>`	`checkAspics()` Checks all loaded ASPIC values against the configuration.
`List<Integer>`	`checkCabacs()` Checks all loaded CABAC values against the configuration.
`org.lsst.ccs.framework.TreeWalkerDiag`	`checkHardware()` Initializes the hardware.
`void`	`checkStarted()` Checks whether hardware is started.
`void`	`checkStopped()` Checks whether hardware is stopped.
`void`	`enableScan(boolean value)` Sets the scan mode enables.
`List<String>`	`getChannelNames()` Gets the list of monitored channel names.
`double`	`getChannelValue(String name)` Gets a monitored channel value.
`Map<String,Object>`	`getConfigValues()` Gets the list of configured values from all devices.
`List<Integer>`	`getDataSource()` Gets the data sources from all REBs.
`List<String>`	`getDevices()` Gets the list of all device names.
`RaftFullState`	`getFullState()` Gets the full state of the rafts module.
`List<Map<String,Integer>>`	`getFunctionMap()` Gets the list of all function maps.
`static ImageData`	`getImage(String fileName, int offset, int count)` Gets a portion of a saved raw image.
`List<Map<String,Integer>>`	`getMainMap()` Gets the list of all main program maps.
`List<Integer>`	`getParameter(String name)` Gets the list of all values for a parameter.
`List<Map<String,Integer>>`	`getPointers()` Gets the list of all pointer information maps.
`List<String>`	`getREBDevices()` Gets the list of REB device names.
`List<Map<String,Integer>>`	`getSubroutineMap()` Gets the list of all subroutine maps.
`List`	`getTime()` Gets all time base values.
`Map<String,Long>`	`getTimes()` Gets all time base values.
`void`	`initModule()` Initializes the rafts subsystem.
`List<Boolean>`	`isBackBiasOn()` Gets the back bias on states.
`List<Boolean>`	`isScanEnabled()` Gets the scan mode enabled states.
`int`	`loadAspics(boolean all)` Loads ASPICs with their configured values.
`int`	`loadBiasDacs(boolean all)` Loads bias DACs with their configured values.
`int`	`loadCabacs()` Loads all CABACs with their configured values.
`int`	`loadDacs(boolean all)` Loads DACs with their configured values.
`void`	`loadNamedConfig(String name)` Loads a named rafts configuration.
`List<Integer>`	`loadSequencer(String fileName)` Loads all sequencers from a file.
`double`	`readChannelValue(String name)` Reads a monitored channel value.
`void`	`resetFrontEnd()` Resets the front ends.
`void`	`resetScan()` Resets the scan modes.
`List<String>`	`saveFitsImage(String dirName)` Saves the current image data as one or more FITS files.
`List<String>`	`saveImage(String dirName)` Saves the current image data as one or more sets of raw bytes.
`void`	`saveLimits()` Saves the monitoring limits.
`void`	`saveNamedConfig(String name)` Saves a named rafts configuration.
`void`	`sendStep()` Sends a sequencer step command.
`void`	`sendStop()` Sends a sequencer stop command.
`void`	`setBackBias(boolean value)` Sets the back bias on states.
`void`	`setDataSource(int value)` Sets the data sources in all REBs.
`void`	`setDefaultImageDirectory(String dirName)` Sets the default image directory.
`void`	`setExposureTime(double expTime)` Sets the FITS image exposure time.
`void`	`setFitsFileNamePattern(String pattern)` Sets the FITS image file name pattern.
`void`	`setImageDataFileNamePattern(String pattern)` Sets the raw image data file name pattern.
`void`	`setParameter(String name, int value)` Sets a parameter value in all REBs.
`List<Integer>`	`setStart(String mainName)` Sets the start address for all sequencers.
`void`	`setTickMillis(int value)` Sets the tick period.
`void`	`setTime()` Sets the time base to the current system time.
`void`	`startSequencer()` Starts the sequencers.
`void`	`startTicking()` Starts the subsystem.
`void`	`tick()` Performs periodic trending data broadcast.

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, shutdownNow, signal, 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, start, submitChange, submitChanges, validateBulkChange

Constructor Detail
- RaftsMain
```
public RaftsMain(String name,
                 int tickMillis,
                 int monMillis,
                 String configName)
```
  Constructor.
  
  Parameters:
  
  name - The subsystem name.
  
  tickMillis - The tick period (ms).
  
  monMillis - The monitor period (ms).
  
  configName - The name of the configuration.
- RaftsMain
```
public RaftsMain(String name,
                 int tickMillis,
                 int monMillis,
                 String configName,
                 org.lsst.ccs.drivers.reb.ClientFactory clientFactory)
```
  Constructor.
  
  Parameters:
  
  name - The subsystem name.
  
  tickMillis - The tick period (ms).
  
  monMillis - The monitor period (ms).
  
  configName - The name of the configuration.
  
  clientFactory - The client factory that can be used to provide simulated versions of the DAQ.

Method Detail

initModule
```
public void initModule()
```
Initializes the rafts subsystem.

Overrides:

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

checkHardware
```
public org.lsst.ccs.framework.TreeWalkerDiag checkHardware()
```
Initializes the hardware.

Specified by:

checkHardware in interface org.lsst.ccs.framework.HardwareController

Returns:

GO

checkStarted
```
public void checkStarted()
```
Checks whether hardware is started.

Specified by:

checkStarted in interface org.lsst.ccs.framework.HardwareController

checkStopped
```
public void checkStopped()
```
Checks whether hardware is stopped.

Specified by:

checkStopped in interface org.lsst.ccs.framework.HardwareController

startTicking
```
public void startTicking()
```
Starts the subsystem.

Overrides:

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

tick
```
public void tick()
```
Performs periodic trending data broadcast.

Overrides:

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

setTickMillis

@Command(type=ACTION,
         description="Set the tick interval")
public void setTickMillis(@Argument(name="value",description="The tick period (ms)")
                                                                                              int value)

Sets the tick period. Overrides the method in Module in order to publish a status update.

Overrides:: setTickMillis in class org.lsst.ccs.framework.Module
Parameters:: value - The tick period (milliseconds) to set.

saveNamedConfig

@Command(type=ACTION,
         description="Save the current configuration")
public void saveNamedConfig(String name)
                                                                                                  throws IOException

Saves a named rafts configuration.

Parameters:: name - The configuration name
Throws:: IOException

loadNamedConfig

@Command(type=ACTION,
         description="Load a named rafts configuration")
public void loadNamedConfig(String name)
                                                                                                    throws IOException

Loads a named rafts configuration.

Parameters:: name - The configuration name
Throws:: IOException

saveLimits

@Command(type=ACTION,
         description="Save the monitoring limits")
public void saveLimits()
                                                                                         throws IOException

Saves the monitoring limits.

Throws:: IOException

getFullState
```
@Command(type=QUERY,
         description="Get the full Raft module state")
public RaftFullState getFullState()
```
Gets the full state of the rafts module. This is intended to be called by GUIs during initialization

Returns:

The full Raft state

setTime

@Command(type=ACTION,
         description="Set the REBs\' system time")
public void setTime()
                                                                                      throws Exception

Sets the time base to the current system time.

Throws:: Exception

getTimes

@Command(type=QUERY,
         description="Get the REBs\' system times")
public Map<String,Long> getTimes()
                                                                                                   throws Exception

Gets all time base values.

Returns:: The map of REB name vs. time value
Throws:: Exception

getTime

@Command(type=QUERY,
         description="Get the REBs\' system times")
public List getTime()
                                                                                      throws Exception

Gets all time base values.

Returns:: The list of (REB name, time values) pairs
Throws:: Exception

getDevices

@Command(type=QUERY,
         description="Get the list of all devices")
public List<String> getDevices()

Gets the list of all device names.

Returns:: The list of device names

getREBDevices

@Command(type=QUERY,
         description="Get the list of REB devices")
public List<String> getREBDevices()

Gets the list of REB device names.

Returns:: The list of REB device names

getChannelNames

@Command(type=QUERY,
         description="Get the list of channel names")
public List<String> getChannelNames()

Gets the list of monitored channel names.

Returns:: The list of REB device names

getChannelValue

@Command(type=QUERY,
         description="Get a channel value")
public double getChannelValue(@Argument(name="name",description="Channel name")
                                                                                               String name)
                                                                                        throws org.lsst.ccs.drivers.reb.REBException

Gets a monitored channel value.

Parameters:: name - The channel name
Returns:: The last-read channel value
Throws:: org.lsst.ccs.drivers.reb.REBException - if the channel doesn't exist

readChannelValue

@Command(type=QUERY,
         description="Read a channel value")
public double readChannelValue(@Argument(name="name",description="Channel name")
                                                                                                 String name)
                                                                                          throws org.lsst.ccs.drivers.reb.REBException

Reads a monitored channel value.

Parameters:: name - The channel name
Returns:: The read channel value, or NaN if the data isn't available
Throws:: org.lsst.ccs.drivers.reb.REBException - if the channel doesn't exist

getConfigValues

@Command(type=QUERY,
         description="Get the list of all configured values")
public Map<String,Object> getConfigValues()

Gets the list of configured values from all devices.

Returns:: The map of configured values

loadDacs

@Command(type=ACTION,
         description="Load DACs")
public int loadDacs(@Argument(name="all",description="If true, load all DACs")
                                                                            boolean all)
                                                                     throws Exception

Loads DACs with their configured values.

Parameters:: all - If true, all data are loaded; otherwise only changes
Returns:: The number of DACs loaded
Throws:: Exception

loadBiasDacs

@Command(type=ACTION,
         description="Load bias DACs")
public int loadBiasDacs(@Argument(name="all",description="If true, load all bias DACs")
                                                                                     boolean all)
                                                                              throws Exception

Loads bias DACs with their configured values.

Parameters:: all - If true, all data are loaded; otherwise only changes
Returns:: The number of DACs loaded
Throws:: Exception

loadAspics

@Command(type=ACTION,
         description="Load ASPICs")
public int loadAspics(@Argument(name="all",description="If true, load all ASPICs")
                                                                                boolean all)
                                                                         throws Exception

Loads ASPICs with their configured values.

Parameters:: all - If true, all data are loaded; otherwise only changes
Returns:: The number of ASPICs loaded
Throws:: Exception

checkAspics

@Command(type=QUERY,
         description="Check all ASPICs")
public List<Integer> checkAspics()
                                                                                        throws Exception

Checks all loaded ASPIC values against the configuration.

Returns:: A list of mismatch masks, one per REB
Throws:: Exception

loadCabacs

@Command(type=ACTION,
         description="Load all CABACs")
public int loadCabacs()
                                                                             throws Exception

Loads all CABACs with their configured values.

Returns:: The number of CABACs loaded
Throws:: Exception

checkCabacs

@Command(type=QUERY,
         description="Check all CABACs")
public List<Integer> checkCabacs()
                                                                                        throws Exception

Checks all loaded CABAC values against the configuration.

Returns:: A list of mismatch masks, one per configured CABAC
Throws:: Exception

isBackBiasOn

@Command(type=QUERY,
         description="Get the back bias on states")
public List<Boolean> isBackBiasOn()
                                                                                                    throws Exception

Gets the back bias on states.

Returns:: A list of the back bias on states for each REB
Throws:: Exception

setBackBias

@Command(type=ACTION,
         description="Set the back bias on states")
public void setBackBias(@Argument(name="value",description="The back bias on state")
                                                                                                  boolean value)
                                                                                           throws Exception

Sets the back bias on states.

Parameters:: value - The on state to set, true or false
Throws:: Exception

loadSequencer

@Command(type=ACTION,
         description="Load all sequencers from a file")
public List<Integer> loadSequencer(@Argument(name="filename",description="Sequencer file name")
                                                                                                                 String fileName)
                                                                                                          throws Exception,
                                                                                                                 IOException

Loads all sequencers from a file.

Parameters:: fileName - The name of the file containing sequencer instructions
Returns:: A list of the number of slices expected to be read from each REB
Throws:: Exception; IOException

getMainMap

@Command(type=QUERY,
         description="Get the maps of mains")
public List<Map<String,Integer>> getMainMap()

Gets the list of all main program maps.

Returns:: The list of name-to-address maps of main programs

getSubroutineMap

@Command(type=QUERY,
         description="Get the maps of subroutines")
public List<Map<String,Integer>> getSubroutineMap()

Gets the list of all subroutine maps.

Returns:: The list of name-to-address maps of subroutines

getFunctionMap

@Command(type=QUERY,
         description="Get the maps of functions")
public List<Map<String,Integer>> getFunctionMap()

Gets the list of all function maps.

Returns:: The name-to-number map of functions

getPointers

@Command(type=QUERY,
         description="Get the maps of pointers")
public List<Map<String,Integer>> getPointers()

Gets the list of all pointer information maps.

Returns:: The list of name-to-type-and-address maps of pointers

getParameter

@Command(type=QUERY,
         description="Get parameter values")
public List<Integer> getParameter(@Argument(name="name",description="The parameter name")
                                                                                                    String name)
                                                                                             throws Exception

Gets the list of all values for a parameter.

Parameters:: name - The parameter name
Returns:: The list of values, one per REB
Throws:: Exception

setParameter

@Command(type=ACTION,
         description="Set a parameter value")
public void setParameter(@Argument(name="name",description="The parameter name")
                                                                                             String name,
                                                                                             @Argument(name="value",description="The value to set")
                                                                                             int value)
                                                                                      throws Exception

Sets a parameter value in all REBs.

Parameters:: name - The parameter name; value - The value to set
Throws:: Exception

getDataSource

@Command(type=QUERY,
         description="Get the data source")
public List<Integer> getDataSource()
                                                                                             throws Exception

Gets the data sources from all REBs.

Returns:: A list of the encoded data sources (CCD or simulation) for each REB
Throws:: Exception

setDataSource

@Command(type=ACTION,
         description="Set the data sources")
public void setDataSource(@Argument(name="value",description="The data source value")
                                                                                             int value)
                                                                                      throws Exception

Sets the data sources in all REBs.

Parameters:: value - The encoded data source: CCD or simulation
Throws:: Exception

isScanEnabled

@Command(type=QUERY,
         description="Get the scan mode enabled states")
public List<Boolean> isScanEnabled()
                                                                                                          throws Exception

Gets the scan mode enabled states.

Returns:: A list of the scan mode states for each REB
Throws:: Exception

enableScan

@Command(type=ACTION,
         description="Set the scan mode enables")
public void enableScan(@Argument(name="value",description="The scan mode enabled state")
                                                                                               boolean value)
                                                                                        throws Exception

Sets the scan mode enables.

Parameters:: value - The enabled state to set, true or false
Throws:: Exception

resetScan

@Command(type=ACTION,
         description="Reset the scan modes")
public void resetScan()
                                                                                  throws Exception

Resets the scan modes.

Throws:: Exception

setStart

@Command(type=ACTION,
         description="Set all sequencer start addresses")
public List<Integer> setStart(@Argument(name="mainName",description="Main routine name")
                                                                                                              String mainName)
                                                                                                       throws Exception

Sets the start address for all sequencers.

Parameters:: mainName - The name of the main sequencer program to start at
Returns:: A list of the number of slices expected to be read from each REB by this main
Throws:: Exception

startSequencer

@Command(type=ACTION,
         description="Start the sequencers")
public void startSequencer()
                                                                                       throws Exception

Starts the sequencers.

Throws:: Exception

sendStop

@Command(type=ACTION,
         description="Send a sequencer stop command")
public void sendStop()
                                                                                          throws Exception

Sends a sequencer stop command.

Throws:: Exception

sendStep

@Command(type=ACTION,
         description="Send a sequencer step command")
public void sendStep()
                                                                                          throws Exception

Sends a sequencer step command.

Throws:: Exception

resetFrontEnd

@Command(type=ACTION,
         description="Reset the front end")
public void resetFrontEnd()
                                                                                     throws Exception

Resets the front ends.

Throws:: Exception

acquireImage

@Command(type=ACTION,
         description="Start image acquisition")
public void acquireImage()
                                                                                        throws Exception

Starts image acquisition.

Throws:: Exception

saveImage

@Command(type=ACTION,
         description="Save the current image as raw bytes")
public List<String> saveImage(@Argument(name="dirname",description="The directory to use",defaultValue="")
                                                                                                                String dirName)
                                                                                                         throws RaftException,
                                                                                                                IOException

Saves the current image data as one or more sets of raw bytes.

Parameters:: dirName - The name of the directory where the image file is to be saved.
Returns:: A list containing the names of the saved files
Throws:: RaftException; IOException

saveFitsImage

@Command(type=ACTION,
         description="Save the current image as a FITS file")
public List<String> saveFitsImage(@Argument(name="dirname",description="The directory to use",defaultValue="")
                                                                                                                      String dirName)
                                                                                                               throws IOException,
                                                                                                                      RaftException

Saves the current image data as one or more FITS files.

Parameters:: dirName - The name of the directory where the FITS file is to be saved.
Returns:: A list containing the names of the saved files
Throws:: RaftException; IOException

getImage

@Command(type=QUERY,
         description="Get a portion of a saved raw image")
public static ImageData getImage(@Argument(name="filename",description="The image file name")
                                                                                                                 String fileName,
                                                                                                                 @Argument(name="offset",description="The offset to the first pixel")
                                                                                                                 int offset,
                                                                                                                 @Argument(name="count",description="The number of pixels to get")
                                                                                                                 int count)
                                                                                                          throws RaftException,
                                                                                                                 IOException

Gets a portion of a saved raw image.

Parameters:: fileName - The name of the file containing the image; offset - The offset (in pixels) to the first pixel data to obtain.; count - The number of data pixels to obtain.
Returns:: The returned pixel data
Throws:: RaftException; IOException

setDefaultImageDirectory

@Command(type=ACTION,
         description="Set the default image directory")
public void setDefaultImageDirectory(@Argument(name="dirname",description="The directory name")
                                                                                                                   String dirName)

Sets the default image directory.

Parameters:: dirName - The directory name

setFitsFileNamePattern

@Command(type=ACTION,
         description="Set the FITS file name pattern")
public void setFitsFileNamePattern(@Argument(name="pattern",description="The file name pattern")
                                                                                                                String pattern)

Sets the FITS image file name pattern.

Parameters:: pattern - The file name pattern to set

setImageDataFileNamePattern

@Command(type=ACTION,
         description="Set the raw image data file name pattern")
public void setImageDataFileNamePattern(@Argument(name="pattern",description="The file name pattern")
                                                                                                                               String pattern)

Sets the raw image data file name pattern.

Parameters:: pattern - The file name pattern to set

setExposureTime

@Command(type=ACTION,
         description="Set the FITS exposure time")
public void setExposureTime(@Argument(name="exptime",description="The exposure time")
                                                                                                     double expTime)

Sets the FITS image exposure time.

Parameters:: expTime - The exposure time (secs)

Class RaftsMain

Nested Class Summary

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

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

Field Summary

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