DynExp
Highly flexible laboratory automation for dynamically changing experiments.
Util::TimeoutException Class Reference

Thrown when an operation timed out before it could be completed, especially used for locking shared data in a multi-threading context. More...

+ Inheritance diagram for Util::TimeoutException:

Public Member Functions

 TimeoutException (std::string Description, const ErrorType Type=ErrorType::Warning, const int ErrorCode=DynExpErrorCodes::Timeout, const std::source_location Location=std::source_location::current()) noexcept
 
- Public Member Functions inherited from Util::Exception
 Exception (std::string Description, const ErrorType Type=ErrorType::Error, const int ErrorCode=-1, const std::source_location Location=std::source_location::current()) noexcept
 Constructs an exception. Constructor is noexcept, although std::runtime_error() might throw std::bad_alloc issuing a call to std::terminate(), which might be the best solution in that case. More...
 
virtual ~Exception ()=default
 
constexpr const char * GetErrorLabel () const
 
constexpr const char * GetErrorLabelColor () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Util::Exception
constexpr static const char * GetErrorLabel (const ErrorType Type)
 Converts an error type to a user-readable label for logging. More...
 
constexpr static const char * GetErrorLabelColor (const ErrorType Type)
 Converts an error type to an HTML color name for logging. More...
 
- Public Attributes inherited from Util::Exception
const ErrorType Type
 DynExp error type from Util::ErrorType More...
 
const int ErrorCode
 DynExp error code from DynExpErrorCodes::DynExpErrorCodes More...
 
const size_t Line
 Line in source code where the exception occurred. More...
 
const std::string Function
 Function in source code where the exception occurred
More...
 
const std::string File
 Source code file where the exception occurred. More...
 

Detailed Description

Thrown when an operation timed out before it could be completed, especially used for locking shared data in a multi-threading context.

Definition at line 260 of file Exception.h.

Constructor & Destructor Documentation

◆ TimeoutException()

Util::TimeoutException::TimeoutException ( std::string  Description,
const ErrorType  Type = ErrorType::Warning,
const int  ErrorCode = DynExpErrorCodes::Timeout,
const std::source_location  Location = std::source_location::current() 
)
inlinenoexcept

Definition at line 263 of file Exception.h.


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