Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::DpfError

Last update: 25.03.2026

Error from DPF call.

See also: DpfException

Members

Public types

Enumeration type ErrorNature

enum ErrorNature {
  eUnknown,
  eOk,
  eComponentLoading,
  eFileNotFound,
  eRuntimeError,
  eWrongOutputType,
  eFailure,
  eUnexpectedVoidReturn,
  eUnexpectedVoidEntity,
  eUnimplemented,
  eUserInterrupted,
  eLicensingFailure,
  eUnimplementedAPI
}

Type of error

Enumerator eUnknown

Unknown error.

Enumerator eOk

No error.

Enumerator eComponentLoading

Error loading component.

Enumerator eFileNotFound

File not found error.

Enumerator eRuntimeError

Any type of runtime error.

Enumerator eWrongOutputType

Wrong output type.

Enumerator eFailure

Functionality cannot be completed.

Enumerator eUnexpectedVoidReturn

Return value expected.

Enumerator eUnexpectedVoidEntity

Return value expected.

Enumerator eUnimplemented

Functionality not implemented.

Enumerator eUserInterrupted

Execution interupted by user.

Enumerator eLicensingFailure

Licensing checks failed.

Enumerator eUnimplementedAPI

Functionality not implemented.

Public functions

Function DpfError

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

Create DPF error.

Parameters:

  • ErrorNature nature: [in] Type of error.
  • std::string const & origin: [in] Originator of error.
  • std::string const & message: [in] Error message.

Return type:

Function DpfError

ansys::dpf::DpfError::DpfError()

Return type:

Function ~DpfError

virtual ansys::dpf::DpfError::~DpfError()

Return type:

Function what

virtual const char * ansys::dpf::DpfError::what() const noexcept

Returns:

Full error message.

Return type: const char *

Function message

const char * ansys::dpf::DpfError::message() const noexcept

Returns:

User supplied error message.

Return type: const char *

Function origin

const char * ansys::dpf::DpfError::origin() const noexcept

Returns:

Originator of error.

Return type: const char *

Function nature

ErrorNature ansys::dpf::DpfError::nature() const noexcept

Returns:

Type of error.

Return type: ErrorNature

Function isOk

bool ansys::dpf::DpfError::isOk() const noexcept

Returns:

Indication of error.

Return type: bool

Function clear

void ansys::dpf::DpfError::clear() noexcept

Reset to empty state.

Return type: void

Connect with Ansys