org.lsst.ccs.subsystem.ocsbridge.sim

Class ComCamFilterChangerSubsystemLayer

java.lang.Object

org.lsst.ccs.subsystem.ocsbridge.sim.ComCamFilterChangerSubsystemLayer

All Implemented Interfaces:

FilterChangerInterface

public class ComCamFilterChangerSubsystemLayer
extends Object
implements FilterChangerInterface

An interface for talking to a real comcam filter changer subsystem.

Author:

tonyj

Field Summary

Fields

Modifier and Type	Field and Description
protected CCS	ccs
protected MCMCommandSender	commandSender
protected MCMConfig	config

Constructor Summary

Constructors

Constructor and Description
ComCamFilterChangerSubsystemLayer(org.lsst.ccs.Subsystem mcm, CCS ccs, MCMConfig config)

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
org.lsst.ccs.bus.data.AgentLock	lockAndSwitchToNormal(int level)
protected void	onConnect(org.lsst.ccs.bus.data.AgentInfo agent, org.lsst.ccs.bus.states.StateBundle initialState) This method is called whenever the target subsystems connects, including initially when the the MCM itself starts up if the target subsystem is already running.
protected void	onDisconnect(org.lsst.ccs.bus.data.AgentInfo agent)
protected void	onEvent(org.lsst.ccs.bus.messages.StatusMessage msg)
protected void	onStateChange(org.lsst.ccs.bus.messages.StatusStateChangeNotification statusChange)
void	setFilter(String filter) Set the currently installed filter
void	start(String configName)
void	unlock()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.subsystem.ocsbridge.sim.FilterChangerInterface

start

Field Detail

config

protected final MCMConfig config

commandSender

protected final MCMCommandSender commandSender

ccs

protected final CCS ccs

Constructor Detail

ComCamFilterChangerSubsystemLayer

public ComCamFilterChangerSubsystemLayer(org.lsst.ccs.Subsystem mcm,
                                         CCS ccs,
                                         MCMConfig config)

Method Detail

setFilter

public void setFilter(String filter)
               throws ExecutionException

Description copied from interface: FilterChangerInterface

Set the currently installed filter

Specified by:

setFilter in interface FilterChangerInterface

Throws:

ExecutionException - if the command fails

getAvailableFilters

public Map<String,String> getAvailableFilters()
                                       throws ExecutionException

Description copied from interface: FilterChangerInterface

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

Specified by:

getAvailableFilters in interface FilterChangerInterface

Returns:

Throws:

ExecutionException

getInstalledFilters

public List<String> getInstalledFilters()
                                 throws ExecutionException

Description copied from interface: FilterChangerInterface

Get a list of currently installed filters

Specified by:

getInstalledFilters in interface FilterChangerInterface

Returns:

Throws:

ExecutionException

getCurrentFilter

public String getCurrentFilter()
                        throws ExecutionException

Description copied from interface: FilterChangerInterface

Get the currently installed filter name

Specified by:

getCurrentFilter in interface FilterChangerInterface

Returns:

The installed filter, or ? if none installed

Throws:

ExecutionException

getEstimatedDurationForFilterChange

public Duration getEstimatedDurationForFilterChange(String filterName)

Description copied from interface: FilterChangerInterface

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

Specified by:

getEstimatedDurationForFilterChange in interface FilterChangerInterface

Returns:

onConnect

protected void onConnect(org.lsst.ccs.bus.data.AgentInfo agent,
                         org.lsst.ccs.bus.states.StateBundle initialState)

This method is called whenever the target subsystems connects, including initially when the the MCM itself starts up if the target subsystem is already running.

onDisconnect

protected void onDisconnect(org.lsst.ccs.bus.data.AgentInfo agent)

onStateChange

protected void onStateChange(org.lsst.ccs.bus.messages.StatusStateChangeNotification statusChange)

onEvent

protected void onEvent(org.lsst.ccs.bus.messages.StatusMessage msg)

lockAndSwitchToNormal

public org.lsst.ccs.bus.data.AgentLock lockAndSwitchToNormal(int level)
                                                      throws ExecutionException

Throws:

ExecutionException

unlock

public void unlock()
            throws ExecutionException

Throws:

ExecutionException

start

public void start(String configName)
           throws ExecutionException

Throws:

ExecutionException