org.lsst.ccs.daq.ims

Class Store

java.lang.Object

org.lsst.ccs.daq.ims.Store

All Implemented Interfaces:

AutoCloseable

public class Store
extends Object
implements AutoCloseable

A connection to the store within a specified DAQ partition. A store is the top level object from which all image functionality can be accessed.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
Store(String partition) Connects to a DAQ store.
Store(String partition, ExecutorService executor) Connects to a DAQ store using the specified executor for polling.

Method Summary

Modifier and Type	Method and Description
void	addImageListener(ImageListener l) Add an image listener to this store.
void	close()
Camera	getCamera() Gets the camera associated with this store.
long	getCapacity() The total capacity in bytes of this store.
Catalog	getCatalog() Get the catalog associated with this store.
static Version	getClientVersion()
org.lsst.ccs.utilities.location.LocationSet	getConfiguredSources() Get the set of configured locations in this partition
Emulator	getEmulator() Gets the emulator associated with this store.
Guider	getGuider() Gets an instance of the Guider interface associated with this Store.
String	getPartition() The name of the associated DAQ partition.
RegisterClient	getRegisterClient() Gets the camera associated with this store.The camera can be used to trigger images.
long	getRemaining() The storage capacity remaining (unused) in bytes.
void	removeImageListener(ImageListener l) Remove an image listener.
void	simulateTrigger(org.lsst.ccs.utilities.location.Location location, ImageMetaData meta, int[] registerList, Path rawData) Simulate an image arriving in the 2-day store.

Methods inherited from class java.lang.Object

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

Constructor Detail

Store

public Store(String partition)
      throws DAQException

Connects to a DAQ store. Uses the default executor for polling thread.

Parameters:

partition - The name of the partition

Throws:

DAQException - If the partition does not exist, or something else goes wrong

Store

public Store(String partition,
             ExecutorService executor)
      throws DAQException

Connects to a DAQ store using the specified executor for polling.

Parameters:

partition - The name of the partition

executor - The executor service to use for polling thread

Throws:

DAQException - If the partition does not exist, or something else goes wrong

Method Detail

getCatalog

public Catalog getCatalog()

Get the catalog associated with this store. The catalog can be used to access folders.

Returns:

The catalog associated with this store.

getCamera

public Camera getCamera()
                 throws DAQException

Gets the camera associated with this store. The camera can be used to trigger images.

Returns:

The camera associated with this store.

Throws:

DAQException

getGuider

public Guider getGuider()
                 throws DAQException

Gets an instance of the Guider interface associated with this Store.

Returns:

The Guider

Throws:

DAQException

getEmulator

public Emulator getEmulator()
                     throws DAQException

Gets the emulator associated with this store. This can be used to manage playlists.

Returns:

The emulator associated with this store.

Throws:

DAQException

getRegisterClient

public RegisterClient getRegisterClient()
                                 throws DAQException

Gets the camera associated with this store.The camera can be used to trigger images.

Returns:

The camera associated with this store.

Throws:

DAQException

getPartition

public String getPartition()

The name of the associated DAQ partition.

Returns:

The partition name

getCapacity

public long getCapacity()
                 throws DAQException

The total capacity in bytes of this store.

Returns:

The capacity

Throws:

DAQException - If unable to access to DAQ store

getRemaining

public long getRemaining()
                  throws DAQException

The storage capacity remaining (unused) in bytes.

Returns:

Bytes remaining unused.

Throws:

DAQException - If unable to access the DAQ store

getConfiguredSources

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

Get the set of configured locations in this partition

Returns:

The set of locations configured in this partition

Throws:

DAQException

addImageListener

public void addImageListener(ImageListener l)

Add an image listener to this store. The image listener will be notified of all new images created, in all folders.

Parameters:

l - The image listener to add.

removeImageListener

public void removeImageListener(ImageListener l)

Remove an image listener. The method will perform no action if the listener has not been previously added.

Parameters:

l - The image listener to remove.

close

public void close()
           throws DAQException

Specified by:

close in interface AutoCloseable

Throws:

DAQException

getClientVersion

public static Version getClientVersion()
                                throws DAQException

Throws:

DAQException

simulateTrigger

public void simulateTrigger(org.lsst.ccs.utilities.location.Location location,
                            ImageMetaData meta,
                            int[] registerList,
                            Path rawData)
                     throws DAQException

Simulate an image arriving in the 2-day store. This is implemented crudely since it is only designed to be used for AuxTel on the BTS.

Parameters:

location -

meta -

registerList -

rawData -

Throws:

DAQException