org.lsst.ccs.subsystems.fcs

Class Filter

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystems.fcs.Filter

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable

public class Filter
extends org.lsst.ccs.framework.ConfigurableComponent

This is a model for an optical filter for the camera.

Nested Class Summary

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

org.lsst.ccs.framework.Configurable.Environment

Field Summary

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

environment

Constructor Summary

Constructors

Constructor and Description
Filter(String name, int id, double weight)

Method Summary

Modifier and Type	Method and Description
void	changeLocation(FcsEnumerations.FilterLocation filterLocation) Change the location of the filter and publish on the bus.
Integer	getFilterID()
FcsEnumerations.FilterLocation	getFilterLocation()
String	getSocketName()
double	getWeight()
boolean	isOnAutoChanger()
boolean	isOnCarousel()
boolean	isOut()
boolean	isUnknown()
void	publishData() Creates an object StatusDataPublishedByFilter and publishes it on the Status Bus for trending data base and GUIs.
void	putFilterOnSocket(String socketName) This filter is now on carousel in socket given by its name.
void	removeFromCarousel() This method is call by the CarouselSocket when the filter is not seen anymore by the filter presence sensor at STANDBY position.
void	setFilterID(Integer filterID)
void	setFilterLocation(FcsEnumerations.FilterLocation filterLocation)
void	setName(String name)
void	setSocketName(String socketName)
void	setWeight(double weight)
String	toString()

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

getChildren, getEnvironment, setEnvironment

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, getComponentByName, getFullPath, getName, getParent, getParentObject, getSubsystem, init, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, postStart, setBulkParameter, shutdownNow, start, submitChange, submitChanges, validateBulkChange

Constructor Detail

Filter

public Filter(String name,
              int id,
              double weight)

Method Detail

setName

public void setName(String name)

isOnCarousel

public boolean isOnCarousel()

Returns:

true if the filter is held by the carousel.

isOnAutoChanger

public boolean isOnAutoChanger()

Returns:

true if the filter is held by the autochanger.

isOut

public boolean isOut()

Returns:

true if the filter is out the camera.

isUnknown

public boolean isUnknown()

Returns:

true if the location of the filter is unknown.

getFilterLocation

public FcsEnumerations.FilterLocation getFilterLocation()

setFilterLocation

public void setFilterLocation(FcsEnumerations.FilterLocation filterLocation)

getFilterID

public Integer getFilterID()

setFilterID

public void setFilterID(Integer filterID)

getWeight

public double getWeight()

setWeight

public void setWeight(double weight)

getSocketName

public String getSocketName()

setSocketName

public void setSocketName(String socketName)

putFilterOnSocket

public void putFilterOnSocket(String socketName)

This filter is now on carousel in socket given by its name. It publishes data to update the GUI.

Parameters:

socketName -

removeFromCarousel

public void removeFromCarousel()

This method is call by the CarouselSocket when the filter is not seen anymore by the filter presence sensor at STANDBY position. When a filter is removed from CAROUSEL, the only place it can go it's the AUTOCHANGER.

changeLocation

public void changeLocation(FcsEnumerations.FilterLocation filterLocation)

Change the location of the filter and publish on the bus.

Parameters:

filterLocation -

publishData

public void publishData()

Creates an object StatusDataPublishedByFilter and publishes it on the Status Bus for trending data base and GUIs.

toString

@Command(alias="printFilter",
         type=QUERY,
         level=0,
         description="Return a printed filter.")
public String toString()

Overrides:

toString in class Object