MGIS 3.1.0
Loading...
Searching...
No Matches
mgis::Context Struct Referencefinal

a class used to pass an execution context to most methods of MGIS and gather information (error, logs, profiling). More...

#include </home/runner/work/MFrontGenericInterfaceSupport/MFrontGenericInterfaceSupport/include/MGIS/Context.hxx>

Inheritance diagram for mgis::Context:
mgis::ErrorBacktrace mgis::AbstractErrorHandler

Classes

struct  FailureHandler

Public Types

enum  FailureHandlerPolicy { ABORT , RAISE }
Public Types inherited from mgis::ErrorBacktrace
using ErrorReportFunction = std::string (*)(const int)
 brief a simple alias
using ErrorReport
 a simple alias listing the main way to report an error.

Public Member Functions

 Context () MGIS_NOEXCEPT
 default constructor
 Context (const ContextInitializer &) MGIS_NOEXCEPT
 constructor for an initializer
 Context (Context &&)=delete
 Context (const Context &)=delete
Context & operator= (Context &&)=delete
Context & operator= (const Context &)=delete
const VerbosityLevel & getVerbosityLevel () const MGIS_NOEXCEPT
void setVerbosityLevel (const VerbosityLevel) MGIS_NOEXCEPT
 change the level of verbosity
void enableProfiling (const bool) MGIS_NOEXCEPT
 enable or disable profiling
bool isProfilingEnabled () const MGIS_NOEXCEPT
ProfilingSection startNewProfiling (std::string, bool) MGIS_NOEXCEPT
 start a new profiling section
void pushProfilingNode (std::string) MGIS_NOEXCEPT
 push a new profiling node into the current execution stack
void popProfilingNode (double) MGIS_NOEXCEPT
 pop the current profiling node from the execution stack and accumulate time
const ProfilingData & getProfilingResultTree () const MGIS_NOEXCEPT
template<FailureHandlerPolicy policy = FailureHandlerPolicy::RAISE>
FailureHandler< policy > getFailureHandler ()
FailureHandler< FailureHandlerPolicy::RAISE > getThrowingFailureHandler () MGIS_NOEXCEPT
FailureHandler< FailureHandlerPolicy::ABORT > getFatalFailureHandler () MGIS_NOEXCEPT
void setLogStream (std::ostream &) MGIS_NOEXCEPT
 set the current log stream.
void setLogStream (std::shared_ptr< std::ostream >) MGIS_NOEXCEPT
 set the current log stream.
std::shared_ptr< std::ostream > getLogStreamPointer () const MGIS_NOEXCEPT
void resetLogStream () MGIS_NOEXCEPT
 reset the default log stream
void disableLogStream () MGIS_NOEXCEPT
 disable the default log stream
std::ostream & log () MGIS_NOEXCEPT
template<typename... Args>
std::ostream & log (const VerbosityLevel, Args &&...) MGIS_NOEXCEPT
 display the given arguments in the log stream if the current verbosity level (as returned by the getVerbosityLevel method) is greater than a minimal one.
template<typename... Args>
void warning (Args &&...) MGIS_NOEXCEPT
 a simple wrapper around the log method to print a warning
template<typename... Args>
void debug (Args &&...) MGIS_NOEXCEPT
 a simple wrapper around the log method which sets the minimun verbosity level to verboseDebug
 ~Context () noexcept override
 destructor
template<typename... Args>
std::ostream & log (const VerbosityLevel l, Args &&...args) MGIS_NOEXCEPT
template<typename... Args>
void warning (Args &&...args) MGIS_NOEXCEPT
template<typename... Args>
void debug (Args &&...args) MGIS_NOEXCEPT
Public Member Functions inherited from mgis::ErrorBacktrace
void assertOrTerminate (const bool, const char *const)
 assert that the given boolean is true. If false, terminate is called.
void assertOrTerminate (const bool, const ErrorReport)
 assert that the given boolean is true. If false, terminate is called.
void terminate (const char *const)
 terminate the excution after displaying the given error message
void terminate (const ErrorReport)
 terminate the excution after displaying the given error message
InvalidResult registerErrorMessage (const char *const) final
 register a new error message
InvalidResult registerErrorMessage (const ErrorReport) MGIS_NOEXCEPT
 register a new error message
template<typename ReturnType>
requires (internal::InvalidValueTraits<ReturnType>::isSpecialized)
ReturnType registerErrorMessage (const char *const)
 register a new error message
template<typename ReturnType>
requires (internal::InvalidValueTraits<ReturnType>::isSpecialized)
ReturnType registerErrorMessage (const ErrorReport) MGIS_NOEXCEPT
 register a new error message
InvalidResult registerErrorMessageWithoutSourceLocation (const ErrorReport) MGIS_NOEXCEPT
 register a new error message
void clearErrorMessages () MGIS_NOEXCEPT
 remove the error messages
std::string getErrorMessage (const bool=true) MGIS_NOEXCEPT
std::string getRawErrorMessage (const bool=true) MGIS_NOEXCEPT
bool empty () const MGIS_NOEXCEPT
 ~ErrorBacktrace () noexcept override
 destructor
Public Member Functions inherited from mgis::AbstractErrorHandler
virtual constexpr ~AbstractErrorHandler ()=default
 destructor

Additional Inherited Members

Static Public Member Functions inherited from mgis::ErrorBacktrace
static void setErrorReportingAsFatal () MGIS_NOEXCEPT
 specify if error reporting shall be fatal
