Settings

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

Functions related to the magnet controller settings.

Nested types and modules

Module	Description
Convert	Functions related to unit conversions.
Digitise	Functions to digitise values to the discrete magnet controller values which are available.
Limit	Functions related to magnet controller output and ramp rate limits.
RampRate

Functions and values

Function or value	Description
`calibratedRampRates settings` Signature: settings:Settings -> decimal<MeasureProduct<MeasureInverse<s>,MeasureProduct<A,MeasureOne>>> list	Returns the list of calibrated ramp rates available on the magnet controller.
`currentStep settings` Signature: settings:Settings -> decimal<MeasureProduct<A,MeasureOne>>	Returns the digital current step of the magnet controller.
`digitalOutputStepCount arg1` Signature: Settings -> uint16	Returns the number of digital steps for the magnet controller output.
`fieldStep settings` Signature: settings:Settings -> decimal<MeasureProduct<T,MeasureOne>>	Returns the digital magnetic field step of the magnet controller.
`linearFieldCoefficient settings` Signature: settings:Settings -> decimal<MeasureProduct<MeasureInverse<A>,MeasureProduct<T,MeasureOne>>>	Returns the linear proportionality coefficient between current and magnetic field for the magnet controller.
`linearShuntVoltageCoefficient settings` Signature: settings:Settings -> decimal<MeasureProduct<MeasureInverse<A>,MeasureProduct<V,MeasureOne>>>	Returns the linear proportionality coefficient between current and output monitoring shunt voltage for the magnet controller.
`maximumCurrent settings` Signature: settings:Settings -> decimal<MeasureProduct<A,MeasureOne>>	Returns the maximum output current of the magnet controller.
`maximumShuntVoltage settings` Signature: settings:Settings -> decimal<MeasureProduct<V,MeasureOne>>	Returns the output monitoring shunt voltage for the magnet controller at maximum output current.
`outputResolution arg1` Signature: Settings -> int<MeasureProduct<bit,MeasureOne>>	Returns the output resolution of the magnet controller in bits.
`shuntVoltageOffset settings` Signature: settings:Settings -> decimal<MeasureProduct<V,MeasureOne>>	Returns the output monitoring shunt voltage offset of the magnet controller in volts.
`shuntVoltageRmsNoise settings` Signature: settings:Settings -> decimal<MeasureProduct<V,MeasureOne>>	Returns the RMS voltage noise for the output monitoring shunt of the magnet controller.
`shuntVoltageStep settings` Signature: settings:Settings -> decimal<MeasureProduct<V,MeasureOne>>	Returns the output monitoring shunt voltage step size between digital output steps of the magnet controller.
`staticField settings` Signature: settings:Settings -> decimal<MeasureProduct<T,MeasureOne>>	Returns the static field of the magnet controlled by the magnet controller.

Fork me on GitHub