org.lsst.ccs.subsystems.fcs

Class FilterManager

java.lang.Object

org.lsst.ccs.subsystems.fcs.FilterManager

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle

public class FilterManager
extends Object
implements org.lsst.ccs.framework.HasLifecycle

This class's goal is to manage the filters.

Author:

virieux

Field Summary

Fields

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

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.
boolean	containsFilterID(int id) Return true if a filterID is in the map.
boolean	containsFilterName(String filterName) return true if filterName is in FilterManager map.
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.
int	getFilterID(String filterName)
String	getFilterNameByID(int id) Return Return filter name which correspond to ID.
List<String>	getFilterNames()
List<String>	getFilterNamesSortedByFilterID() Returns a list of filter names.
TreeMap<Integer,Filter>	getFiltersMapByID()
TreeMap<String,Filter>	getFiltersMapByName() A getter for the Filters Map sorted by filter name.
void	init()
String	toString()

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.HasLifecycle

build, postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

filtersMapByName

@LookupField(strategy=CHILDREN)
protected final 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 TreeMap<String,Filter> getFiltersMapByName()

A getter for the Filters Map sorted by filter name.

Returns:

getFiltersMapByID

public TreeMap<Integer,Filter> getFiltersMapByID()

Returns:

init

public void init()

Specified by:

init in interface org.lsst.ccs.framework.HasLifecycle

getFilterByName

public Filter getFilterByName(String filterName)

Return a filter which name is given as argument.

Parameters:

filterName -

Returns:

getFilterID

public int getFilterID(String filterName)

getFilterByID

public Filter getFilterByID(int id)

Return Return filter which id is given as argument.

Parameters:

id -

Returns:

containsFilterID

public boolean containsFilterID(int id)

Return true if a filterID is in the map.

Parameters:

id -

Returns:

true if filtersMapByID contains this id.

containsFilterName

public boolean containsFilterName(String filterName)

return true if filterName is in FilterManager map.

Parameters:

filterName -

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:

getFilterNames

public List<String> getFilterNames()

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 the following cases : - 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.

toString

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

Overrides:

toString in class Object