include/apfel/messages.h

0001 //
0002 // APFEL++ 2017
0003 //
0004 // Author: Valerio Bertone: valerio.bertone@cern.ch
0005 //
0006
0007 #pragma once
0008
0009 #include <sstream>
0010 #include <iostream>
0011
0012 /**
0013  * @brief Namespace for all APFEL++ functions and classes
0014  */
0015 namespace apfel
0016 {
0017   /**
0018    * @name Message functions
0019    * Collection of functions related to the verbosity of the code.
0020    */
0021   ///@{
0022   /**
0023    * @brief Set Verbosity level
0024    * @param vl: verbosity level
0025    * @note possible values of vl:
0026    * LOW    = No informative and warning messages are displayed. Error messages are printed anyway
0027    * MEDIUM = No informative messages are displayed. Warning and error messages are printed
0028    * HIGH   = All messages are displayed
0029    */
0030   void SetVerbosityLevel(int const& vl);
0031
0032   /**
0033    * @brief Get Verbosity level
0034    * @return the current verbosity level
0035    */
0036   int GetVerbosityLevel();
0037
0038   /**
0039    * @brief Function that prints information on screen. Effective
0040    * according to the verbosity level.
0041    * @param what: the message to report
0042    */
0043   void report(std::string const& what);
0044
0045   /**
0046    * @brief Function that prints information on screen. Effective
0047    * according to the verbosity level.
0048    * @param tag: the emitter of the message
0049    * @param what: the message to report
0050    */
0051   void info(std::string const& tag, std::string const& what);
0052
0053   /**
0054    * @brief Function that prints warnings on screen. Effective
0055    * according to the verbosity level.
0056    * @param tag: the emitter of the message
0057    * @param what: the warning to report
0058    */
0059   void warning(std::string const& tag, std::string const& what);
0060
0061   /**
0062    * @brief Function that prints information on screen. Always
0063    * effective.
0064    * @param tag: the function that generates the error
0065    * @param what: the error to report
0066    * @return the error message
0067    */
0068   std::string error(std::string const& tag, std::string const& what);
0069
0070   /**
0071    * @brief Function that prints the APFEL++ banner on
0072    * screen. Effective according to the verbosity level.
0073    */
0074   void Banner();
0075   ///@}
0076 }