static void unsetErrorReportingAsFatal () MGIS_NOEXCEPT
 specify if error reporting shall be fatal
static void abort (std::string_view)
 call the terminate handler

Detailed Description

a class used to pass an execution context to most methods of MGIS and gather information (error, logs, profiling).

The default logging stream is the one returned by the mgis::getDefaultLogStream free function.

Constructor & Destructor Documentation

◆ Context() [1/2]

mgis::Context::Context ( )

default constructor

The verbositiy level is initialized by calling the getDefaultVerbosityLevel function.

◆ Context() [2/2]

mgis::Context::Context ( const ContextInitializer & )

constructor for an initializer

Parameters
[in]iinitializer

Member Function Documentation

◆ debug()

template<typename... Args>
void mgis::Context::debug ( Args && ...)

a simple wrapper around the log method which sets the minimun verbosity level to verboseDebug

Template Parameters
Argstypes of the arguments
Parameters
[in]argsstreamed object
Note
note nothing is displayed if the current verbositiy level is below verboseDebug

◆ disableLogStream()

void mgis::Context::disableLogStream ( )

disable the default log stream

Note
logging is disable by creating a no-op output stream

◆ enableProfiling()

void mgis::Context::enableProfiling ( const bool )

enable or disable profiling

Parameters
[in]ba boolean value stating whether profiling shall be enabled
Note
when profiling is disabled, profiling sections introduce almost no overhead.

◆ getFailureHandler()

template<FailureHandlerPolicy policy = FailureHandlerPolicy::RAISE>
FailureHandler< policy > mgis::Context::getFailureHandler ( )
inlinenodiscard
Returns
a failure handler
Template Parameters
policypolicy used to treat a failure
Note
the context must outlive the failure hander

◆ getFatalFailureHandler()

Context::FailureHandler< Context::FailureHandlerPolicy::ABORT > mgis::Context::getFatalFailureHandler ( )
inlinenodiscard
Returns
a failure handler aborting the execution in case of failure

◆ getLogStreamPointer()

std::shared_ptr< std::ostream > mgis::Context::getLogStreamPointer ( ) const
nodiscard
Returns
a pointer to a log stream. This pointer may be null.

◆ getProfilingResultTree()

const ProfilingData & mgis::Context::getProfilingResultTree ( ) const
nodiscard
Returns
the root node of the profiling results tree gathered during execution

◆ getThrowingFailureHandler()

Context::FailureHandler< Context::FailureHandlerPolicy::RAISE > mgis::Context::getThrowingFailureHandler ( )
inlinenodiscard
Returns
a failure handler throwing exception in case of failure

◆ getVerbosityLevel()

const VerbosityLevel & mgis::Context::getVerbosityLevel ( ) const
nodiscard
Returns
the verbosity level

◆ isProfilingEnabled()

bool mgis::Context::isProfilingEnabled ( ) const
nodiscard
Returns
true if profiling is enabled, false otherwise

◆ log() [1/2]

std::ostream & mgis::Context::log ( )
nodiscard
Returns
the current log stream
Note
if no log stream is set, the default one is returned. See getDefaultLogStream for details.

◆ log() [2/2]

template<typename... Args>
std::ostream & mgis::Context::log ( const VerbosityLevel ,
Args && ... )

display the given arguments in the log stream if the current verbosity level (as returned by the getVerbosityLevel method) is greater than a minimal one.

Template Parameters
Argstypes of the arguments
Returns
the current log stream
Parameters
[in]lminimal verbosity level
[in]argsstreamed object
Note
note nothing is displayed if the current verbositiy level is below the first argument

◆ popProfilingNode()

void mgis::Context::popProfilingNode ( double )

pop the current profiling node from the execution stack and accumulate time

Parameters
[in]dtexecution time of the section in seconds
Note
this method is meant to be called internally by the Profiling class during its destruction.

◆ pushProfilingNode()

void mgis::Context::pushProfilingNode ( std::string )

push a new profiling node into the current execution stack

Parameters
[in]namename of the profiling section
Note
this method is meant to be called internally by the Profiling class during its construction.

◆ setLogStream() [1/2]

void mgis::Context::setLogStream ( std::ostream & )

set the current log stream.

Parameters
[in]slog stream
Note
the user is responsible for ensuring that the given object is alive

◆ setLogStream() [2/2]

void mgis::Context::setLogStream ( std::shared_ptr< std::ostream > )

set the current log stream.

Parameters
[in]slog stream
Note
if an empty shared pointer is given, the log stream is reset to the default one, i.e. the one returned by the mgis::getDefaultLogStream free function.

◆ setVerbosityLevel()

void mgis::Context::setVerbosityLevel ( const VerbosityLevel )

change the level of verbosity

Parameters
[in]lthe new verbose level

◆ startNewProfiling()

ProfilingSection mgis::Context::startNewProfiling ( std::string ,
bool  )
nodiscard

start a new profiling section

Parameters
[in]namename of the profiling section
[in]enabledboolean stating whether this profiling section shall effectively collect timing information
Returns
a profiling section object
Note
the returned object relies on RAII semantics: timing starts during construction and stops during destruction.

◆ warning()

template<typename... Args>
void mgis::Context::warning ( Args && ...)

a simple wrapper around the log method to print a warning

Template Parameters
Argstypes of the arguments
Parameters
[in]argsstreamed object

The documentation for this struct was generated from the following files: