allpix::EndOfRunException
Module: Exception classes
Exception for modules to request an end of the event processing. More…
#include <exceptions.h>
Inherits from allpix::RuntimeError, allpix::Exception, std::exception
Inherited by allpix::AbortEventException
Public Functions
| Name | |
|---|---|
| EndOfRunException(std::string reason) Constructs request to end event processing with a description. |
Additional inherited members
Public Functions inherited from allpix::RuntimeError
| Name | |
|---|---|
| RuntimeError(std::string what_arg) Creates exception with the given runtime problem. |
Protected Functions inherited from allpix::RuntimeError
| Name | |
|---|---|
| RuntimeError() =default Internal constructor for exceptions setting the error message indirectly. |
Public Functions inherited from allpix::Exception
| Name | |
|---|---|
| Exception(std::string what_arg) Creates exception with the specified problem. |
|
| const char * | what() const override Return the error message. |
Protected Functions inherited from allpix::Exception
| Name | |
|---|---|
| Exception() =default Internal constructor for exceptions setting the error message indirectly. |
Protected Attributes inherited from allpix::Exception
| Name | |
|---|---|
| std::string | error_message_ |
Detailed Description
class allpix::EndOfRunException;
Exception for modules to request an end of the event processing.
Note: Non-fatal error used to interrupt the event loop and call the finalize function.
This error can be raised by modules if they would like to request an interruption of the event processing, e.g. because there are no more events to read from a file.
Public Functions Documentation
function EndOfRunException
inline explicit EndOfRunException(
std::string reason
)
Constructs request to end event processing with a description.
Parameters:
- reason Text explaining the reason of the requested end of event processing
Updated on 2024-12-13 at 08:31:37 +0000