parameters.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2020 W. Traylor <wolfgang.traylor@senckenberg.de>
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef FAUNA_PARAMETERS_H
#define FAUNA_PARAMETERS_H
 
#include <cassert>
#include <stdexcept>
#include "forage_values.h"
#include "text_table_writer_options.h"
 
namespace Fauna {
 
enum class ForageDistributionAlgorithm {
  Equally
};
 
enum class HerbivoreType {
  Cohort
};
 
// Note that we define it as a strictly typed C++11 enum *class* in order to be
// able to forward-declare it in other header files.
enum class OutputInterval {
  Daily,
  Monthly,
  Annual,
  Decadal
};
 
enum class OutputFormat {
  TextTables
};
 
 
struct Parameters {
  ForageDistributionAlgorithm forage_distribution =
      ForageDistributionAlgorithm::Equally;
 
 
  ForageEnergyContent forage_gross_energy = {19.0};
 
 
  int herbivore_establish_interval = 0;
 
  HerbivoreType herbivore_type = HerbivoreType::Cohort;
 
 
  bool one_hft_per_habitat = false;
  OutputFormat output_format = OutputFormat::TextTables;
 
  OutputInterval output_interval = OutputInterval::Annual;
 
  Output::TextTableWriterOptions output_text_tables;
 
  bool is_valid(std::string& messages) const;
 
 
  bool is_valid() const {
    std::string dump;
    return is_valid(dump);
  }
};
 
}  // namespace Fauna
 
#endif  // FAUNA_PARAMETERS_H