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

Interface PlateInventory

All Superinterfaces:
Configurable, Findable, gda.observable.IObservable, Serializable
All Known Implementing Classes:
_PlateInventory
public interface PlateInventory extends Findable, gda.observable.IObservable, Configurable, Serializable
The set of services available to a user from the Jython Command line

  • Method Details

    • addPlate

      Plate addPlate(Plate plate)

    • clearInventory

      void clearInventory()

    • findPlateType

      PlateType findPlateType(String typeId)
      Find a PlateType identified by typeId if it exists
      Parameters:
      typeId - the label for PlateType to be found
      Returns:
      PlateType found, otherwise null

    • findPlateIndex

      int findPlateIndex(String barcode)
      Find a PlateType identified by barcode if it exists
      Parameters:
      barcode - the bar code for plate to be found
      Returns:
      index of plate found, otherwise -1

    • getCapacity

      int getCapacity()
      Returns:
      Returns the current hotel inventory capacity on the beamline

    • getCount

      int getCount()

    • getInventory

      List<Plate> getInventory()
      Returns:
      the beamline hotel inventory, representing the physical plates (or logical types) available to load

    • getPlate

      Plate getPlate(int index)
      Retrieve the plate specification from the beamline hotel inventory
      Parameters:
      index - the index of plate in the hotel inventory
      Returns:
      plate the plate specification at the index, or null

    • loadInventory

      void loadInventory() throws org.apache.commons.configuration.ConfigurationException, IOException
      Throws:
      org.apache.commons.configuration.ConfigurationException
      IOException

    • loadInventory

      void loadInventory(String configName) throws org.apache.commons.configuration.ConfigurationException, IOException
      Throws:
      org.apache.commons.configuration.ConfigurationException
      IOException

    • saveInventory

      void saveInventory() throws org.apache.commons.configuration.ConfigurationException
      Throws:
      org.apache.commons.configuration.ConfigurationException

    • saveInventory

      void saveInventory(String configName) throws org.apache.commons.configuration.ConfigurationException
      Throws:
      org.apache.commons.configuration.ConfigurationException

    • setConfigurationName

      void setConfigurationName(String configName)

    • setCapacity

      void setCapacity(int capacity)
      Set the maximum number of plates held in the hotel inventory
      Parameters:
      capacity -

    • setInventory

      void setInventory(List<Plate> inventory)
      Set the list of plates physically (or logically by type) available in the beamline hotel
      Parameters:
      inventory -

    • setPlate

      Plate setPlate(Plate plate, int index)