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

An exception class thrown when an attempt is made that violates a range constraint. More...

#include <Exceptions.hpp>

Inheritance diagram for meshkernel::ConstraintError:
meshkernel::MeshKernelError

Public Member Functions

template<typename... Args>
 MeshKernelError (FormatString const &format_string, Args &&... args)
 Class constructor.
 
- 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

- Protected Member Functions inherited from meshkernel::MeshKernelError
virtual std::string FormattedMessage () const
 Returns the message.
 

Detailed Description

An exception class thrown when an attempt is made that violates a range constraint.

  1. When an index is out of bounds or violates a range constraint.
  2. Attempt to retrieve a component that does not exist.

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