Current

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

Functions related to the output current of the magnet controller.

Functions and values

Function or value	Description
`digitise` Signature: MagnetController -> decimal<MeasureProduct<A,MeasureOne>> -> decimal<MeasureProduct<A,MeasureOne>>	Returns the nearest digitised output current value of the magnet controller.
`fromMagneticField` Signature: MagnetController -> decimal<MeasureProduct<T,MeasureOne>> -> CurrentDirection * decimal<MeasureProduct<A,MeasureOne>>	Returns the current direction and output current corresponding to the specified magnetic field for the magnet controller.
`fromShuntVoltage` Signature: MagnetController -> decimal<MeasureProduct<V,MeasureOne>> -> decimal<MeasureProduct<A,MeasureOne>>	Returns the output current corresponding to the specified monitoring shunt voltage readout for the magnet controller.
`fromStepIndex` Signature: MagnetController -> uint16 -> decimal<MeasureProduct<A,MeasureOne>>	Returns the output current corresponding to the specified digital step index for the magnet controller.
`limit` Signature: MagnetController -> decimal<MeasureProduct<A,MeasureOne>>	Returns the software-defined current limit for the magnet controller.
`maximum` Signature: MagnetController -> decimal<MeasureProduct<A,MeasureOne>>	Retruns the maximum output current of the magnet controller hardware.
`setLowerSetPoint magnetController` Signature: magnetController:MagnetController -> decimal<MeasureProduct<A,MeasureOne>> -> Async<unit>	Sets the lower current set-point for the magnet controller.
`setLowerSetPointIndex magnetController` Signature: magnetController:MagnetController -> uint16 -> Async<unit>	Sets the lower current set-point for the magnet controller in terms of its digital step index.
`setUpperSetPoint magnetController` Signature: magnetController:MagnetController -> decimal<MeasureProduct<A,MeasureOne>> -> Async<unit>	Sets the upper current set-point for the magnet controller.
`setUpperSetPointIndex magnetController` Signature: magnetController:MagnetController -> uint16 -> Async<unit>	Sets the upper current set-point for the magnet controller in terms of its digital step index.
`step` Signature: MagnetController -> decimal<MeasureProduct<A,MeasureOne>>	Returns the current difference between the digital output current steps of the magnet controller.
`toMagneticField` Signature: MagnetController -> CurrentDirection * decimal<MeasureProduct<A,MeasureOne>> -> decimal<MeasureProduct<T,MeasureOne>>	Returns the magnetic field corresponding to the specified current direction and output current for the magnet controller.
`toShuntVoltage` Signature: MagnetController -> decimal<MeasureProduct<A,MeasureOne>> -> decimal<MeasureProduct<V,MeasureOne>>	Returns the monitoring shunt voltage readout corresponding to the specified output current for the magnet controller.
`toStepIndex` Signature: MagnetController -> decimal<MeasureProduct<A,MeasureOne>> -> uint16	Returns the nearest digital step index corresponding to the specified current for the magnet controller.