org.lsst.ccs.subsystem.common.ui.focalplane.fpmap

Interface FocalPlaneMapModel

All Superinterfaces:

org.lsst.ccs.gconsole.services.persist.Savable

All Known Implementing Classes:

AbstractFocalPlaneMapModel

public interface FocalPlaneMapModel
extends org.lsst.ccs.gconsole.services.persist.Savable

A data model for FocalPlaneMap.

When FocalPlaneMap paints itself, it calls getValue(...) methods for each cell in order of increasing granularity (RAFT - REB - CCD - Amplifier), stopping at the first method that returns either a non-split value (which is displayed) or null (the default value is displayed). The default value is the value for the closest ancestor cell that is not NONE.

The numbering scheme for RAFTs, REBs, CCDs, and amplifiers follows the standard described in LCA-13381. FocalPlaneMap documentation describes the view orientation.

All methods are called on EDT.

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
void	addFocalPlaneMapModelListener(FocalPlaneMapModelListener listener) Adds a listener to be notified of changes in this model.
default String	getTitle() Returns the title to be displayed by FocalPlaneMap.
default FocalPlaneMapValue	getValue() Returns the default value for cells for which the value is not otherwise specified.
default FocalPlaneMapValue	getValue(int raftX, int raftY) Returns the value for the specified RAFT cell.
default FocalPlaneMapValue	getValue(int raftX, int raftY, int reb) Returns the value for the specified REB cell.
default FocalPlaneMapValue	getValue(int raftX, int raftY, int reb, int ccdY) Returns the value for the specified CCD cell.
default FocalPlaneMapValue	getValue(int raftX, int raftY, int reb, int ccdY, int ampX, int ampY) Returns the value for the specified CCD cell.
void	removeFocalPlaneMapModelListener(FocalPlaneMapModelListener listener) Removes a model listener.

Methods inherited from interface org.lsst.ccs.gconsole.services.persist.Savable

restore, save

Method Detail

getTitle

default String getTitle()

Returns the title to be displayed by FocalPlaneMap.

Returns:

Title, or null is this model does not provide a title.

addFocalPlaneMapModelListener

void addFocalPlaneMapModelListener(FocalPlaneMapModelListener listener)

Adds a listener to be notified of changes in this model.

Parameters:

listener - Listener to be registered.

removeFocalPlaneMapModelListener

void removeFocalPlaneMapModelListener(FocalPlaneMapModelListener listener)

Removes a model listener.

Parameters:

listener - Listener to be removed, or null if all listeners should be removed.

getValue

default FocalPlaneMapValue getValue()

Returns the default value for cells for which the value is not otherwise specified. This value is used unless one of the more specific getValue(...) methods overrides it for a specific display cell. The default implementation returns EMPTY.

Returns:

Value to be displayed, or null if the default value should be used for this raft.

getValue

default FocalPlaneMapValue getValue(int raftX,
                                    int raftY)

Returns the value for the specified RAFT cell. The default implementation returns NONE.

Parameters:

raftX - RAFT X index. Range 0 to 4.

raftY - RAFT Y index. Range 0 to 4.

Returns:

Value to be displayed, or null if the default value should be used for this raft.

getValue

default FocalPlaneMapValue getValue(int raftX,
                                    int raftY,
                                    int reb)

Returns the value for the specified REB cell. The default implementation returns NONE.

Parameters:

raftX - RAFT X index. Range 0 to 4.

raftY - RAFT Y index. Range 0 to 4.

reb - REB index. Range 0 to 2.

Returns:

Value to be displayed, or null if the default value should be used for this REB.

getValue

default FocalPlaneMapValue getValue(int raftX,
                                    int raftY,
                                    int reb,
                                    int ccdY)

Returns the value for the specified CCD cell. The default implementation returns NONE.

Parameters:

raftX - RAFT X index. Range 0 to 4.

raftY - RAFT Y index. Range 0 to 4.

reb - REB index. Range 0 to 2.

ccdY - CCD Y index. Range 0 to 2.

Returns:

Value to be displayed, or null if the default value should be used for this CCD.

getValue

default FocalPlaneMapValue getValue(int raftX,
                                    int raftY,
                                    int reb,
                                    int ccdY,
                                    int ampX,
                                    int ampY)

Returns the value for the specified CCD cell. The default implementation returns null.

Parameters:

raftX - RAFT X index. Range 0 to 4.

raftY - RAFT Y index. Range 0 to 4.

reb - REB index. Range 0 to 2.

ccdY - CCD Y index. Range 0 to 2.

ampX - Amplifier X index. Range 0 to 7.

ampY - Amplifier Y index. Range 0 to 1.

Returns:

Value to be displayed, or null if the default value should be used for this CCD.