org.lsst.ccs.subsystems.fcs

Class FilterManager

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.FilterManager

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.SignalHandler

public class FilterManager
extends org.lsst.ccs.framework.Module

This class's goal is to manage the filters.

Author:

virieux

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeMap<String,Filter>	filtersMap A map to store the filters that FCS manages.

Fields inherited from class org.lsst.ccs.framework.Module

environment, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
FilterManager(String name, Filter... oneOrMoreFilters) Creation of a Filter Manager from a list of Filters.

Method Summary

Modifier and Type	Method and Description
Filter	getFilterByName(String filterName)
List<String>	getFilterNames() Return a list of names of filters that this filter manager manages.
List<String>	getFilterNamesSortedByFilterID() Returns a list of filter names.
void	initModule()
String	Test()
String	toString()

Methods inherited from class org.lsst.ccs.framework.Module

getComponentTree, getEnvironment, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, postStart, processUpdate, sendSignal, sendSignalWithTimeLimit, setEnvironment, setName, setNObserverThreads, setObservables, setTickMillis, shutdownNow, signal, startTicking, tick, update

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

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

change, getCheckedValueFromConfiguration, getChildren, getComponentByName, getFullPath, getParent, getParentObject, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, setBulkParameter, start, submitChange, submitChanges, validateBulkChange

Field Detail

filtersMap

protected TreeMap<String,Filter> filtersMap

A map to store the filters that FCS manages. The key of this map is the filter name.

Constructor Detail

FilterManager

public FilterManager(String name,
                     Filter... oneOrMoreFilters)

Creation of a Filter Manager from a list of Filters. This is used by the framework to create a Filter Manager from the list of filters given in description groovy file. The number of filters is variable so to add a filter to this list, the end user has just to add the filter description in the description groovy file.

Parameters:

name -

oneOrMoreFilters -

Method Detail

initModule

public void initModule()

Overrides:

initModule in class org.lsst.ccs.framework.Module

getFilterByName

public Filter getFilterByName(String filterName)

getFilterNames

@Command(type=QUERY,
         description="Return the list of names of filters  that this subsystem manages.",
         level=1,
         alias="listFilterNames")
public List<String> getFilterNames()

Return a list of names of filters that this filter manager manages.

Returns:

getFilterNamesSortedByFilterID

public List<String> getFilterNamesSortedByFilterID()

Returns a list of filter names. This list is sorted by filter ID.

Returns:

Test

@Command(type=QUERY,
         level=0,
         description="To test the filter manager - print the map filtersMap.")
public String Test()

toString

@Command(alias="printFilterList",
         type=QUERY,
         level=0,
         description="Return a printed list of filters.")
public String toString()

Overrides:

toString in class Object