objects
=======

.. py:module:: objects


Classes
-------

.. autoapisummary::

   objects.KansElement
   objects.UittredepuntElement
   objects.VakElement
   objects.WindowElement
   objects.TrajectElement


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

.. py:class:: KansElement

   DataClass voor het opslaan van de faalkans pf en de
   betrouwbaarheidsindex beta. Een van deze twee parameters is nodig om deze
   class te initialiseren.

   :raises ValueError: Als de pf niet tussen de 0 en de 1 ligt.
   :raises ValueError: Als beta geen eindige waarde heeft.
   :raises ValueError: Als beta groter is dan 38 of kleiner dan -38.


   .. py:attribute:: pf
      :type:  Optional[float]
      :value: None



   .. py:attribute:: beta
      :type:  Optional[float]
      :value: None



   .. py:method:: __post_init__()


.. py:class:: UittredepuntElement

   DataClass om alle relevante data van een uittredepunt te verzamelen.



   .. py:attribute:: m_value
      :type:  float


   .. py:attribute:: a
      :type:  float


   .. py:attribute:: converged
      :type:  bool


   .. py:attribute:: flow_chart_number
      :type:  int


   .. py:attribute:: advise
      :type:  str


   .. py:attribute:: pf
      :type:  Optional[float]
      :value: None



   .. py:attribute:: beta
      :type:  Optional[float]
      :value: None



   .. py:method:: __post_init__()


.. py:class:: VakElement

   DataClass om alle relevante data van een vak te verzamelen.
   Vanuit deze class kunnen de verschillende methoden om tot een faalkans van
   het vak worden bepaald.


   .. py:attribute:: id
      :type:  int


   .. py:attribute:: m_van
      :type:  float


   .. py:attribute:: m_tot
      :type:  float


   .. py:attribute:: a
      :type:  float


   .. py:attribute:: delta_length
      :type:  float


   .. py:attribute:: dsn_list
      :type:  List[UittredepuntElement]


   .. py:property:: length
      :type: float



   .. py:property:: N_vak
      :type: float



   .. py:property:: advise


   .. py:property:: flow_chart_number
      :type: int



   .. py:property:: pf_max_dsn
      :type: Tuple[KansElement, KansElement]



   .. py:property:: conv_max_dsn
      :type: bool


      Bepaald of maximum faalkans op doorsnede niveau als geconvergeerd beschouwd kan worden. Dat is, als alles
      kansen geconvergeerd zijn, dan True, anders False. Want een niet geconvergeerde kans had de maximale faalkans
      kunnen zijn.


   .. py:method:: pf_window(window_size)


   .. py:property:: pf_scaled
      :type: Tuple[KansElement, KansElement, List[WindowElement]]



.. py:class:: WindowElement

   DataClass voor het verzamelen va alle data uit een window dat wordt
   opgezet in `window_collect` of `scaled_collect`.

   :raises AttributeError: Als een attribute wordt opgevraagd dat niet is
       toegevoegd.


   .. py:attribute:: m_van
      :type:  float


   .. py:attribute:: m_tot
      :type:  float


   .. py:attribute:: window_size
      :type:  float


   .. py:attribute:: window_id
      :type:  int


   .. py:attribute:: pf
      :type:  float


   .. py:attribute:: flow_chart_number
      :type:  int


   .. py:attribute:: advise
      :type:  str


   .. py:attribute:: _vak_id
      :type:  Optional[int]
      :value: None



   .. py:attribute:: _a
      :type:  Optional[float]
      :value: None



   .. py:attribute:: _m_uittredepunt
      :type:  Optional[float]
      :value: None



   .. py:attribute:: _n_vak
      :type:  Optional[float]
      :value: None



   .. py:property:: length


   .. py:property:: kans_dsn
      :type: KansElement



   .. py:property:: a
      :type: float



   .. py:property:: vak_id
      :type: int



   .. py:property:: m_uittredepunt
      :type: float



   .. py:property:: n_vak
      :type: float



.. py:class:: TrajectElement

   DataClass om de data van het traject te verzamelen.



   .. py:attribute:: list_vakken
      :type:  list[VakElement]


   .. py:attribute:: list_dsn
      :type:  list[UittredepuntElement]


   .. py:attribute:: delta_length
      :type:  float


   .. py:property:: m_van
      :type: float



   .. py:property:: m_tot
      :type: float



   .. py:property:: pf_max_vak
      :type: Tuple[KansElement, KansElement]



   .. py:method:: pf_window(window_size)


   .. py:property:: pf_scaled
      :type: Tuple[KansElement, KansElement, List[WindowElement]]