Source code for pyaml.control.deviceaccesslist

from abc import ABCMeta, abstractmethod

import numpy as np
import numpy.typing as npt

from .deviceaccess import DeviceAccess




class DeviceAccessList(metaclass=ABCMeta):
    """
    Abstract class providing access to a list of control system variales.
    Internal structure depends on the backend and might not be trivially mutable.
    """



    @abstractmethod
    def add_devices(self, devices: DeviceAccess | list[DeviceAccess]):
        """Add a DeviceAccess (or a list) to this list"""
        pass




    @abstractmethod
    def get_device_at(self, index: int) -> DeviceAccess:
        """Returns the device at the given index"""
        pass




    @abstractmethod
    def len(self) -> int:
        """Get the DeviceAccessList length"""
        pass




    @abstractmethod
    def set(self, value: npt.NDArray[np.float64]):
        """Write a list of control system device variable
        (i.e. a power supply currents)"""
        pass




    @abstractmethod
    def set_and_wait(self, value: npt.NDArray[np.float64]):
        """Write a list control system device variable (i.e. a power supply currents)"""
        pass




    @abstractmethod
    def get(self) -> npt.NDArray[np.float64]:
        """Return a list of setpoints of control system device variables"""
        pass




    @abstractmethod
    def readback(self) -> np.array:
        """Return the measured variables"""
        pass




    @abstractmethod
    def unit(self) -> str:
        """Return the variable unit"""
        pass




    @abstractmethod
    def get_range(self) -> list[float]:
        """
        Get the valid range for the device variables.

        Returns
        -------
        list[float]
            List containing [min0, max0, min1, max1, ...] values
        """
        pass




    @abstractmethod
    def check_device_availability(self) -> bool:
        """
        Check if all devices in the list are available and accessible.

        Returns
        -------
        bool
            True if all devices are available, False otherwise
        """
        pass


    # Immutable list implementation

    def __getitem__(self, index):
        return self.get_device_at(index)

    def __len__(self):
        return self.len()

    def __iter__(self):
        self._iter_pos = 0
        return self

    def __next__(self):
        if self._iter_pos < len(self._items):
            self._iter_pos += 1
            return self._items[self._iter_pos - 1]
        else:
            raise StopIteration