meshkernel::MeshKernelError Class Reference

A class for throwing general MeshKernel exceptions. More...

#include <Exceptions.hpp>

Inheritance diagram for meshkernel::MeshKernelError:

Public Member Functions
template<typename... Args>
	MeshKernelError (FormatString const &format_string, Args &&... args)
	Class constructor.
virtual	~MeshKernelError ()=default
	Class destructor.
const char *	what () const noexcept override
	Returns the explanatory string of the error.
ExitCode	Code () const
	Returns the exit code.

Protected Member Functions
virtual ErrorCategory	Category () const
	Returns the error category.
virtual std::string	FormattedMessage () const
	Returns the message.

Detailed Description

A class for throwing general MeshKernel exceptions.

Constructor & Destructor Documentation

MeshKernelError()

template<typename... Args>

meshkernel::MeshKernelError::MeshKernelError ( FormatString const &  format_string, Args &&...  args  )

inline

Class constructor.

Parameters

[in]	format_string	The format string
[in]	args	The arguments to be formatted.

Member Function Documentation

Category()

virtual ErrorCategory meshkernel::MeshKernelError::Category ( ) const

inlineprotectedvirtual

Returns the error category.

Returns

The error category.

Code()

ExitCode meshkernel::MeshKernelError::Code ( ) const

inline

Returns the exit code.

Returns

The exit code

what()

const char * meshkernel::MeshKernelError::what ( ) const

inlineoverridenoexcept

Returns the explanatory string of the error.

Returns

The explanatory string of the error.

---

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

• /home/runner/work/MeshKernel/MeshKernel/libs/MeshKernel/include/MeshKernel/Exceptions.hpp