edge
====

.. py:module:: quantify_scheduler.device_under_test.edge 


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   quantify_scheduler.device_under_test.edge.Edge




.. py:class:: Edge(parent_element_name: str, child_element_name: str)


   Bases: :py:obj:`qcodes.instrument.base.Instrument`

   This class encapsulates the connection information between DeviceElements in the
   QuantumDevice. It provides an interface for the QuantumDevice to generate the
   edge information for use in the device compilation step. See
   :class:`quantify_scheduler.device_under_test.composite_square_edge` for an example
   edge implementation.

   .. py:property:: parent_device_element

      The parent DeviceElement connected by the edge.

   .. py:property:: child_device_element

      The child DeviceElement connected by the edge.

   .. py:method:: generate_edge_config() -> quantify_scheduler.backends.graph_compilation.DeviceCompilationConfig
      :abstractmethod:

      Generates part of the device configuration specific to an edge connecting
      different device elements.

      This method is intended to be used when this object is part of a
      device object containing multiple elements.