org.lsst.ccs.subsystem.rafts

Class VerticalSliceTest

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystem.rafts.VerticalSliceTest

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.SignalHandler

public class VerticalSliceTest
extends org.lsst.ccs.framework.Module
implements org.lsst.ccs.framework.HardwareController

Implements the vertical slice test (VST) modular 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
VerticalSliceTest(String name, int tickMillis, String configName) Main constructor.

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware() Initializes the hardware.
void	checkStarted() Checks whether hardware is started.
void	checkStopped() Checks whether hardware is stopped.
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.
VSTFullState	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 VST subsystem.
List<Integer>	loadSequencer(List<int[]> seqInst) Loads all sequencers from an object.
List<Integer>	loadSequencerFile(String fileName) Loads all sequencers from a file.
void	saveConfiguration() 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	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

alias, getComponentDictionariesTree, getComponentTree, getContext, getEnvironment, getMainDictionary, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, percolateSignal, postStart, processUpdate, publishData, publishData, publishData, publishData, publishData, publishData, publishData, sendSignal, sendSignal, sendSignalWithTimeLimit, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, 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, getDictionary, getParent, getParentObject, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, proceduralWalk, publish, publish, publish, publish, publish, publish, start, treeWalk

Constructor Detail

VerticalSliceTest

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

Main constructor.

Parameters:

name - The subsystem name.

tickMillis - The tick period (ms).

configName - The name of the configuration.

Method Detail

initModule

public void initModule()

Initializes the VST 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.

saveConfiguration

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

Saves the configuration data.

Throws:

IOException

getFullState

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

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

Returns:

The full VST 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

loadSequencerFile

@Command(type=ACTION,
         description="Loads all sequencers from a file")
public List<Integer> loadSequencerFile(@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

loadSequencer

@Command(type=ACTION,
         description="Loads all sequencers from an object")
public List<Integer> loadSequencer(@Argument(name="seqinst",description="Sequencer instructions")
                                                                                                                     List<int[]> seqInst)
                                                                                                              throws Exception

Loads all sequencers from an object.

Parameters:

seqInst - The sequencer instructions to be loaded

Returns:

A list of the number of slices expected to be read from each REB

Throws:

Exception

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

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

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 VSTException,
                                                                                                                 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:

VSTException

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,
                                                                                                                       VSTException

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:

VSTException

IOException

getImage

@Command(type=QUERY,
         description="Gets a portion of a saved raw image")
public ImageData getImage(String fileName,
                                                                                                           int offset,
                                                                                                           int count)
                                                                                                    throws VSTException,
                                                                                                           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:

VSTException

IOException