bpm_model

class BPMModel

Bases: object

Abstract class providing interface to accessing BPM positions, offsets, tilts.

abstractmethod get_offset_devices()

Get device handles used for offset access

Returns:

list[DeviceAccess] – h and v offset devices

abstractmethod get_pos_devices()

Get device handles used for position reading

Returns:

list[DeviceAccess] – h and v position devices

abstractmethod get_tilt_device()

Get device handle used for tilt access

Returns:

list[DeviceAccess] – tilt device

is_offset_indexed()

Check if offset values are indexed (array-based).

Returns:

bool – True if both x and y offsets are indexed, False otherwise

is_pos_indexed()

Check if position values are indexed (array-based).

Returns:

bool – True if both x and y positions are indexed, False otherwise

is_tilt_indexed()

Check if tilt value is indexed (array-based).

Returns:

bool – True if tilt is indexed, False otherwise

tilt_index()

Returns the index of the tilt angle in an array, otherwise a scalar value is expected from the corresponding DeviceAccess

Returns:

int – Index in the array, None for a scalar value

x_offset_index()

Returns the index of the horizontal offset in an array, otherwise a scalar value is expected from the corresponding DeviceAccess

Returns:

int – Index in the array, None for a scalar value

x_pos_index()

Returns the index of the horizontal position in an array, otherwise a scalar value is expected from the corresponding DeviceAccess

Returns:

int – Index in the array, None for a scalar value

y_offset_index()

Returns the index of the veritcal offset in an array, otherwise a scalar value is expected from the corresponding DeviceAccess

Returns:

int – Index in the array, None for a scalar value

y_pos_index()

Returns the index of the veritcal position in an array, otherwise a scalar value is expected from the corresponding DeviceAccess

Returns:

int – Index in the array, None for a scalar value