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.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, org.lsst.ccs.UsesSubsystem

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>	filtersMapByName A map to store the filters that FCS manages.

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

name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
FilterManager()

Method Summary

Modifier and Type	Method and Description
protected void	checkFilterName(String filterName) This method controls if the filter name given at the console by an operator is correct.
Filter	getFilterByID(int id) Return Return filter which id is given as argument.
Filter	getFilterByName(String filterName) Return a filter which name is given as argument.
String	getFilterNameByID(int id) Return Return filter name which correspond to ID.
List<String>	getFilterNamesSortedByFilterID() Returns a list of filter names.
String	getFilterOnAutochangerName() Returns name of filter on autochanger trucks if there is a filter on trucks, returns null otherwise.
SortedMap<Integer,Filter>	getFiltersMapByID()
SortedMap<String,Filter>	getFiltersMapByName() A getter for the Filters Map sorted by filter name.
void	initModule()
void	publishData() Publish filters data to refresh GUI.
void	setFilterLocation(int filterID, FcsEnumerations.FilterLocation filterLocation) For the filter which id is given as argument, set a new location given as argument.
String	toString()

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

getNObserverThreads, getObservables, getTickMillis, init, listens, processUpdate, setNObserverThreads, setObservables, setTickMillis, shutdownNow, 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, dropSubmittedChanges, getChildren, getComponentByName, getEnvironment, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, printConfigurableParameters, setBulkParameter, submitChange, submitChanges, validateBulkChange

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

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

postInit, postShutdown, postStart, start

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

sendSignal, sendSignalWithTimeLimit, signal

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Field Detail

filtersMapByName

protected TreeMap<String,Filter> filtersMapByName

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

Constructor Detail

FilterManager

public FilterManager()

Method Detail

getFiltersMapByName

public SortedMap<String,Filter> getFiltersMapByName()

A getter for the Filters Map sorted by filter name.

Returns:

getFiltersMapByID

public SortedMap<Integer,Filter> getFiltersMapByID()

Returns:

initModule

public void initModule()

Overrides:

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

getFilterByName

public Filter getFilterByName(String filterName)

Return a filter which name is given as argument.

Parameters:

filterName -

Returns:

getFilterByID

public Filter getFilterByID(int id)

Return Return filter which id is given as argument.

Parameters:

id -

Returns:

getFilterNameByID

@Command(type=QUERY,
         level=0,
         description="Return filter name which correspond to ID.")
public String getFilterNameByID(int id)

Return Return filter name which correspond to ID.

Parameters:

id -

Returns:

getFilterNamesSortedByFilterID

public List<String> getFilterNamesSortedByFilterID()

Returns a list of filter names. This list is sorted by filter ID. Useful for initialization of the GUI.

Returns:

checkFilterName

protected void checkFilterName(String filterName)

This method controls if the filter name given at the console by an operator is correct.

Parameters:

filterName -

Throws:

IllegalArgumentException - in this case :

• the name is not a String,
• the name is unknown in the map filters,
• the name is known in the map filters, but the filter location is unknown,
• the name is known in the map filters, but the filter is out of the camera.

setFilterLocation

public void setFilterLocation(int filterID,
                              FcsEnumerations.FilterLocation filterLocation)

For the filter which id is given as argument, set a new location given as argument.

Parameters:

filterID -

filterLocation -

getFilterOnAutochangerName

@Command(type=QUERY,
         level=0,
         description="Returns name of filter on autochanger trucks if there is a filter on trucks,null otherwise.")
public String getFilterOnAutochangerName()

Returns name of filter on autochanger trucks if there is a filter on trucks, returns null otherwise.

Returns:

publishData

@Command(type=QUERY,
         level=0,
         description="Publish filters data to refresh GUI.")
public void publishData()

Publish filters data to refresh GUI.

toString

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

Overrides:

toString in class Object