cfm_magnet_array

class CombinedFunctionMagnetArray(arrayName, magnets, use_aggregator=False)

Bases: ElementArray

Class that implements access to a combined function magnet array

Parameters:

• arrayName (str) – Array name

• magnets (list[Magnet]) – Magnet list, all elements must be attached to the same instance of either a Simulator or a ControlSystem.

• use_aggregator (bool) – Use aggregator to increase performance by using paralell access to underlying devices.

property hardwares: RWMagnetHardwares

Give access to hardware value of each magnet of this array

property strengths: RWMagnetStrengths

Give access to strength of each magnet of this array

class RWMagnetHardwares(name, magnets)

Bases: ReadWriteFloatArray

get()

Get the value

set(value)

Set the values

set_and_wait(value)

Set the values and wait that setpoints are reached

unit()

Get the unit of the value

class RWMagnetStrengths(name, magnets)

Bases: ReadWriteFloatArray

get()

Get the value

set(value)

Set the values

set_and_wait(value)

Set the values and wait that setpoints are reached

unit()

Get the unit of the value