org.lsst.ccs.daq.ims.example

Class CommandTool

java.lang.Object

org.lsst.ccs.daq.ims.example.CommandTool

public class CommandTool
extends Object

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
CommandTool()

Method Summary

Modifier and Type	Method and Description
void	close()
void	connect(String partition)
void	list(String path)
void	listen()
org.lsst.ccs.utilities.location.LocationSet	locations()
void	mkdir(String folderName)
void	mv(String path, String targetFolderName)
void	purge(String folderName, String delta)
void	read(String path, File dir, int bufferSize, int nThreads)
void	readRaw(String path, File dir, int bufferSize, int nThreads)
void	rm(String path)
void	rmdir(String folderName)
Version	version()
void	write(String targetFolderName, File dir, String pattern)
void	writeRaw(File dir, String targetFolderName, String pattern)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandTool

public CommandTool()

Method Detail

connect

@Command(name="connect",
         description="Connect to a DAQ store")
public void connect(@Argument(name="partition",description="Partition name")
                                                                                            String partition)
                                                                                     throws DAQException

Throws:

DAQException

close

@Command(name="close",
         description="Close DAQ store")
public void close()
                                                                          throws DAQException

Throws:

DAQException

list

@Command(name="list",
         alias="ls",
         description="List folders/files")
public void list(@Argument(name="folder",description="Path",defaultValue="")
                                                                                                       String path)
                                                                                                throws DAQException

Throws:

DAQException

mkdir

@Command(name="mkdir",
         description="Create new folder")
public void mkdir(String folderName)
                                                                            throws DAQException

Throws:

DAQException

rmdir

@Command(name="rmdir",
         description="Delete folder")
public void rmdir(String folderName)
                                                                        throws DAQException

Throws:

DAQException

rm

@Command(name="rm",
         description="Delete image")
public void rm(String path)
                                                                 throws DAQException

Throws:

DAQException

mv

@Command(name="mv",
         description="Move image")
public void mv(String path,
                                                                      String targetFolderName)
                                                               throws DAQException

Throws:

DAQException

locations

@Command(name="locations",
         description="List configured locations")
public org.lsst.ccs.utilities.location.LocationSet locations()
                                                                                                                                   throws DAQException

Throws:

DAQException

version

@Command(name="version",
         description="Get version info")
public Version version()
                                                                                  throws DAQException

Throws:

DAQException

readRaw

@Command(name="readRaw")
public void readRaw(String path,
                                             @Argument(defaultValue=".",description="Folder where .raw (and .meta) files will be written")
                                             File dir,
                                             @Argument(defaultValue="1048576")
                                             int bufferSize,
                                             @Argument(defaultValue="4")
                                             int nThreads)
                                      throws DAQException,
                                             IOException,
                                             nom.tam.fits.FitsException,
                                             InterruptedException,
                                             ExecutionException

Throws:

DAQException

IOException

nom.tam.fits.FitsException

InterruptedException

ExecutionException

writeRaw

@Command(name="writeRaw",
         description="Write a set of .raw images into the 2 day store")
public void writeRaw(File dir,
                                                                                                                       @Argument(defaultValue="emu")
                                                                                                                       String targetFolderName,
                                                                                                                       @Argument(defaultValue="(\\w+)_(R\\d\\d)_(Reb[0-2|W|G]).raw")
                                                                                                                       String pattern)
                                                                                                                throws DAQException,
                                                                                                                       IOException

Throws:

DAQException

IOException

listen

@Command(name="listen",
         description="Listen for images")
public void listen()

read

@Command(name="read",
         description="Read and decode data in image")
public void read(String path,
                                                                                             @Argument(defaultValue=".",description="Folder where FITS files will be written")
                                                                                             File dir,
                                                                                             @Argument(defaultValue="1048576")
                                                                                             int bufferSize,
                                                                                             @Argument(defaultValue="4")
                                                                                             int nThreads)
                                                                                      throws DAQException,
                                                                                             IOException,
                                                                                             nom.tam.fits.FitsException,
                                                                                             InterruptedException,
                                                                                             ExecutionException

Throws:

DAQException

IOException

nom.tam.fits.FitsException

InterruptedException

ExecutionException

write

@Command(name="write",
         description="Write a set of FITS files to the store")
public void write(String targetFolderName,
                                                                                                        File dir,
                                                                                                        @Argument(defaultValue="*.fits")
                                                                                                        String pattern)
                                                                                                 throws IOException,
                                                                                                        nom.tam.fits.TruncatedFileException,
                                                                                                        DAQException

Throws:

IOException

nom.tam.fits.TruncatedFileException

DAQException

purge

@Command(name="purge",
         description="Purge files in a folder older than some delta to make space")
public void purge(String folderName,
                                                                                                                             String delta)
                                                                                                                      throws DAQException

Throws:

DAQException