Package gda.device

Class TemperatureRamp

java.lang.Object
gda.device.TemperatureRamp
public class TemperatureRamp extends Object
A class that defines a temperature ramp.

  • Constructor Details

    • TemperatureRamp

      public TemperatureRamp()
      default constructor for castor

    • TemperatureRamp

      public TemperatureRamp(int rampNumber)
      Constructor to create a ramp with default data
      Parameters:
      rampNumber - the ramp number, starting with 0

    • TemperatureRamp

      public TemperatureRamp(int rampNumber, double startTemperature, double endTemperature, double rate, double dwellTime, int coolingSpeed)
      Constructor to create a temperature ramp
      Parameters:
      rampNumber - the ramp number
      startTemperature - the start temperature (assuming Celsius)
      endTemperature - the end temperature (assuming Celsius)
      rate - the rate (assuming Celsius / s)
      dwellTime - the dwell time (assuming s)
      coolingSpeed - the cooling speed (could be Celsius / s)

  • Method Details

    • copy

      public TemperatureRamp copy()
      Make an exact copy of an existing temperature ramp
      Returns:
      a duplicate temperature ramp

    • getRampNumber

      public Integer getRampNumber()
      Get the ramp number 0 to n
      Returns:
      the ramp number

    • getStartTemperature

      public Double getStartTemperature()
      Get the starting temperature for a particular ramp
      Returns:
      the start temperature

    • getEndTemperature

      public Double getEndTemperature()
      Get the ending temperature for a particular ramp
      Returns:
      the end temperature

    • getRate

      public Double getRate()
      Get the rate of change in temperature for a particular ramp
      Returns:
      rate of temperature change

    • getDwellTime

      public Double getDwellTime()
      Get the time to dwell and the ending temperature before proceeding to the next ramp
      Returns:
      the dwell time

    • getCoolingSpeed

      public Integer getCoolingSpeed()
      Get the cooling speed setting for a cooling ramp
      Returns:
      the cooling speed

    • setRampNumber

      public void setRampNumber(Integer rampNumber)
      Set the ramp number
      Parameters:
      rampNumber - the ramp number 0 to n

    • setStartTemperature

      public void setStartTemperature(Double startTemperature)
      Set the starting temperature for a particular ramp.
      Parameters:
      startTemperature - the start temperature

    • setEndTemperature

      public void setEndTemperature(Double endTemperature)
      Set the ending temperature for a particular ramp.
      Parameters:
      endTemperature - the end temperature

    • setRate

      public void setRate(Double rate)
      set the rate of change in temperature for a particular ramp
      Parameters:
      rate - ramp rate

    • setDwellTime

      public void setDwellTime(Double dwellTime)
      Set the time to dwell at the ending temperature before proceeding to the next ramp
      Parameters:
      dwellTime - the dwell time

    • setCoolingSpeed

      public void setCoolingSpeed(Integer coolingSpeed)
      Set the cooling speed setting for a cooling ramp
      Parameters:
      coolingSpeed - the cooling speed

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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