fourdst::libcomposition v1.5.2
Robust atomic species information library
Loading...
Searching...
No Matches
fourdst::composition::exceptions::CompositionError Class Reference

Base class for exceptions related to composition objects. More...

#include <exceptions_composition.h>

Inheritance diagram for fourdst::composition::exceptions::CompositionError:
fourdst::composition::exceptions::CompositionNotFinalizedError fourdst::composition::exceptions::FailedToFinalizeCompositionError fourdst::composition::exceptions::InvalidCompositionError fourdst::composition::exceptions::InvalidMixingMode fourdst::composition::exceptions::InvalidSymbolError fourdst::composition::exceptions::UnregisteredSymbolError

Public Member Functions

 CompositionError (const std::string &message)
 Constructs a CompositionError with an error message.
 
const char * what () const noexcept override
 Returns the error message.
 

Protected Attributes

std::string m_message
 The error message.
 

Detailed Description

Base class for exceptions related to composition objects.

This exception is thrown when an error occurs at the composition level, such as invalid configuration or state.

Definition at line 14 of file exceptions_composition.h.

Constructor & Destructor Documentation

◆ CompositionError()

fourdst::composition::exceptions::CompositionError::CompositionError ( const std::string & message)
inlineexplicit

Constructs a CompositionError with an error message.

Parameters
messageThe error message.

Definition at line 25 of file exceptions_composition.h.

Member Function Documentation

◆ what()

const char * fourdst::composition::exceptions::CompositionError::what ( ) const
inlineoverridenoexcept

Returns the error message.

Returns
A C-style string containing the error message.

Definition at line 32 of file exceptions_composition.h.

Member Data Documentation

◆ m_message

std::string fourdst::composition::exceptions::CompositionError::m_message
protected

The error message.

Definition at line 19 of file exceptions_composition.h.


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