:mod:`paramonte._OutputFileContents`
====================================

.. py:module:: paramonte._OutputFileContents


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

Classes
~~~~~~~

.. autoapisummary::

   paramonte._OutputFileContents.OutputFileContents



.. py:class:: OutputFileContents(file: str, methodName: str, reportEnabled: bool)

   This is the **OutputFileContents** base class for the ParaMonte 
   sampler output file contents classes. **This class is NOT meant to be 
   directly accessed or called by the user of the ParaMonte library.**
   However, its children, such as the ParaDRAM sampler class will be 
   indirectly accessible to the public. 

       **Parameters**

           file

               The full path to the file.

           methodName

               A string representing the name of the ParaMonte sampler used
               to call the constructor of the ``OutputFileContents`` 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``.

       **Methods**

           See below for information on the methods.  

       **Returns**

           Object of class OutputFileContents