diff --git a/include/HEJ/get_analysis.hh b/include/HEJ/get_analysis.hh index 2d0dc5f..959a232 100644 --- a/include/HEJ/get_analysis.hh +++ b/include/HEJ/get_analysis.hh @@ -1,50 +1,50 @@ /** \file * \brief Contains the get_analysis function * * \authors The HEJ collaboration (see AUTHORS for details) * \date 2019-2020 * \copyright GPLv2 or later */ #pragma once #include #include #include "HEJ/Analysis.hh" namespace YAML { class Node; } namespace HEJ { //! Load an analysis /** * @param parameters Analysis parameters * @param heprup General run informations * @returns A pointer to an Analysis instance * * If parameters["plugin"] exists, an analysis (deriving from the * \ref Analysis class) will be loaded from the library parameters["plugin"]. * Otherwise, if parameters["rivet"] exists, the corresponding RivetAnalysis * will be loaded. If none of these parameters are specified, a pointer to * the default EmptyAnalysis is returned. */ #ifndef HEJ_ALLOW_GET_ANALYSIS [[deprecated( "Instead of a pointer to an EmptyAnalysis," - "this function will return a null pointer from HEJ 2.1 on. " + "this function will return a null pointer from HEJ 2.3 on. " "Compile with -DHEJ_ALLOW_GET_ANALYSIS to disable this warning." )]] #endif std::unique_ptr get_analysis( YAML::Node const & parameters, LHEF::HEPRUP const & heprup); //! Loads multiple analysis, vector version of get_analysis() /** * @param parameters Vector of Analysis parameters * @param heprup General run informations * @returns Vector of pointers to an Analysis instance */ std::vector> get_analyses( std::vector const & parameters, LHEF::HEPRUP const & heprup); } // namespace HEJ