abstract_impl

class BPMHScalarAggregator(ring)

Bases: BPMScalarAggregator

Vertical BPM simulator aggregator

get()

Return a list variables

class BPMScalarAggregator(ring)

Bases: ScalarAggregator

BPM simulator aggregator

add_elem(elem)

get()

Return a list variables

readback()

Return a list variables (measurements)

set(value)

Write a list of variable

set_and_wait(value)

Write a list of variable and wait that setpoint are reached

unit()

Return the variables unit

class BPMVScalarAggregator(ring)

Bases: BPMScalarAggregator

Horizontal BPM simulator aggregator

get()

Return a list variables

class RBetatronTuneArray(ring)

Bases: ReadFloatArray

Class providing read-only access to the betatron tune of a ring.

get()

Get the value

unit()

Get the unit of the values

class RBpmArray(element, lattice)

Bases: ReadFloatArray

Class providing read access to a BPM position (array) of a simulator. Position in pyAT is calculated using find_orbit function, which returns the orbit at a specified index. The position is then extracted from the orbit array as the first two elements (x, y).

get()

Get the value

unit()

Get the unit of the values

class RWBpmOffsetArray(element)

Bases: ReadWriteFloatArray

Class providing read write access to a BPM offset (array) of a simulator. Offset in pyAT is defined in Offset attribute as a 2-element array.

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 RWBpmTiltScalar(element)

Bases: ReadWriteFloatScalar

Class providing read write access to a BPM tilt of a simulator. Tilt in pyAT is defined in Rotation attribute as a first element.

get()

Get the value

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

unit()

Get the unit of the value

class RWHardwareArray(elements, poly, model)

Bases: ReadWriteFloatArray

Class providing read write access to a magnet of a simulator in hardware units. Hardware units are converted from strengths using the magnet model

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 RWHardwareScalar(elements, poly, model)

Bases: ReadWriteFloatScalar

Class providing read write access to a magnet of a simulator in hardware unit. Hardware unit is converted from strength using the magnet model

get()

Get the value

get_length()

get_model()

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

unit()

Get the unit of the value

class RWRFATFrequencyScalar(ring)

Bases: ReadWriteFloatScalar

Class providing read write access to RF frequency of a simulator using AT methods.

get()

Get the value

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

unit()

Get the unit of the value

class RWRFATotalVoltageScalar(ring)

Bases: ReadWriteFloatScalar

Class providing read write access to a RF voltage of a simulator using AT methods.

get()

Get the value

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

unit()

Get the unit of the value

class RWRFFrequencyScalar(elements, harmonics)

Bases: ReadWriteFloatScalar

Class providing read write access to RF frequency of a simulator.

get()

Get the value

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

unit()

Get the unit of the value

class RWRFPhaseScalar(elements)

Bases: ReadWriteFloatScalar

Class providing read write access to a cavity phase of a simulator for a given RF trasnmitter.

get()

Get the value

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

unit()

Get the unit of the value

class RWRFVoltageScalar(elements)

Bases: ReadWriteFloatScalar

Class providing read write access to a cavity voltage of a simulator for a given RF trasnmitter.

get()

Get the value

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

unit()

Get the unit of the value

class RWSerializedHardware(elements, element_index)

Bases: ReadWriteFloatScalar

get()

Get the value

get_element_length()

get_total_length()

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

set_magnet_rigidity(brho)

unit()

Get the unit of the value

class RWSerializedStrength(elements_strength, elements_hardware, element_index)

Bases: ReadWriteFloatScalar

get()

Get the value

get_element_length()

get_total_length()

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

set_magnet_rigidity(brho)

unit()

Get the unit of the value

class RWStrengthArray(elements, poly, model)

Bases: ReadWriteFloatArray

Class providing read write access to a strength (array) of a simulator

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 RWStrengthScalar(elements, poly, model)

Bases: ReadWriteFloatScalar

Class providing read write access to a strength of a simulator

get()

Get the value

get_element_length()

get_model()

set(value)

Set the value

set_and_wait(value)

Set the value and wait that setpoint is reached

unit()

Get the unit of the value