magnet_array

class MagnetArray(arrayName, magnets, use_aggregator=True)

Bases: ElementArray

Class that implements access to a 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.

Example

An array can be retrieved from the configuration as in the following example:

sr = Accelerator.load("acc.yaml")
quads = sr.design.get_magnets("QuadForTune")

property hardwares: RWMagnetHardware

Give access to hardware value of each magnet of this array

property strengths: RWMagnetStrength

Give access to strength of each magnet of this array

class RWMagnetHardware(name, magnets)

Bases: ReadWriteFloatArray

get()

Get the value

set(value)

Set the values

set_aggregator(agg)

set_and_wait(value)

Set the values and wait that setpoints are reached

unit()

Get the unit of the value

class RWMagnetStrength(name, magnets)

Bases: ReadWriteFloatArray

get()

Get the value

set(value)

Set the values

set_aggregator(agg)

set_and_wait(value)

Set the values and wait that setpoints are reached

unit()

Get the unit of the value