Package uk.ac.gda.devices.insitu.model

Class PlateType

java.lang.Object
gda.factory.ConfigurableBase
uk.ac.gda.mx.ispyb.api.container.ContainerTypeBase
uk.ac.gda.devices.insitu.model.PlateType
All Implemented Interfaces:
Configurable, Serializable, ContainerType
Direct Known Subclasses:
GreinerCrystalQuickX2, UnloadedPlateType
public class PlateType extends ContainerTypeBase implements Configurable
PlateType is used to identify the geometry specification of a plate, and enable conversion between physical coordinates and logical well indices. A full specification must include values for typeId, number of rows and columns, and number of drops per well. For a uniformly spaced rectangular layout of wells, use parameters for uniform spacing: (a) set hWellSpacing, vWellSpacing, hWellOffSetList(0), vWellOffsetList(0) (b) during configuration, call initialiseUniformSpacing() that should return true
See Also:

  • Field Details

  • Constructor Details

    • PlateType

      public PlateType()

  • Method Details

    • indexOf

      public static int indexOf(String target, String[] valArray)

    • parseWellEntry

      public static Well parseWellEntry(PlateType ptype, String entry) throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • configure

      public void configure() throws FactoryException
      Description copied from class: ConfigurableBase
      Default implementation for classes that do not have to do any specific configuration.
      Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
      Specified by:
      configure in interface Configurable
      Overrides:
      configure in class ConfigurableBase
      Throws:
      FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

    • reconfigure

      public void reconfigure() throws FactoryException
      Description copied from interface: Configurable
      Re-initialisation of values and states.

      Moved from Reconfigurable which has been deleted

      Specified by:
      reconfigure in interface Configurable
      Overrides:
      reconfigure in class ConfigurableBase
      Throws:
      FactoryException

    • isConfigureAtStartup

      public boolean isConfigureAtStartup()
      Description copied from interface: Configurable
      Indicates whether this object should be configured at startup.

      Moved from ConditionallyConfigurable which has been deleted

      Specified by:
      isConfigureAtStartup in interface Configurable
      Overrides:
      isConfigureAtStartup in class ConfigurableBase

    • copy

      public PlateType copy()

    • getAlphaLabels

      public String[] getAlphaLabels()

    • getColumnLabels

      public String[] getColumnLabels()

    • getFocalOffset

      public Double getFocalOffset(int column)
      Returns:
      Returns value copy of focalOffset for column.

    • getFocalOffsetList

      public List<Double> getFocalOffsetList()

    • gethDropOffset

      public Double gethDropOffset(int index)
      Returns:
      Returns value copy of the hDropOffset at index

    • gethDropOffsetList

      public List<Double> gethDropOffsetList()
      Returns:
      Returns value copy of the hDropOffsetList.

    • gethDropWidth

      public Double gethDropWidth()

    • getNumericLabels

      public String[] getNumericLabels()

    • gethWellOffset

      public Double gethWellOffset(int index)
      Returns:
      Returns value copy of the hWellOffset at index.

    • gethWellOffsetList

      public List<Double> gethWellOffsetList()
      Returns:
      Returns value copy of the hWellOffsetList.

    • gethWellSpacing

      public Double gethWellSpacing()
      Returns:
      Returns value copy of the hWellSpacing

    • getNumColumns

      public int getNumColumns()

    • getNumDrops

      public int getNumDrops()

    • getNumDropsPerWell

      public int getNumDropsPerWell()

    • getNumRows

      public int getNumRows()

    • getNumWells

      public int getNumWells()

    • getOffsets

      public List<Double> getOffsets(int row, int column, int drop)

    • getRowLabels

      public String[] getRowLabels()

    • getSafeOffset

      public Double getSafeOffset(int index)

    • getSafeOffsetList

      public List<Double> getSafeOffsetList()

    • getvDropOffset

      public Double getvDropOffset(int index)
      Returns:
      Returns the vDropOffset.

    • getvDropOffsetList

      public List<Double> getvDropOffsetList()
      Returns:
      Returns value copy of the vDropOffsetList.

    • getvDropWidth

      public Double getvDropWidth()

    • getvWellOffset

      public Double getvWellOffset(int index)
      Returns:
      Returns value copy of the vWellOffset at index.

    • getvWellOffsetList

      public List<Double> getvWellOffsetList()
      Returns:
      Returns value copy of the vWellOffsetList.

    • getvWellSpacing

      public Double getvWellSpacing()
      Returns:
      Returns value copy of the vWellSpacing.

    • getWellIndex

      public int getWellIndex(Well well)

    • getZExpected

      public Double getZExpected()

    • initialiseUniformSpacing

      public boolean initialiseUniformSpacing()

    • isFlipped

      public boolean isFlipped()

    • isPortrait

      public boolean isPortrait()

    • isUniformWellSpacing

      public boolean isUniformWellSpacing()
      Returns:
      Returns the isUniformWellSpacing.

    • parseWellEntry

      public Well parseWellEntry(String entry) throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • setColumnLabels

      public void setColumnLabels(String[] columnLabels)

    • setDropsPerWell

      public void setDropsPerWell(int drops)

    • setFlipped

      public void setFlipped(boolean flipped)
      By default (isFlipped is false) columns are numbered from 0, from right to left as viewed from the detector
      Parameters:
      flipped -

    • setFocalOffset

      public void setFocalOffset(int column, Double offset)

    • setFocalOffsetList

      public void setFocalOffsetList(List<Double> focalOffsetList)
      Parameters:
      focalOffsetList - The focalOffsetList values to set.

    • sethDropOffset

      public void sethDropOffset(int index, Double hDropOffset)
      Parameters:
      hDropOffset - The hDropOffset to set.

    • sethDropOffsetList

      public void sethDropOffsetList(List<Double> hDropOffsetList)
      Parameters:
      hDropOffsetList - The hDropOffsetList to set.

    • sethDropWidth

      public void sethDropWidth(Double hDropWidth)

    • sethWellOffset

      public void sethWellOffset(int index, Double hWellOffset)
      Parameters:
      hWellOffset - The hWellOffset to set.

    • sethWellOffsetList

      public void sethWellOffsetList(List<Double> hWellOffsetList)
      Parameters:
      hWellOffsetList - The hWellOffsetList to set.

    • sethWellSpacing

      public void sethWellSpacing(Double hWellSpacing)
      Parameters:
      hWellSpacing - The hWellSpacing to set.

    • setNumColumns

      public void setNumColumns(int columns)

    • setNumRows

      public void setNumRows(int rows)

    • setPortrait

      public void setPortrait(boolean isPortrait)

    • setRowLabels

      public void setRowLabels(String[] rowLabels)

    • setSafeOffsetList

      public void setSafeOffsetList(List<Double> safeOffsetList)

    • setTypeId

      public void setTypeId(String typeId)
      Specified by:
      setTypeId in interface ContainerType
      Overrides:
      setTypeId in class ContainerTypeBase

    • setUniformWellSpacing

      public void setUniformWellSpacing(boolean isUniformWellSpacing)
      Parameters:
      isUniformWellSpacing - The isUniformWellSpacing to set.

    • setvDropOffset

      public void setvDropOffset(int index, Double vDropOffset)
      Parameters:
      vDropOffset - The vDropOffset to set.

    • setvDropOffsetList

      public void setvDropOffsetList(List<Double> vDropOffsetList)
      Parameters:
      vDropOffsetList - The vDropOffsetList to set.

    • setvDropWidth

      public void setvDropWidth(Double vDropWidth)

    • setvWellOffset

      public void setvWellOffset(int index, Double vWellOffset)
      Parameters:
      vWellOffset - The vWellOffset to set.

    • setvWellOffsetList

      public void setvWellOffsetList(List<Double> vWellOffsetList)
      Parameters:
      vWellOffsetList - The vWellOffsetList to set.

    • setvWellSpacing

      public void setvWellSpacing(Double vWellSpacing)
      Parameters:
      vWellSpacing - The vWellSpacing to set.

    • setZExpected

      public void setZExpected(Double zExpected)

    • validateWell

      public boolean validateWell(Well well)