mbdlyb_ui.functional.design_for_diagnostics
===========================================

.. py:module:: mbdlyb_ui.functional.design_for_diagnostics

.. autoapi-nested-parse::

   Copyright (c) 2023 - 2026 TNO-ESI
   All rights reserved.



Classes
-------

.. autoapisummary::

   mbdlyb_ui.functional.design_for_diagnostics.DesignForDiagnosticsPage
   mbdlyb_ui.functional.design_for_diagnostics.DiagnosticProcedureDiagram
   mbdlyb_ui.functional.design_for_diagnostics.UIDesignForDiagnosticsData


Functions
---------

.. autoapisummary::

   mbdlyb_ui.functional.design_for_diagnostics.diagnostic_procedures
   mbdlyb_ui.functional.design_for_diagnostics.operating_modes
   mbdlyb_ui.functional.design_for_diagnostics.overview
   mbdlyb_ui.functional.design_for_diagnostics.signatures


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

.. py:class:: DesignForDiagnosticsPage(cluster_id: str)

   Bases: :py:obj:`mbdlyb_ui.functional.base.FunctionalPage`


   Display the design for diagnostics editing page.


   .. py:attribute:: cluster
      :type:  mbdlyb.functional.gdb.GCluster


   .. py:attribute:: data
      :type:  UIDesignForDiagnosticsData


.. py:class:: DiagnosticProcedureDiagram(data: UIDesignForDiagnosticsData, dp_name: str)

   Build a Mermaid diagram of a diagnostic procedure.


   .. py:property:: diagram
      :type: str


      Join the generated diagnostic procedure diagram lines.

      :returns: Mermaid source for the diagnostic procedure diagram.


.. py:class:: UIDesignForDiagnosticsData(cluster_id: str)

   Hold the design for diagnostics analysis and UI state.


   .. py:method:: compute(event=None)
      :async:


      Analyze the cluster and refresh diagnostic design results.

      :param event: Optional UI event whose sender is disabled during computation.



   .. py:method:: refresh()
      :staticmethod:


      Refresh operating modes, signatures, procedures, and overview.



   .. py:method:: reset()

      Clear analysis results and reload the cluster model.



   .. py:attribute:: analyzer
      :type:  Optional[mbdlyb.functional.Analyzer]


   .. py:attribute:: cluster
      :type:  mbdlyb.functional.Cluster


   .. py:attribute:: compute_button
      :type:  nicegui.ui.button


   .. py:attribute:: costs_text
      :type:  str
      :value: ''



   .. py:attribute:: costs_visible
      :type:  bool
      :value: False



   .. py:attribute:: dp_svg
      :type:  dict[str, str]


   .. py:attribute:: dp_to_export
      :type:  list[str]
      :value: []



   .. py:attribute:: export_button
      :type:  nicegui.ui.button


   .. py:attribute:: results_available
      :type:  bool
      :value: False



.. py:function:: diagnostic_procedures(data: UIDesignForDiagnosticsData, export_button: nicegui.ui.button)

   Render diagnostic procedures and diagram export controls.

   :param data: Design analyzer and procedure diagram export state.
   :param export_button: Button used to start diagram export.


.. py:function:: operating_modes(data: UIDesignForDiagnosticsData)

   Display operating mode selections for the design analyzer.

   :param data: Design analyzer and selected operating mode state.


.. py:function:: overview(data: UIDesignForDiagnosticsData)

   Render the design-for-diagnostics overview table.

   :param data: Design analyzer whose procedure overview is displayed.


.. py:function:: signatures(data: UIDesignForDiagnosticsData, filter: nicegui.ui.input)

   Render the filterable diagnostic signature table.

   :param data: Design analyzer whose diagnostic signatures are displayed.
   :param filter: Filter applied to displayed results.