Package org.eclipse.scanning.api.event.scan

Class DeviceInformation<T>

java.lang.Object
org.eclipse.scanning.api.event.scan.DeviceInformation<T>
All Implemented Interfaces:
IModelProvider<T>
public class DeviceInformation<T> extends Object implements IModelProvider<T>
Information about a given device. It may be an IRunnableDevice or an IScannableDevice. The type of information is for displaying the device in the UI.

  • Constructor Details

    • DeviceInformation

      public DeviceInformation()

    • DeviceInformation

      public DeviceInformation(String name)

  • Method Details

    • merge

      public void merge(DeviceInformation<T> info)
      Merges in any non-null fields.
      Parameters:
      info -

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getLabel

      public String getLabel()

    • setLabel

      public void setLabel(String label)

    • getId

      @Deprecated(since="GDA 9.3") public String getId()
      Deprecated.
      the id is no longer needed. It is just a fall back for when the name is not available.

    • setId

      @Deprecated(since="GDA 9.3") public void setId(String id)
      Deprecated.
      the id is no longer needed. It is just a fall back for when the name is not available.

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getIcon

      public String getIcon()

    • setIcon

      public void setIcon(String icon)

    • getDeviceRole

      public DeviceRole getDeviceRole()

    • setDeviceRole

      public void setDeviceRole(DeviceRole deviceRole)

    • getSupportedScanModes

      public Set<ScanMode> getSupportedScanModes()

    • setSupportedScanModes

      public void setSupportedScanModes(Set<ScanMode> supportedScanModes)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getModel

      public T getModel()
      Specified by:
      getModel in interface IModelProvider<T>
      Returns:
      the model that we are providing

    • setModel

      public void setModel(T model)
      Description copied from interface: IModelProvider
      The model for some providers may be set but be warned that others throw an IllegalArgumentException.
      Specified by:
      setModel in interface IModelProvider<T>
      Parameters:
      model -

    • getState

      public DeviceState getState()

    • setState

      public void setState(DeviceState state)

    • getLevel

      public int getLevel()

    • setLevel

      public void setLevel(int level)

    • getUnit

      public String getUnit()

    • setUnit

      public void setUnit(String unit)

    • getUpper

      public Object getUpper()

    • setUpper

      public void setUpper(Object upper)

    • getLower

      public Object getLower()

    • setLower

      public void setLower(Object lower)

    • getPermittedValues

      public Object[] getPermittedValues()

    • setPermittedValues

      public void setPermittedValues(Object[] permittedValues)

    • isActivated

      public boolean isActivated()

    • setActivated

      public boolean setActivated(boolean activated)

    • getHealth

      public String getHealth()

    • setHealth

      public void setHealth(String health)

    • isBusy

      public boolean isBusy()

    • setBusy

      public void setBusy(boolean busy)

    • isAlive

      public boolean isAlive()

    • setAlive

      public void setAlive(boolean alive)

    • getAvailableAxes

      public List<String> getAvailableAxes()

    • setAvailableAxes

      public void setAvailableAxes(List<String> list)

    • getConfiguredAxes

      public List<String> getConfiguredAxes()

    • setConfiguredAxes

      public void setConfiguredAxes(List<String> list)

    • isShownByDefault

      public boolean isShownByDefault()

    • setShownByDefault

      public void setShownByDefault(boolean shownByDefault)

    • getMalcolmVersion

      public MalcolmVersion getMalcolmVersion()

    • setMalcolmVersion

      public void setMalcolmVersion(MalcolmVersion malcolmVersion)

    • getMalcolmDetectorInfos

      public List<MalcolmDetectorInfo> getMalcolmDetectorInfos()

    • setMalcolmDetectorInfos

      public void setMalcolmDetectorInfos(List<MalcolmDetectorInfo> malcolmDetectorInfos)