paramonte._ReportFileContents

Module Contents

Classes

StructWithPrint()
ReportFileContents(file, methodName, reportEnabled)	This is the ReportFileContents class for generating instances

paramonte._ReportFileContents.Struct

paramonte._ReportFileContents.newline

paramonte._ReportFileContents.creturn

class paramonte._ReportFileContents.StructWithPrint

print(self)

class paramonte._ReportFileContents.ReportFileContents(file, methodName, reportEnabled)

Bases: _OutputFileContents.OutputFileContents

This is the ReportFileContents class for generating instances of the ParaMonte output report file 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 Report files generated by the ParaMonte sampler routines. For example, the ParaDRAM sampler class makes calls to this class via its readReport() method to return a list of objects of class ReportFileContents.

Parameters

file

The full path to the file containing the report.

methodName

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

ReportFileContents

An object of class ReportFileContents.

_reportParseFailure(self, topic)

_reportMissingValue(self, topic)

_isSectionHeader(self, record)

_stopBeforeNextSectionHeader(self)

_skipCurrentSectionHeader(self)

_parseSection(self, topic)

_concat(self, lineStart, lineCounter)

_parseStats(self)

_isstats(self, record)

_isdesc(self, record)