allpix::AbortEventException

Module: Exception classes

Exception for modules to request the abortion of the current event. More…

#include <exceptions.h>

Inherits from allpix::EndOfRunException, allpix::RuntimeError, allpix::Exception, std::exception

Public Functions

Name
AbortEventException(std::string reason)
Constructs request to abort the current event processing with a description.

Additional inherited members

Public Functions inherited from allpix::EndOfRunException

Name
EndOfRunException(std::string reason)
Constructs request to end event processing with a description.

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::AbortEventException;

Exception for modules to request the abortion of the current event.

Note: Non-fatal error used to interrupt the processing of the current event.

This error can be raised by modules if they would like to request an interruption of the current event processing because an issue was detected.

Public Functions Documentation

function AbortEventException

inline explicit AbortEventException(
    std::string reason
)

Constructs request to abort the current event processing with a description.

Parameters:

  • reason Text explaining the reason of the requested abortion of the event

Updated on 2025-05-10 at 19:40:39 +0000