CommonOptions.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file CommonOptions.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2017-2019 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Utilities/EnumBitwiseOperators.hpp"
#include "Acts/Utilities/Logger.hpp"
#include "ActsExamples/Framework/RandomNumbers.hpp"
#include "ActsExamples/Framework/Sequencer.hpp"

#include <string>

#include <boost/program_options.hpp>

namespace ActsExamples {

enum class OutputFormat : uint8_t {
  DirectoryOnly = 0,
  Root = 1,
  Csv = 2,
  Obj = 4,
  Json = 8,
  Cbor = 16,
  Txt = 32,
  All = std::numeric_limits<uint8_t>::max()
};

ACTS_DEFINE_ENUM_BITWISE_OPERATORS(OutputFormat)

namespace Options {

boost::program_options::options_description makeDefaultOptions(
    const std::string& caption = std::string());

void addSequencerOptions(boost::program_options::options_description& opt);

void addRandomNumbersOptions(boost::program_options::options_description& opt);

void addGeometryOptions(boost::program_options::options_description& opt);

void addMaterialOptions(boost::program_options::options_description& opt);

void addInputOptions(boost::program_options::options_description& opt);

void addOutputOptions(boost::program_options::options_description& opt,
                      OutputFormat format);

boost::program_options::variables_map parse(
    const boost::program_options::options_description& opt, int argc,
    char* argv[]);

Acts::Logging::Level readLogLevel(
    const boost::program_options::variables_map& vm);

Sequencer::Config readSequencerConfig(
    const boost::program_options::variables_map& vm);

// Read the random numbers config.
RandomNumbers::Config readRandomNumbersConfig(
    const boost::program_options::variables_map& vm);

}  // namespace Options
}  // namespace ActsExamples