FastJet  3.3.3
Public Member Functions | Static Public Member Functions | List of all members
fastjet::Error Class Reference

base class corresponding to errors that can be thrown by FastJet More...

#include <fastjet/Error.hh>

Inheritance diagram for fastjet::Error:
Inheritance graph
[legend]

Public Member Functions

 Error ()
 default constructors
 
 Error (const std::string &message)
 ctor from an error message More...
 
virtual ~Error ()
 virtual dummy dtor
 
std::string message () const
 the error message
 
std::string description () const
 an alternative access to the error message (more standard)
 

Static Public Member Functions

static void set_print_errors (bool print_errors)
 controls whether the error message (and the backtrace, if its printing is enabled) is printed out or not
 
static void set_print_backtrace (bool enabled)
 controls whether the backtrace is printed out with the error message or not. More...
 
static void set_default_stream (std::ostream *ostr)
 sets the default output stream for all errors; by default cerr; if it's null then error output is suppressed. More...
 

Detailed Description

base class corresponding to errors that can be thrown by FastJet

Definition at line 47 of file Error.hh.

Constructor & Destructor Documentation

◆ Error()

fastjet::Error::Error ( const std::string &  message)

ctor from an error message

Parameters
messageto be printed Note: in addition to the error message, one can choose to print the backtrace (showing the last few calls before the error) by using set_print_backtrace(true). The default is "false".

Definition at line 112 of file Error.cc.

Member Function Documentation

◆ set_print_backtrace()

void fastjet::Error::set_print_backtrace ( bool  enabled)
static

controls whether the backtrace is printed out with the error message or not.

The default is "false".

Definition at line 159 of file Error.cc.

◆ set_default_stream()

static void fastjet::Error::set_default_stream ( std::ostream *  ostr)
inlinestatic

sets the default output stream for all errors; by default cerr; if it's null then error output is suppressed.

Definition at line 78 of file Error.hh.


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