org.lsst.ccs.daq.ims

Class Guider

java.lang.Object

org.lsst.ccs.daq.ims.Guider

public class Guider
extends Object

An interface to the DAQ guider.

Author:

tonyj

See Also:

Store.getGuider()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Guider.Subscriber

Constructor Summary

Constructors

Constructor and Description
Guider(Store store, long guider)

Method Summary

Modifier and Type	Method and Description
Config	config()
org.lsst.ccs.utilities.location.LocationSet	getConfiguredLocations()
String	getPartition()
Status	pause()
Status	resume()
Series	series()
Status	sleep()
Status	start(ROICommon common, String id, List<ROILocation> locations) Start the guider, using the specified ROI locations
Status	stop()
Guider.Subscriber	subscribe(Set<org.lsst.ccs.utilities.location.SensorLocation> locations, ByteOrder byteOrder, GuiderListener listener)
void	validate(ROICommon common, List<ROILocation> locations)
Status	wake()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Guider

public Guider(Store store,
              long guider)

Method Detail

start

public Status start(ROICommon common,
                    String id,
                    List<ROILocation> locations)
             throws DAQException

Start the guider, using the specified ROI locations

Parameters:

common - The common settings for this start command

id - The id of this sequence of guider images. From CCS this will normally be the OBSID.

locations - The set of ROIs to start

Returns:

The status after the command completes

Throws:

DAQException

validate

public void validate(ROICommon common,
                     List<ROILocation> locations)
              throws DAQException

Throws:

DAQException

subscribe

public Guider.Subscriber subscribe(Set<org.lsst.ccs.utilities.location.SensorLocation> locations,
                                   ByteOrder byteOrder,
                                   GuiderListener listener)
                            throws DAQException

Throws:

DAQException

stop

public Status stop()
            throws DAQException

Throws:

DAQException

pause

public Status pause()
             throws DAQException

Throws:

DAQException

resume

public Status resume()
              throws DAQException

Throws:

DAQException

sleep

public Status sleep()
             throws DAQException

Throws:

DAQException

wake

public Status wake()
            throws DAQException

Throws:

DAQException

config

public Config config()
              throws DAQException

Throws:

DAQException

series

public Series series()
              throws DAQException

Throws:

DAQException

getPartition

public String getPartition()

getConfiguredLocations

public org.lsst.ccs.utilities.location.LocationSet getConfiguredLocations()
                                                                   throws DAQException

Throws:

DAQException