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

Constructor Summary

Constructors

Constructor and Description
RaftsMain() No-argument constructor.
RaftsMain(String name, int tickMillis, int monMillis) Constructor.
RaftsMain(String name, int tickMillis, int monMillis, org.lsst.ccs.drivers.reb.ClientFactory clientFactory) Constructor.

Method Summary

Modifier and Type	Method and Description
void	acquireImage() Starts image acquisition.
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware() Initializes the hardware.
void	checkStarted() Checks whether hardware is started.
void	checkStopped() Checks whether hardware is stopped.
RaftFullState	getFullState() Gets the full state of the rafts module.
static ImageData	getImage(String fileName, int offset, int count) Gets a portion of a saved raw image.
void	initModule() Initializes the rafts subsystem.
void	loadNamedConfig(String name) Loads a named rafts configuration.
void	postStart() Starts the subsystem.
void	saveNamedConfig(String name) Saves a named rafts configuration.
void	setTickMillis(int value) Sets the tick period.
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, processUpdate, sendSignal, sendSignalWithTimeLimit, setEnvironment, setName, setNObserverThreads, setObservables, shutdownNow, signal, startTicking, 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()

No-argument constructor.

RaftsMain

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

Constructor.

Parameters:

name - The subsystem name.

tickMillis - The tick period (ms).

monMillis - The monitor period (ms).

RaftsMain

public RaftsMain(String name,
                 int tickMillis,
                 int monMillis,
                 org.lsst.ccs.drivers.reb.ClientFactory clientFactory)

Constructor.

Parameters:

name - The subsystem name.

tickMillis - The tick period (ms).

monMillis - The monitor period (ms).

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

postStart

public void postStart()
               throws org.lsst.ccs.HardwareException

Starts the subsystem.

Specified by:

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

Overrides:

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

Throws:

org.lsst.ccs.HardwareException

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

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

acquireImage

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

Starts image acquisition.

Throws:

Exception

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