Source code for csaxs_bec.bec_widgets.widgets.client

# This file was automatically generated by generate_cli.py
# type: ignore

from __future__ import annotations

from bec_lib.logger import bec_logger

from bec_widgets.cli.rpc.rpc_base import RPCBase, rpc_call, rpc_timeout

logger = bec_logger.logger

# pylint: skip-file


_Widgets = {
    "XRayEye": "XRayEye",
}




class XRayEye(RPCBase):
    _IMPORT_MODULE = "csaxs_bec.bec_widgets.widgets.xray_eye.x_ray_eye"



    @rpc_call
    def active_roi(self) -> "BaseROI | None":
        """
        Return the currently active ROI, or None if no ROI is active.
        """


    @property
    @rpc_call
    def user_message(self):
        """
        None
        """

    @user_message.setter
    @rpc_call
    def user_message(self):
        """
        None
        """



    @rpc_timeout(20)
    @rpc_call
    def on_live_view_enabled(self, enabled: "bool"):
        """
        None
        """




    @rpc_timeout(20)
    @rpc_call
    def on_motors_enable(self, x_enable: "bool", y_enable: "bool"):
        """
        Enable/Disable motor controls

        Args:
            x_enable(bool): enable x motor controls
            y_enable(bool): enable y motor controls
        """




    @rpc_timeout(20)
    @rpc_call
    def enable_submit_button(self, enable: "bool"):
        """
        Enable/disable submit button.
        Args:
            enable(int): -1 disable else enable
        """


    @property
    @rpc_call
    def sample_name(self):
        """
        None
        """

    @sample_name.setter
    @rpc_call
    def sample_name(self):
        """
        None
        """

    @property
    @rpc_call
    def enable_move_buttons(self):
        """
        None
        """

    @enable_move_buttons.setter
    @rpc_call
    def enable_move_buttons(self):
        """
        None
        """



    @rpc_timeout(20)
    @rpc_call
    def switch_tab(self, tab: "str"):
        """
        None
        """




    @rpc_timeout(20)
    @rpc_call
    def set_dap_params_forwarding(self, enabled: "bool"):
        """
        Connect or disconnect DAP fit parameter forwarding to omny_xray_gui.
        """




    @rpc_timeout(20)
    @rpc_call
    def submit_fit_array(self, fit_array):
        """
        None
        """






class XRayEye2DControl(RPCBase):
    _IMPORT_MODULE = "csaxs_bec.bec_widgets.widgets.xray_eye.x_ray_eye"



    @rpc_call
    def remove(self):
        """
        Cleanup the BECConnector
        """




    @rpc_call
    def attach(self):
        """
        None
        """




    @rpc_call
    def detach(self):
        """
        Detach the widget from its parent dock widget (if widget is in the dock), making it a floating widget.
        """