ReportPort Class Reference#

DiFfRG: DiFfRG::ReportPort Class Reference
DiFfRG
Discretization Framework for functional Renormalization Group flows

#include <run_reporter.hh>

Public Member Functions

 ReportPort ()
 
 ReportPort (const ReportPort &)=default
 
ReportPort & operator= (const ReportPort &)=default
 
template<typename... Args>
void info (spdlog::format_string_t< Args... > format, Args &&...args) const
 
template<typename... Args>
void warn (spdlog::format_string_t< Args... > format, Args &&...args) const
 
template<typename... Args>
void error (spdlog::format_string_t< Args... > format, Args &&...args) const
 
template<typename... Args>
void debug (spdlog::format_string_t< Args... > format, Args &&...args) const
 
void info (const std::string &message) const
 
void warn (const std::string &message) const
 
void error (const std::string &message) const
 
void debug (const std::string &message) const
 
void progress (const ProgressEvent &event) const
 
void summary (const SummaryEvent &event) const
 
void flush () const
 
std::optional< std::filesystem::path > log_file () const
 
int verbosity () const noexcept
 
double Lambda () const noexcept
 
 operator bool () const noexcept
 

Private Member Functions

 ReportPort (std::shared_ptr< internal::ReporterState > state)
 

Private Attributes

std::shared_ptr< internal::ReporterSlot > slot
 

Friends

class RunReporter
 

Detailed Description

Copyable, thread-safe handle to shared reporter state. A default port lazily creates a console-only reporter; ports returned by RunReporter share its configured console and optional file destinations.

Constructor & Destructor Documentation

◆ ReportPort() [1/3]

DiFfRG::ReportPort::ReportPort ( )

Create a lazily initialized console-only reporter.

◆ ReportPort() [2/3]

DiFfRG::ReportPort::ReportPort ( const ReportPort & )
default

◆ ReportPort() [3/3]

DiFfRG::ReportPort::ReportPort ( std::shared_ptr< internal::ReporterState > state)
explicitprivate

Member Function Documentation

◆ debug() [1/2]

void DiFfRG::ReportPort::debug ( const std::string & message) const

◆ debug() [2/2]

template<typename... Args>
void DiFfRG::ReportPort::debug ( spdlog::format_string_t< Args... > format,
Args &&... args ) const
inline

◆ error() [1/2]

void DiFfRG::ReportPort::error ( const std::string & message) const

◆ error() [2/2]

template<typename... Args>
void DiFfRG::ReportPort::error ( spdlog::format_string_t< Args... > format,
Args &&... args ) const
inline

◆ flush()

void DiFfRG::ReportPort::flush ( ) const

◆ info() [1/2]

void DiFfRG::ReportPort::info ( const std::string & message) const

◆ info() [2/2]

template<typename... Args>
void DiFfRG::ReportPort::info ( spdlog::format_string_t< Args... > format,
Args &&... args ) const
inline

◆ Lambda()

double DiFfRG::ReportPort::Lambda ( ) const
noexcept

◆ log_file()

std::optional< std::filesystem::path > DiFfRG::ReportPort::log_file ( ) const

Path of the duplicated text log, or no value for a console-only reporter.

◆ operator bool()

DiFfRG::ReportPort::operator bool ( ) const
explicitnoexcept

◆ operator=()

ReportPort & DiFfRG::ReportPort::operator= ( const ReportPort & )
default

◆ progress()

void DiFfRG::ReportPort::progress ( const ProgressEvent & event) const

◆ summary()

void DiFfRG::ReportPort::summary ( const SummaryEvent & event) const

◆ verbosity()

int DiFfRG::ReportPort::verbosity ( ) const
noexcept

◆ warn() [1/2]

void DiFfRG::ReportPort::warn ( const std::string & message) const

◆ warn() [2/2]

template<typename... Args>
void DiFfRG::ReportPort::warn ( spdlog::format_string_t< Args... > format,
Args &&... args ) const
inline

Friends And Related Symbol Documentation

◆ RunReporter

friend class RunReporter
friend

Member Data Documentation

◆ slot

std::shared_ptr<internal::ReporterSlot> DiFfRG::ReportPort::slot
private

The documentation for this class was generated from the following file:
  • /home/runner/work/DiFfRG_current/DiFfRG_current/DiFfRG/include/DiFfRG/common/run_reporter.hh