boss.interfaces
===============

.. py:module:: boss.interfaces

.. autoapi-nested-parse::

   This module contains adapters/wrappers for classes from libraries that need special treatment for usage with HEROS



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/boss/interfaces/qcodes/index


Classes
-------

.. autoapisummary::

   boss.interfaces.QCodesDeviceWrapper


Package Contents
----------------

.. py:class:: QCodesDeviceWrapper(**_kwargs)

   HEROS representation of a generic QCoDeS Instrument.

   This class wraps QCoDeS instruments to make them accessible through HEROS.
   It provides methods to resolve parameters (including those in submodules)
   and build dynamic subclasses that expose QCoDeS functionality.

   .. attribute:: _qcodes_instance

      The wrapped QCoDeS instrument instance


   .. py:attribute:: _qcodes_instance
      :type:  type


   .. py:attribute:: name
      :type:  str


   .. py:method:: _resolve_parameter(qcodes_instance: Any, parameter_path: str) -> tuple
      :staticmethod:


      Resolve a parameter path to a QCoDeS parameter instance.

      This method takes a parameter path (e.g., "submodule.param_name") and
      navigates through the QCoDeS instrument's submodules to find the
      specified parameter.

      :param qcodes_instance: The QCoDeS instrument instance
      :param parameter_path: Dot-separated path to the parameter (e.g., "submodule.param_name")

      :returns: A tuple of (target_instance, parameter) where target_instance is the
                QCoDeS instance (device or submodule) containing the parameter, and parameter is the parameter itself

      :raises AttributeError: If the submodule path is invalid or the parameter doesn't exist



   .. py:method:: _build(source_class: type, name: str, arg_dict: dict) -> type
      :classmethod:


      Build a dynamic subclass that wraps a QCoDeS instrument.

      This method creates a new class that inherits from QCodesDeviceWrapper
      and wraps the specified QCoDeS instrument class. It exposes selected
      parameters as attributes and copies methods from the QCoDeS instrument to be exposed to HEROS.

      :param source_class: The QCoDeS instrument class to wrap
      :param name: Name of the HERO used as an internal name for QCoDeS
      :param arg_dict: Dictionary of arguments for the QCoDeS instrument constructor,
                       including a 'parameters' key with a list of parameter paths to expose



   .. py:method:: get_parameter_spec(parameter_path: str) -> dict

      Get the parameter specification of a parameter.

      This method retrieves the specification dictionary for a QCoDeS parameter,
      which contains metadata about the parameter such as its type, units, etc.

      :param parameter_path: Dot-separated path to the parameter (e.g., "submodule.param_name")

      :returns: Dictionary containing the parameter specification

      :raises AttributeError: If the parameter path is invalid