Endorphin.Instrument.Twickenham.MagnetController


RampRate

Namespace: Endorphin.Instrument.Twickenham.MagnetController
Parent Module: Settings

Functions and values

Function or valueDescription
availableValues settings
Signature: settings:Settings -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>> list

Lists the available calibrated ramp rate values for the magnet controller which are within the software-defined ramp rate limit, sorted in ascending order.

fromIndex settings i
Signature: settings:Settings -> i:int -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>>

Returns the calibrated ramp rate value corresponding to the specified ramp rate index for the magnet controller.

maximum
Signature: Settings -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>>

Returns the largest calibrated ramp rate value for the magnet controller which is within the software-defined ramp rate limit.

maximumIndex settings
Signature: settings:Settings -> int

Returns the index of the largest calibrated ramp rate value for the magnet controller which is within the software-defined ramp rate limit.

nearest settings rampRate
Signature: settings:Settings -> rampRate:decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>> -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>>

Returns the nearest available ramp rate value for the magnet controller.

nearestIndex settings rampRate
Signature: settings:Settings -> rampRate:decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>> -> int

Returns the index of the nearest available ramp rate value for the magnet controller.

Fork me on GitHub