org.lsst.ccs.daq.utilities

Class FitsServiceHeaderCommands

java.lang.Object

org.lsst.ccs.daq.utilities.FitsServiceHeaderCommands

public class FitsServiceHeaderCommands
extends Object

A set of commands to publish HeaderKeyword data.

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
FitsServiceHeaderCommands(org.lsst.ccs.Agent agent)

Method Summary

Modifier and Type	Method and Description
void	setHeaderKeyword(String name, Serializable value) Set the value of a Header Keyword to be shared by all Fits extensions.
void	setHeaderKeywordForCCD(String ccdId, String name, Serializable value, boolean sticky) Set the value of a header keyword for a given named HDU.
void	setHeaderKeywords(Map<String,Serializable> headersMap) Set the value of a set of Header Keywords to be shared by all Fits extensions.
void	setNamedHeaderKeywords(String hduName, Map<String,Serializable> headersMap) Set the values of a named HDU Header Keywords
void	setPrimaryHeaderKeyword(String name, Serializable value) Set the value of a Primary extension Header Keyword
void	setPrimaryHeaderKeywords(Map<String,Serializable> headersMap) Set the values of Primary Header Keywords

Methods inherited from class java.lang.Object

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

Constructor Detail

FitsServiceHeaderCommands

public FitsServiceHeaderCommands(org.lsst.ccs.Agent agent)

Method Detail

setHeaderKeyword

@Command(type=ACTION,
         description="Set a header keyword value shared by all extensions")
public void setHeaderKeyword(String name,
                                                                                                                               Serializable value)

Set the value of a Header Keyword to be shared by all Fits extensions.

Parameters:

name - The name of the header keyword

value - The value of the header keyword

setHeaderKeywords

@Command(type=ACTION,
         description="Set a header keyword value shared by all extensions")
public void setHeaderKeywords(Map<String,Serializable> headersMap)

Set the value of a set of Header Keywords to be shared by all Fits extensions.

Parameters:

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

setPrimaryHeaderKeyword

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

Set the value of a Primary extension Header Keyword

Parameters:

name - The name of the header keyword

value - The value of the header keyword

setPrimaryHeaderKeywords

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

Set the values of Primary Header Keywords

Parameters:

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

setHeaderKeywordForCCD

@Command(type=ACTION,
         description="Set a header keyword value for a given CCD extension")
public void setHeaderKeywordForCCD(String ccdId,
                                                                                                                                      String name,
                                                                                                                                      Serializable value,
                                                                                                                                      @Argument(defaultValue="false")
                                                                                                                                      boolean sticky)

Set the value of a header keyword for a given named HDU.

Parameters:

ccdId - The Id of the CCD for which this keyword is published

name - The name of the header keyword

value - The value of the header keyword

sticky - If this value is sticky

setNamedHeaderKeywords

@Command(type=ACTION,
         description="Set header keyword values on a named HDU")
public void setNamedHeaderKeywords(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