org.lsst.ccs.subsystems.fcs

Class Filter

java.lang.Object

org.lsst.ccs.subsystems.fcs.Filter

All Implemented Interfaces:

org.lsst.ccs.UsesSubsystem

public class Filter
extends Object
implements org.lsst.ccs.UsesSubsystem

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SOCKET_NAME

Constructor Summary

Constructors

Constructor and Description
Filter(int filterID, double weight, String socketName) Build a filter with an ID and a weight and a socketName.

Method Summary

Modifier and Type	Method and Description
int	getFilterID() Returns filterID as Integer
FcsEnumerations.FilterLocation	getFilterLocation() Returns filter location
String	getSocketName()
double	getWeight() return filter weight
void	initializeFilterLocation() This method is called by FilterLocator during INITIALIZATION to update field filterLocation.
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	setFilterLocation(FcsEnumerations.FilterLocation filterLocation) Set a new location and publishes data.
void	setSocketName(String socketName) To be used by end user to change the value stored in the Configuration system.
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.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Field Detail

SOCKET_NAME

public static final String SOCKET_NAME

See Also:

Constant Field Values

Constructor Detail

Filter

public Filter(int filterID,
              double weight,
              String socketName)

Build a filter with an ID and a weight and a socketName.

Parameters:

filterID -

weight -

socketName -

Method Detail

initializeFilterLocation

public void initializeFilterLocation()

This method is called by FilterLocator during INITIALIZATION to update field filterLocation. It's a bad idea to put this initialization in the constructor because if field socketName has changed it has to be read from configuration system and not from the description groovy file. But constructor reads only the description file.

isOnCarousel

@Command(type=QUERY,
         level=0,
         description="Returns true if filter is held by the carousel.")
public boolean isOnCarousel()

Returns:

true if the filter is held by the carousel.

isOnAutoChanger

@Command(type=QUERY,
         level=0,
         description="Returns true if filter is held by autochanger.")
public boolean isOnAutoChanger()

Returns:

true if the filter is held by the autochanger.

isOut

@Command(type=QUERY,
         level=0,
         description="Returns true if filter is out of camera.")
public boolean isOut()

Returns:

true if the filter is out the camera.

isUnknown

@Command(type=QUERY,
         level=0,
         description="Returns true if filter location is UNKNOWN.")
public boolean isUnknown()

Returns:

true if the location of the filter is unknown.

getFilterLocation

@Command(type=QUERY,
         level=0,
         description="Returns filter location.")
public FcsEnumerations.FilterLocation getFilterLocation()

Returns filter location

Returns:

setFilterLocation

public void setFilterLocation(FcsEnumerations.FilterLocation filterLocation)

Set a new location and publishes data.

Parameters:

filterLocation -

getFilterID

@Command(type=QUERY,
         level=0,
         description="Returns filter id.")
public int getFilterID()

Returns filterID as Integer

Returns:

getWeight

public double getWeight()

return filter weight

Returns:

getSocketName

public String getSocketName()

setSocketName

@ConfigurationParameterChanger
public void setSocketName(String socketName)

To be used by end user to change the value stored in the Configuration system. Tests validity of socket name.

Parameters:

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.

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