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

Defines an exception caused by a hardware operation on a COM port (e.g. reading/writing data to a COM port). More...

+ Inheritance diagram for DynExp::SerialPortException:

Public Member Functions

 SerialPortException (std::string Description, const int ErrorCode, const std::source_location Location=std::source_location::current()) noexcept
 Constructs a SerialPortException instance. More...
 
- Public Member Functions inherited from DynExp::SerialCommunicationException
 SerialCommunicationException (std::string Description, const int ErrorCode, const std::source_location Location=std::source_location::current()) noexcept
 Constructs a SerialCommunicationException instance. More...
 
- 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

Defines an exception caused by a hardware operation on a COM port (e.g. reading/writing data to a COM port).

Definition at line 25 of file HardwareAdapterSerialPort.h.

Constructor & Destructor Documentation

◆ SerialPortException()

DynExp::SerialPortException::SerialPortException ( std::string  Description,
const int  ErrorCode,
const std::source_location  Location = std::source_location::current() 
)
inlinenoexcept

Constructs a SerialPortException instance.

Parameters
DescriptionDescription explaining the cause of the exception in detail for the user.
ErrorCodeError code from Util::DynExpErrorCodes::DynExpErrorCodes
LocationOrigin of the exception. Refer to Util::Exception::Exception().

Definition at line 34 of file HardwareAdapterSerialPort.h.


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