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

.. py:module:: ethos_penalps.simulation_data.simulation_data_complete


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

Classes
~~~~~~~

.. autoapisummary::

   ethos_penalps.simulation_data.simulation_data_complete.SimulationData
   ethos_penalps.simulation_data.simulation_data_complete.UninitializedCurrentStateData
   ethos_penalps.simulation_data.simulation_data_complete.CurrentProductionStateData
   ethos_penalps.simulation_data.simulation_data_complete.PreProductionStateData
   ethos_penalps.simulation_data.simulation_data_complete.AdaptedProductionStateData
   ethos_penalps.simulation_data.simulation_data_complete.ValidatedPostProductionStateData
   ethos_penalps.simulation_data.simulation_data_complete.PostProductionStateData




.. py:class:: SimulationData


   Bases: :py:obj:`abc.ABC`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:method:: create_self_copy()
      :abstractmethod:



.. py:class:: UninitializedCurrentStateData


   Bases: :py:obj:`SimulationData`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:method:: create_self_copy()



.. py:class:: CurrentProductionStateData


   Bases: :py:obj:`SimulationData`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:attribute:: current_process_state_name
      :type: str

      

   .. py:attribute:: current_output_stream_state
      :type: ethos_penalps.stream.ContinuousStreamState | ethos_penalps.stream.BatchStreamState

      

   .. py:attribute:: current_storage_level
      :type: float

      

   .. py:attribute:: process_state_data_dictionary
      :type: dict[str, ethos_penalps.data_classes.ProcessStateData]

      

   .. py:method:: create_self_copy()


   .. py:method:: _create_copy_of_process_state_data_dictionary()



.. py:class:: PreProductionStateData


   Bases: :py:obj:`CurrentProductionStateData`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:method:: create_self_copy()



.. py:class:: AdaptedProductionStateData


   Bases: :py:obj:`PreProductionStateData`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:method:: create_self_copy()



.. py:class:: ValidatedPostProductionStateData


   Bases: :py:obj:`PreProductionStateData`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:attribute:: validated_input_stream_list
      :type: list[ethos_penalps.stream.ContinuousStreamState | ethos_penalps.stream.BatchStreamState]

      

   .. py:method:: create_self_copy()


   .. py:method:: _create_copy_of_validated_input_stream_list()



.. py:class:: PostProductionStateData


   Bases: :py:obj:`ValidatedPostProductionStateData`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:attribute:: current_input_stream_state
      :type: ethos_penalps.stream.ContinuousStreamState | ethos_penalps.stream.BatchStreamState

      

   .. py:method:: create_self_copy()