command_line_options.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// Copyright (C) 2021 CERN & University of Surrey for the benefit of the
// BioDynaMo collaboration. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
//
// See the LICENSE file distributed with this work for details.
// See the NOTICE file distributed with this work for additional information
// regarding copyright ownership.
//
// -----------------------------------------------------------------------------
 
#ifndef CORE_PARAM_COMMAND_LINE_OPTIONS_H_
#define CORE_PARAM_COMMAND_LINE_OPTIONS_H_
 
#define CXXOPTS_VECTOR_DELIMITER '\n'
#include <TError.h>
#include <cxxopts.h>
 
#include <algorithm>
#include <iostream>
#include <ostream>
#include <string>
#include <utility>
 
#include "bdm_version.h"
#include "core/simulation.h"
 
namespace bdm {
 
class CommandLineOptions {
 public:
  CommandLineOptions(int argc, const char** argv);
 
  ~CommandLineOptions();
 
  template <typename T>
  void AddOption(const std::string& opt, std::string def,
                 const std::string& description = "",
                 std::string group = "Simulation") {
    AddOption(std::move(group))(opt, description,
                                cxxopts::value<T>()->default_value(def));
  }
 
  std::string GetSimulationName() const;
 
  bool IsSet(std::string option);
 
  template <typename T>
  T Get(const std::string& val) {
    if (parser_ == nullptr) {
      this->Parse();
    }
    return (*parser_)[val].as<T>();
  }
 
 private:
  friend std::ostream& operator<<(std::ostream& os,
                                  const CommandLineOptions& clo);
 
  void AddCoreOptions();
 
  cxxopts::OptionAdder AddOption(std::string group = "Simulation");
 
  void Parse();
 
  void ExtractSimulationName(const char* path);
 
  void HandleCoreOptions();
 
  int argc_;
  const char** argv_;
  // The name of the simulation
  std::string sim_name_;
 
  // Flag to determine if new options were added
  bool first_parse_ = true;
  cxxopts::Options options_;
  cxxopts::ParseResult* parser_ = nullptr;
};
 
}  // namespace bdm
 
#endif  // CORE_PARAM_COMMAND_LINE_OPTIONS_H_