DPF C++ client library 2023 R2

ansys::dpf::DpfException Class Reference

Last update: 10.07.2023

#include <dpf_api_base.h>

Inherits std::exception.

Public Member Functions

 DpfException (DpfError::ErrorNature nature, std::string const &origin, std::string const &message)
 
 DpfException (DpfError const &error)
 
virtual const char * what () const noexcept
 
const char * message () const noexcept
 
const char * origin () const noexcept
 
DpfError::ErrorNature nature () const noexcept
 
DpfError error () const noexcept
 

Detailed Description

Exception thrown by DPF call.

Constructor & Destructor Documentation

◆ DpfException() [1/2]

ansys::dpf::DpfException::DpfException ( DpfError::ErrorNature  nature,
std::string const &  origin,
std::string const &  message 
)

Create exception to throw.

Parameters
[in]natureType of error.
[in]originOriginator of error.
[in]messageError message.

◆ DpfException() [2/2]

ansys::dpf::DpfException::DpfException ( DpfError const &  error)

Create exception to throw.

Parameters
[in]errorError.

Member Function Documentation

◆ error()

DpfError ansys::dpf::DpfException::error ( ) const
noexcept
Returns
Generated DpfError.

◆ message()

const char * ansys::dpf::DpfException::message ( ) const
noexcept
Returns
User supplied error message.

◆ nature()

DpfError::ErrorNature ansys::dpf::DpfException::nature ( ) const
noexcept
Returns
Type of error.

◆ origin()

const char * ansys::dpf::DpfException::origin ( ) const
noexcept
Returns
Originator of error.

◆ what()

virtual const char * ansys::dpf::DpfException::what ( ) const
virtualnoexcept
Returns
Full error message.

Connect with Ansys