org.lsst.ccs.subsystem.daq

Class DaqStoreManageDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.daq.DaqStoreManageDevice

All Implemented Interfaces:

org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle

public class DaqStoreManageDevice
extends org.lsst.ccs.monitor.Device

Device code for managing files in Daq store

Author:

Al Eisner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DaqStoreManageDevice.MonChan Enumeration of monitoring channels

Field Summary

Fields inherited from class org.lsst.ccs.monitor.Device

disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, path, s

Constructor Summary

Constructors

Constructor and Description
DaqStoreManageDevice()

Method Summary

Modifier and Type	Method and Description
protected int[]	checkChannel(String chName, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
protected void	close() Closes the connection.
protected void	initDevice() Performs basic initialization of Device code.
protected void	initialize() Connect to partition and perform any needed initialization.
List<String>	list(String path) List information on contents of partition, a specific folder within partition, or images in a specific file within that folder.
protected double	readChannel(int hwChan, int type) Reads a channel.
void	setPurgeTarget(Double fraction) Set fraction of available disk space which is goal of a file purge
void	setPurgeThreshold(Double fraction) Set fraction of available disk space which triggers a file purge

Methods inherited from class org.lsst.ccs.monitor.Device

addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getFullName, getGroupForChannel, getName, getOutputLines, getPath, init, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readChannelGroup, readChannelNow, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

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.HardwareController

checkStopped

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, postBuild, postInit, postShutdown, postStart, shutdown, start

Constructor Detail

DaqStoreManageDevice

public DaqStoreManageDevice()

Method Detail

initDevice

protected void initDevice()

Performs basic initialization of Device code. Verify that all ConfigurationParameters are set.

Overrides:

initDevice in class org.lsst.ccs.monitor.Device

initialize

protected void initialize()

Connect to partition and perform any needed initialization.

Specified by:

initialize in class org.lsst.ccs.monitor.Device

close

protected void close()

Closes the connection.

Specified by:

close in class org.lsst.ccs.monitor.Device

setPurgeThreshold

@ConfigurationParameterChanger(propertyName="purgeThreshold")
public void setPurgeThreshold(Double fraction)
                                                                                     throws org.lsst.ccs.daq.ims.DAQException

Set fraction of available disk space which triggers a file purge

Parameters:

fraction -

Throws:

org.lsst.ccs.daq.ims.DAQException

setPurgeTarget

@ConfigurationParameterChanger(propertyName="purgeTarget")
public void setPurgeTarget(Double fraction)
                                                                               throws org.lsst.ccs.daq.ims.DAQException

Set fraction of available disk space which is goal of a file purge

Parameters:

fraction -

Throws:

org.lsst.ccs.daq.ims.DAQException

checkChannel

protected int[] checkChannel(String chName,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a channel's parameters for validity.

Overrides:

checkChannel in class org.lsst.ccs.monitor.Device

Parameters:

chName - The channel name

hwChan - The hardware channel number

type - The channel type string

subtype - The channel subtype string

Returns:

A two-element array containing the encoded type [0] and subtype [1] values.

Throws:

Exception - if any errors found in the parameters.

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.monitor.Device

Parameters:

hwChan - The hardware channel number.

type - The encoded channel type returned by checkChannel.

Returns:

The read value

list

@Command(type=QUERY,
         name="list",
         alias="ls",
         description="List DAQ partition contents")
public List<String> list(@Argument(name="path",description="<default=\"\"|folder|folder/file>",defaultValue="")
                                                                                                                                             String path)
                                                                                                                                      throws org.lsst.ccs.daq.ims.DAQException

List information on contents of partition, a specific folder within partition, or images in a specific file within that folder. Code largely taken from example/CommandTool.java in DAQ driver package.

Parameters:

String - path optional - if persent, denotes folder or folder/file

Throws:

org.lsst.ccs.daq.ims.DAQException