:py:mod:`ethos_penalps.simulation_data.simulation_data_branch`
==============================================================

.. py:module:: ethos_penalps.simulation_data.simulation_data_branch


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

Classes
~~~~~~~

.. autoapisummary::

   ethos_penalps.simulation_data.simulation_data_branch.TemporalBranchData
   ethos_penalps.simulation_data.simulation_data_branch.CompleteTemporalBranchData
   ethos_penalps.simulation_data.simulation_data_branch.StreamBranchData
   ethos_penalps.simulation_data.simulation_data_branch.IncompleteStreamBranchData
   ethos_penalps.simulation_data.simulation_data_branch.CompleteStreamBranchData
   ethos_penalps.simulation_data.simulation_data_branch.UninitializedOutputBranchData
   ethos_penalps.simulation_data.simulation_data_branch.OutputBranchData
   ethos_penalps.simulation_data.simulation_data_branch.IncompleteOutputBranchData
   ethos_penalps.simulation_data.simulation_data_branch.CompleteOutputBranchData




.. py:class:: TemporalBranchData


   .. py:attribute:: identifier
      :type: ethos_penalps.data_classes.TemporalBranchIdentifier

      


.. py:class:: CompleteTemporalBranchData


   Bases: :py:obj:`TemporalBranchData`


.. py:class:: StreamBranchData


   .. py:attribute:: identifier
      :type: ethos_penalps.data_classes.StreamBranchIdentifier

      

   .. py:attribute:: list_of_complete_input_branches
      :type: list[CompleteTemporalBranchData]

      

   .. py:method:: complete_input_branch_data(incomplete_input_branch_data: TemporalBranchData)


   .. py:method:: get_incomplete_input_branch_data()


   .. py:method:: create_copy()



.. py:class:: IncompleteStreamBranchData


   Bases: :py:obj:`StreamBranchData`

   .. py:attribute:: current_incomplete_input_branch
      :type: TemporalBranchData

      

   .. py:method:: create_complete_input_branch_data() -> CompleteTemporalBranchData


   .. py:method:: get_incomplete_input_branch_data() -> TemporalBranchData


   .. py:method:: create_copy()



.. py:class:: CompleteStreamBranchData(stream_branch_data: StreamBranchData)


   Bases: :py:obj:`StreamBranchData`

   .. py:method:: get_incomplete_input_branch_data()


   .. py:method:: create_copy()



.. py:class:: UninitializedOutputBranchData



.. py:class:: OutputBranchData


   .. py:attribute:: identifier
      :type: ethos_penalps.data_classes.OutputBranchIdentifier

      

   .. py:attribute:: parent_output_identifier
      :type: ethos_penalps.data_classes.OutputBranchIdentifier

      

   .. py:attribute:: parent_input_identifier
      :type: ethos_penalps.data_classes.TemporalBranchIdentifier

      

   .. py:attribute:: dict_of_complete_stream_branch
      :type: dict[str, StreamBranchData]

      

   .. py:attribute:: production_branch_production_plan
      :type: ethos_penalps.production_plan.OutputBranchProductionPlan

      

   .. py:method:: create_copy()



.. py:class:: IncompleteOutputBranchData


   Bases: :py:obj:`OutputBranchData`

   .. py:attribute:: current_stream_branch
      :type: StreamBranchData

      

   .. py:method:: create_copy()



.. py:class:: CompleteOutputBranchData(start_time: datetime.datetime, end_time: datetime.datetime, output_branch_data: OutputBranchData)


   Bases: :py:obj:`OutputBranchData`

   .. py:method:: create_copy()