Rate

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

Functions related to magnet controller ramp rate.

Functions and values

Function or value	Description
`availableValues` Signature: MagnetController -> 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` Signature: MagnetController -> 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: MagnetController -> 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` Signature: MagnetController -> 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` Signature: MagnetController -> 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` Signature: MagnetController -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>> -> int	Returns the index of the nearest available ramp rate value for the magnet controller.
`set` Signature: MagnetController -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>> -> Async<unit>	Asynchronously sets the magnet controller ramp rate.
`setByIndex magnetController i` Signature: magnetController:MagnetController -> i:int -> Async<unit>	Asynchronously sets the magnet controller ramp rate by index.
`setToMaximum magnetController` Signature: magnetController:MagnetController -> Async<unit>	Asynchronously sets the magnet controller ramp rate to the largest available value.