Package uk.ac.gda.analysis.mscan

Record Class MalcolmProcessingManager.Config

java.lang.Object
java.lang.Record
uk.ac.gda.analysis.mscan.MalcolmProcessingManager.Config
Record Components:
dataRank - the rank of the data taken at each point of the scan, i.e. 2 for an image
detFileNameSuffix - the suffix of the file name of the nexus/h5 file to process
dataPath - the path to the dataset to process
uidPath - the path to the uid dataset
detName - the name of the detector/device
nexusBaseClass - the nexus base class for the
datasetConverter - applies a transformation to the dataset, if null the original dataset is used as-is
Enclosing class:
MalcolmProcessingManager
public static record MalcolmProcessingManager.Config(int dataRank, String detFileNameSuffix, String dataPath, String uidPath, String detName, NexusBaseClass nexusBaseClass, DatasetCreator datasetConverter) extends Record

  • Constructor Details

    • Config

      public Config(int dataRank, String detFileNameSuffix, String dataPath, String uidPath, String detName, NexusBaseClass nexusBaseClass, DatasetCreator datasetConverter)
      Creates an instance of a Config record class.
      Parameters:
      dataRank - the value for the dataRank record component
      detFileNameSuffix - the value for the detFileNameSuffix record component
      dataPath - the value for the dataPath record component
      uidPath - the value for the uidPath record component
      detName - the value for the detName record component
      nexusBaseClass - the value for the nexusBaseClass record component
      datasetConverter - the value for the datasetConverter record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • dataRank

      public int dataRank()
      Returns the value of the dataRank record component.
      Returns:
      the value of the dataRank record component

    • detFileNameSuffix

      public String detFileNameSuffix()
      Returns the value of the detFileNameSuffix record component.
      Returns:
      the value of the detFileNameSuffix record component

    • dataPath

      public String dataPath()
      Returns the value of the dataPath record component.
      Returns:
      the value of the dataPath record component

    • uidPath

      public String uidPath()
      Returns the value of the uidPath record component.
      Returns:
      the value of the uidPath record component

    • detName

      public String detName()
      Returns the value of the detName record component.
      Returns:
      the value of the detName record component

    • nexusBaseClass

      public NexusBaseClass nexusBaseClass()
      Returns the value of the nexusBaseClass record component.
      Returns:
      the value of the nexusBaseClass record component

    • datasetConverter

      public DatasetCreator datasetConverter()
      Returns the value of the datasetConverter record component.
      Returns:
      the value of the datasetConverter record component