:mod:`paramonte._RestartFileContents`
=====================================

.. py:module:: paramonte._RestartFileContents


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

Classes
~~~~~~~

.. autoapisummary::

   paramonte._RestartFileContents.RestartFileContents



.. data:: Struct
   

   

.. data:: newline
   

   

.. py:class:: RestartFileContents(file, methodName, reportEnabled)

   Bases: :class:`_OutputFileContents.OutputFileContents`

   This is the **RestartFileContents** class for generating instances
   of the ParaMonte restart output contents. This class is NOT meant to
   be directly accessed by the ParaMonte library users. It is internally
   used by the ParaMonte library to parse the contents of the output restart
   files generated by the ParaMonte sampler routines. For example, the ParaDRAM
   sampler class makes calls to this class via its ``readRestart()`` method to
   return a list of objects of class ``RestartFileContents``.

       **Parameters**

           file

               The full path to the file containing the sample/chain.

           methodName

               A string representing the name of the ParaMonte sampler used
               to call the constructor of the ``RestartFileContents`` class.

           reportEnabled

               A logical input parameter indicating whether the ParaMonte
               automatic guidelines to the standard output should be provided 
               or not. The default value is ``True``.

       **Attributes**

           A dynamic set of attributes that are directly parsed from the file.

       **Returns**

           restartFileContents

               An object of class ``RestartFileContents``.

   ----------------------------------------------------------------------

   .. method:: _readRestartParaDRAM(self)



   .. method:: _reportCorruptFile(self)



   .. method:: _resetPlot(self, resetType='soft', plotNames='all')


      Reset the properties of the plot to the original default settings.
      Use this method when you change many attributes of the plot and
      you want to clean up and go back to the default settings.

          **Parameters**

              resetType (optional)

                  An optional string with possible value of ``"hard"``.
                  If provided, the plot object will be regenerated from scratch.
                  This includes reading the original data frame again and resetting
                  everything. If not provided, then only the plot settings will be
                  reset without reseting the dataFrame.

              plotNames (optional)

                  An optional string value or list of string values representing 
                  the names of plots to reset. If no value is provided, 
                  then all plots will be reset.

          **Returns**

              None

          **Example**

              .. code-block:: python

                  reset("hard")                       # regenerate all plots from scratch
                  reset("hard","covmat2")             # regenerate covmat2 plot from scratch
                  reset("hard",["covmat2","covmat3"]) # regenerate covmat2 & covmat3 plots