## On this page

  

 

 # ansys::dpf::DpfException Class Reference

 Last update: 16.07.2025 

`#include <dpf_api_base.h>`

Inherits std::exception.

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [DpfException](classansys_1_1dpf_1_1DpfException.xhtml#ab417aeb3168e72745df2f8c98d912428) ([DpfError::ErrorNature](classansys_1_1dpf_1_1DpfError.xhtml#a9a3fe202cc2e46746462fdb1ce44c47f) [nature](classansys_1_1dpf_1_1DpfException.xhtml#ad21aba4144b3dbcb6e619931ac6ae6ed), std::string const &amp;[origin](classansys_1_1dpf_1_1DpfException.xhtml#a613c503433eb563fed99099941cc416d), std::string const &amp;[message](classansys_1_1dpf_1_1DpfException.xhtml#a69cc4e277ea17f9e7d83872db1edbf24))  [DpfException](classansys_1_1dpf_1_1DpfException.xhtml#a692cdeed9babf4395f9ce12c64a35818) ([DpfError](classansys_1_1dpf_1_1DpfError.xhtml) const &amp;[error](classansys_1_1dpf_1_1DpfException.xhtml#a07c601a38ec182b458074da6f0e52478)) virtual const char \* [what](classansys_1_1dpf_1_1DpfException.xhtml#a0df1c0ba45617a9f207739f935d0e074) () const noexcept const char \* [message](classansys_1_1dpf_1_1DpfException.xhtml#a69cc4e277ea17f9e7d83872db1edbf24) () const noexcept const char \* [origin](classansys_1_1dpf_1_1DpfException.xhtml#a613c503433eb563fed99099941cc416d) () const noexcept [DpfError::ErrorNature](classansys_1_1dpf_1_1DpfError.xhtml#a9a3fe202cc2e46746462fdb1ce44c47f) [nature](classansys_1_1dpf_1_1DpfException.xhtml#ad21aba4144b3dbcb6e619931ac6ae6ed) () const noexcept [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) [error](classansys_1_1dpf_1_1DpfException.xhtml#a07c601a38ec182b458074da6f0e52478) () const noexcept <a id="details" name="details"></a>## Detailed Description

Exception thrown by DPF call.



## Constructor &amp; Destructor Documentation

<a id="ab417aeb3168e72745df2f8c98d912428" name="ab417aeb3168e72745df2f8c98d912428"></a>## [◆ ](#ab417aeb3168e72745df2f8c98d912428)DpfException() \[1/2\]

 ansys::dpf::DpfException::DpfException  ( [DpfError::ErrorNature](classansys_1_1dpf_1_1DpfError.xhtml#a9a3fe202cc2e46746462fdb1ce44c47f)  *nature*,    std::string const &amp;  *origin*,    std::string const &amp;  *message*   ) 

Create exception to throw.

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



<a id="a692cdeed9babf4395f9ce12c64a35818" name="a692cdeed9babf4395f9ce12c64a35818"></a>## [◆ ](#a692cdeed9babf4395f9ce12c64a35818)DpfException() \[2/2\]

 ansys::dpf::DpfException::DpfException  ( [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) const &amp;  *error*) 

Create exception to throw.

Parameters \[in\]errorError. 



## Member Function Documentation

<a id="a07c601a38ec182b458074da6f0e52478" name="a07c601a38ec182b458074da6f0e52478"></a>## [◆ ](#a07c601a38ec182b458074da6f0e52478)error()

 [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) ansys::dpf::DpfException::error  ( )  const  noexcept 

ReturnsGenerated [DpfError](classansys_1_1dpf_1_1DpfError.xhtml). 



<a id="a69cc4e277ea17f9e7d83872db1edbf24" name="a69cc4e277ea17f9e7d83872db1edbf24"></a>## [◆ ](#a69cc4e277ea17f9e7d83872db1edbf24)message()

 const char \* ansys::dpf::DpfException::message  ( )  const  noexcept 

ReturnsUser supplied error message. 



<a id="ad21aba4144b3dbcb6e619931ac6ae6ed" name="ad21aba4144b3dbcb6e619931ac6ae6ed"></a>## [◆ ](#ad21aba4144b3dbcb6e619931ac6ae6ed)nature()

 [DpfError::ErrorNature](classansys_1_1dpf_1_1DpfError.xhtml#a9a3fe202cc2e46746462fdb1ce44c47f) ansys::dpf::DpfException::nature  ( )  const  noexcept 

ReturnsType of error. 



<a id="a613c503433eb563fed99099941cc416d" name="a613c503433eb563fed99099941cc416d"></a>## [◆ ](#a613c503433eb563fed99099941cc416d)origin()

 const char \* ansys::dpf::DpfException::origin  ( )  const  noexcept 

ReturnsOriginator of error. 



<a id="a0df1c0ba45617a9f207739f935d0e074" name="a0df1c0ba45617a9f207739f935d0e074"></a>## [◆ ](#a0df1c0ba45617a9f207739f935d0e074)what()

 virtual const char \* ansys::dpf::DpfException::what  ( )  const  virtualnoexcept 

ReturnsFull error message.