MeshKernel
Public Member Functions | List of all members
meshkernel::MeshGeometryError Class Referencefinal

A class for throwing mesh geometry errors. More...

#include <Exceptions.hpp>

Inheritance diagram for meshkernel::MeshGeometryError:
meshkernel::MeshKernelError

Public Member Functions

template<typename... Args>
 MeshGeometryError (meshkernel::UInt mesh_index, Location mesh_location, FormatString const &format_string, Args &&... args)
 Class constructor. More...
 
meshkernel::UInt MeshIndex () const
 Returns the invalid index. More...
 
Location MeshLocation () const
 Returns the mesh location. More...
 
- Public Member Functions inherited from meshkernel::MeshKernelError
template<typename... Args>
 MeshKernelError (FormatString const &format_string, Args &&... args)
 Class constructor. More...
 
virtual ~MeshKernelError ()=default
 Class destructor.
 
const char * what () const noexcept override
 Returns the explanatory string of the error. More...
 
ExitCode Code () const
 Returns the exit code. More...
 

Additional Inherited Members

Detailed Description

A class for throwing mesh geometry errors.

Constructor & Destructor Documentation

◆ MeshGeometryError()

template<typename... Args>
meshkernel::MeshGeometryError::MeshGeometryError ( meshkernel::UInt  mesh_index,
Location  mesh_location,
FormatString const &  format_string,
Args &&...  args 
)
inline

Class constructor.

Parameters
[in]mesh_indexThe mesh index
[in]mesh_locationThe mesh location
[in]format_stringThe format string
[in]argsThe arguments to be formatted.

Member Function Documentation

◆ MeshIndex()

meshkernel::UInt meshkernel::MeshGeometryError::MeshIndex ( ) const
inline

Returns the invalid index.

Returns
The invalid index.

◆ MeshLocation()

Location meshkernel::MeshGeometryError::MeshLocation ( ) const
inline

Returns the mesh location.

Returns
The mesh location.

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