org.lsst.ccs.subsystem.ocsbridge.sim

Interface FilterChangerInterface

All Known Implementing Classes:

FilterChangerComCamSubsystemLayer, FilterChangerSimulation

public interface FilterChangerInterface

An interface to be implemented by all filter changers, real or simulated

Author:

tonyj

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAvailableFilters() Get a map of available filters, containing the (unique) name of each filter and the type of each filter
String	getCurrentFilter() Get the currently installed filter name
Duration	getEstimatedDurationForFilterChange(String filterName) Get the expected (worse-case) duration to move to new filter
List<String>	getInstalledFilters() Get a list of currently installed filters
void	setFilter(String filterName) Set the currently installed filter
void	start(String configName) Start and lock the filter changer, with the specified configuration

Method Detail

getAvailableFilters

Map<String,String> getAvailableFilters()
                                throws ExecutionException

Get a map of available filters, containing the (unique) name of each filter and the type of each filter

Returns:

Throws:

ExecutionException

getInstalledFilters

List<String> getInstalledFilters()
                          throws ExecutionException

Get a list of currently installed filters

Returns:

Throws:

ExecutionException

start

void start(String configName)
    throws ExecutionException

Start and lock the filter changer, with the specified configuration

Parameters:

configName -

Throws:

ExecutionException

getCurrentFilter

String getCurrentFilter()
                 throws ExecutionException

Get the currently installed filter name

Returns:

The installed filter, or ? if none installed

Throws:

ExecutionException

setFilter

void setFilter(String filterName)
        throws ExecutionException

Set the currently installed filter

Parameters:

filterName -

Throws:

ExecutionException - if the command fails

getEstimatedDurationForFilterChange

Duration getEstimatedDurationForFilterChange(String filterName)

Get the expected (worse-case) duration to move to new filter

Parameters:

filterName -

Returns: