OptionsHandler.h

Go to the documentation of this file.

#ifndef art_Framework_Art_OptionsHandler_h
#define art_Framework_Art_OptionsHandler_h
// Simple interface to allow easy addition of experiment-specific
// command-line options and their processing.

#include "boost/program_options.hpp"
#include "fhiclcpp/fwd.h"

namespace bpo = boost::program_options;

namespace art {

  class OptionsHandler {
  public:
    virtual ~OptionsHandler() = default;

    int checkOptions(bpo::variables_map const& vm);
    int processOptions(bpo::variables_map const& vm,
                       fhicl::intermediate_table& raw_config);

  private:
    // Check selected options for consistency (should throw on failure).
    virtual int doCheckOptions(bpo::variables_map const& vm) = 0;
    // Act on selected options  (should throw on failure).
    virtual int doProcessOptions(bpo::variables_map const& vm,
                                 fhicl::intermediate_table& raw_config) = 0;
  };

  // Clang-format has trouble with the 'add_options()()()...()'
  // pattern.  We therefore provide a template to facilitate a better
  // format.
  template <typename T, typename... Args>
  void
  add_opt(T& t, Args&&... args)
  {
    t(std::forward<Args>(args)...);
  }

} // namespace art

#endif /* art_Framework_Art_OptionsHandler_h */

// Local Variables:
// mode: c++
// End: