Detailed Description

Optionally flushes the standard output upon creation and destruction. Can be used to improve the debug output readability when printing debug messages both from OGS and from Python.

Definition at line 18 of file FlushStdoutGuard.h.

#include <FlushStdoutGuard.h>

Public Member Functions
	FlushStdoutGuard (bool const flush)
	Optionally flushes C++ stdout before running Python code.

	~FlushStdoutGuard ()
	Optionally flushes Python's stdout after running Python code.

Private Attributes
const bool	_flush
	To flush or not to flush.

Constructor & Destructor Documentation

◆ FlushStdoutGuard()

anonymous_namespace{FlushStdoutGuard.h}::FlushStdoutGuard::FlushStdoutGuard ( bool const flush )

inlineexplicit

Optionally flushes C++ stdout before running Python code.

Definition at line 22 of file FlushStdoutGuard.h.

                                                : _flush(flush)
    {
        if (!flush)
        {
            return;
        }
 
        std::cout << std::flush;
    }

◆ ~FlushStdoutGuard()

anonymous_namespace{FlushStdoutGuard.h}::FlushStdoutGuard::~FlushStdoutGuard ( )

inline

Optionally flushes Python's stdout after running Python code.

Definition at line 33 of file FlushStdoutGuard.h.

    {
        if (!_flush)
        {
            return;
        }
 
        using namespace pybind11::literals;
        pybind11::print("end"_a = "", "flush"_a = true);
    }

Member Data Documentation

◆ _flush

const bool anonymous_namespace{FlushStdoutGuard.h}::FlushStdoutGuard::_flush

private

To flush or not to flush.

Definition at line 46 of file FlushStdoutGuard.h.

The documentation for this class was generated from the following file:

ProcessLib/BoundaryConditionAndSourceTerm/Python/FlushStdoutGuard.h