org.lsst.ccs.subsystem.rafts

Class RaftsMain

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, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
Map<String,Object>	getConfigValues() Gets the list of configured values from all devices.
List<Integer>	getDataSource() Gets the data sources.
List<String>	getDevices() Gets the list of all device names.
RaftFullState	getFullState() Gets the full state of the vertical slice test module.
ImageData	getImage(String fileName, int offset, int count) Gets a portion of a saved raw image.
List<String>	getREBDevices() Gets the list of REB device names.
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 all ASPICs with their configured values.
int	loadBiasDacs(boolean all) Loads all bias DACs with their configured values.
int	loadCabacs() Loads all CABACs with their configured values.
int	loadDacs(boolean all) Loads all DACs with their configured values.
List<Integer>	loadSequencer(String fileName) Loads all sequencers from a file.
void	resetFrontEnd() Resets the front end.
void	resetScan() Resets the scan modes.
void	saveConfig() Saves the configuration data.
List<String>	saveFitsImage(String dName) Saves the current image data as one or more FITS files.
List<String>	saveImage(String dName) Saves the current image data as one or more sets of raw bytes.
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.
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, getModule, 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, getCheckedValueFromConfiguration, getChildren, getComponentByName, getFullPath, getParent, getParentObject, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, setBulkParameter, start, submitChange, submitChanges, validateBulkChange

Constructor Detail

RaftsMain

public RaftsMain(String name,
                 int tickMillis,
                 int monMillis,
                 String configName)

Main constructor.

Parameters:

name - The subsystem name.

tickMillis - The tick period (ms).

monMillis - The monitor period (ms).

configName - The name of the configuration.

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="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.

Overrides:

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

Parameters:

value - The tick period (milliseconds) to set.

saveConfig

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

Saves the configuration data.

Throws:

IOException

getFullState

@Command(type=QUERY,
         description="Gets the full Raft module state")
public RaftFullState getFullState()

Gets the full state of the vertical slice test module. This is intended to be called by GUIs during initialization

Returns:

The full Raft state

setTime

@Command(type=ACTION,
         description="Sets 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="Gets 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="Gets 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="Gets 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="Gets the list of REB devices")
public List<String> getREBDevices()

Gets the list of REB device names.

Returns:

The list of REB device names

getConfigValues

@Command(type=QUERY,
         description="Gets 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="Loads all DACs")
public int loadDacs(boolean all)
                                                                          throws Exception

Loads all 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="Loads all bias DACs")
public int loadBiasDacs(boolean all)
                                                                                   throws Exception

Loads all 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="Loads all ASPICs")
public int loadAspics(boolean all)
                                                                              throws Exception

Loads all 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="Checks 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="Loads 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="Checks 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="Gets 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="Sets 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="Loads 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

getDataSource

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

Gets the data sources.

Returns:

A list of the encoded data sources (CCD or simulation) for each REB

Throws:

Exception

setDataSource

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

Sets the data sources.

Parameters:

value - The encoded data source: CCD or simulation

Throws:

Exception

isScanEnabled

@Command(type=QUERY,
         description="Gets 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="Sets 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="Resets the scan modes")
public void resetScan()
                                                                                   throws Exception

Resets the scan modes.

Throws:

Exception

startSequencer

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

Starts the sequencers.

Throws:

Exception

sendStop

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

Sends a sequencer stop command.

Throws:

Exception

sendStep

@Command(type=ACTION,
         description="Sends 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 end.

Throws:

Exception

saveImage

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

Saves the current image data as one or more sets of raw bytes. The name of each file is "Image_[reb]_[tag].dat", where [tag] is the 16-digit hexadecimal representation of the image tag, and [reb] is the name of the REB that produced the image.

Parameters:

dName - The name of the directory where the image file is to saved.

Returns:

A list containing the names of the saved files

Throws:

RaftException

IOException

saveFitsImage

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

Saves the current image data as one or more FITS files. Each active CCD on an REB produces a separate file. The name of each file is "Image_[reb]_[ccd]_[tag].fits", where [tag] is the 16-digit hexadecimal representation of the image tag, [reb] is the name of the REB, and [ccd] is the CCD number.

Parameters:

dName - 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="Gets a portion of a saved raw image")
public ImageData getImage(String fileName,
                                                                                                           int offset,
                                                                                                           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