org.lsst.ccs.subsystem.focalplane

Class ScriptingCommands

java.lang.Object

org.lsst.ccs.subsystem.focalplane.ScriptingCommands

public class ScriptingCommands
extends Object

Commands that are useful when running the focal plane subsystem with scripting

Author:

tonyj

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptingCommands.FileList A simple extension of List<File> which add an extra utility method for getting the common root directory of all the files in the list.

Method Summary

Modifier and Type	Method and Description
void	setHeaderKeyword(String hduName, Map<String,Serializable> headersMap) Set the values of a named HDU Header Keywords
void	setHeaderKeyword(String hduName, String name, Serializable value) Set the value of a named HDU Header Keyword
void	setPrimaryHeaderKeyword(Map<String,Serializable> headersMap) Set the values of Primary Header Keywords
void	setPrimaryHeaderKeyword(String name, Serializable value) Set the value of Primary Header Keyword
ScriptingCommands.FileList	waitForFitsFiles(Duration timeout) Wait until all FITS files have been written.
void	waitForImages(Duration timeout) Wait until all images have been received from the DAQ (but not necessarily written as FITS files)
void	waitForSequencer(Duration timeout) Wait until the sequencer stops.

Methods inherited from class java.lang.Object

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

Method Detail

waitForFitsFiles

@Command(type=QUERY,
         description="Wait for FITS files to be saved",
         level=0,
         autoAck=false)
public ScriptingCommands.FileList waitForFitsFiles(@Argument(defaultValue="PT30S")
                                                                                                                                                                          Duration timeout)

Wait until all FITS files have been written.

Parameters:

timeout - The maximum duration to wait

Returns:

The list of files which were written

waitForImages

@Command(type=QUERY,
         description="Wait for image data to arrive",
         level=0,
         autoAck=false)
public void waitForImages(@Argument(defaultValue="PT30S")
                                                                                                                                               Duration timeout)

Wait until all images have been received from the DAQ (but not necessarily written as FITS files)

Parameters:

timeout - The maximum duration to wait

waitForSequencer

@Command(type=QUERY,
         description="Wait for sequencer to stop",
         level=0,
         autoAck=false)
public void waitForSequencer(@Argument(defaultValue="PT30S")
                                                                                                                                               Duration timeout)

Wait until the sequencer stops.

Parameters:

timeout -

setPrimaryHeaderKeyword

@Command(type=QUERY,
         description="Set a primary header keyword value")
public void setPrimaryHeaderKeyword(String name,
                                                                                                                    Serializable value)

Set the value of Primary Header Keyword

Parameters:

name - The name of the header keyword

value - The value of the header keyword

setPrimaryHeaderKeyword

@Command(type=QUERY,
         description="Set primary header keyword values")
public void setPrimaryHeaderKeyword(Map<String,Serializable> headersMap)

Set the values of Primary Header Keywords

Parameters:

headersMap - The map of header keyword name, value pairs to be set

setHeaderKeyword

@Command(type=QUERY,
         description="Set a header keyword value on a named HDU")
public void setHeaderKeyword(String hduName,
                                                                                                                    String name,
                                                                                                                    Serializable value)

Set the value of a named HDU Header Keyword

Parameters:

hduName - The name of the HDU on which to set the header keyword

name - The name of the header keyword

value - The value of the header keyword

setHeaderKeyword

@Command(type=QUERY,
         description="Set header keyword values on a named HDU")
public void setHeaderKeyword(String hduName,
                                                                                                                   Map<String,Serializable> headersMap)

Set the values of a named HDU Header Keywords

Parameters:

hduName - The name of the HDU on which to set the header keyword

headersMap - The map of header keyword name, value pairs to be set