mbdlyb_ui.functional.observables
================================

.. py:module:: mbdlyb_ui.functional.observables

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   mbdlyb_ui.functional.observables.ObservableCPTPage
   mbdlyb_ui.functional.observables.ObservableCreatePage
   mbdlyb_ui.functional.observables.ObservableDetailsPage
   mbdlyb_ui.functional.observables.ObservableUpdatePage
   mbdlyb_ui.functional.observables.ObservesFunctionRelationPage
   mbdlyb_ui.functional.observables.ObservesHardwareRelationPage
   mbdlyb_ui.functional.observables.ObservesRelationPage


Functions
---------

.. autoapisummary::

   mbdlyb_ui.functional.observables.observable_form


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

.. py:class:: ObservableCPTPage(observable_id: str)

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


   Display the observable CPT probability table editor.


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

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


   Display the observable create editing page.


   .. py:attribute:: observable
      :type:  mbdlyb.functional.gdb.GDirectObservable


   .. py:attribute:: states
      :type:  mbdlyb_ui.functional.helpers.StateTable


.. py:class:: ObservableDetailsPage(observable_id: str)

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


   Display the observable details properties and relations.


   .. py:attribute:: observable
      :type:  mbdlyb.functional.gdb.GDirectObservable


.. py:class:: ObservableUpdatePage(observable_id: str)

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


   Display the observable update editing page.


   .. py:attribute:: observable
      :type:  mbdlyb.functional.gdb.GDirectObservable


   .. py:attribute:: states
      :type:  mbdlyb_ui.functional.helpers.StateTable


.. py:class:: ObservesFunctionRelationPage(observable_id: str, function_id: Optional[str] = None)

   Bases: :py:obj:`ObservesRelationPage`


   Display the observes function relation editing page.


.. py:class:: ObservesHardwareRelationPage(observable_id: str, hardware_id: Optional[str] = None)

   Bases: :py:obj:`ObservesRelationPage`


   Display the observes hardware relation editing page.


.. py:class:: ObservesRelationPage(observable_id: str, node_type: Type[mbdlyb.functional.gdb.GFunctionalNode], observed_id: Optional[str] = None)

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


   Display the observes relation editing page.


   .. py:attribute:: node_type
      :type:  Type[mbdlyb.functional.gdb.GFunctionalNode]


   .. py:attribute:: node_type_name
      :type:  str


   .. py:attribute:: observable
      :type:  mbdlyb.functional.gdb.GDirectObservable


   .. py:attribute:: observed
      :type:  mbdlyb.functional.gdb.GFunctionalNode


   .. py:attribute:: relation
      :type:  mbdlyb_ui.functional.helpers.ObservesRelation


.. py:function:: observable_form(observable: mbdlyb.functional.gdb.GDirectObservable, states: mbdlyb_ui.functional.helpers.StateTable, cluster: mbdlyb.functional.gdb.GCluster, update: bool = True)

   Render the observable name and state editing controls.

   :param observable: Observable node whose properties are edited.
   :param states: Editable state names for the direct observable.
   :param cluster: Parent cluster used to validate the observable name.
   :param update: Whether the observable already exists for name validation.