world.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_WORLD_H
#define FAUNA_WORLD_H
 
#include <list>
#include <memory>
#include <vector>
 
namespace Fauna {
// Forward declarations
class Date;
class Habitat;
class Hft;
struct Parameters;
class SimulationUnit;
class WorldConstructor;
 
// Repeat typedef from hft.h
typedef std::vector<std::shared_ptr<const Hft> > HftList;
 
namespace Output {
class Aggregator;
class WriterInterface;
}  // namespace Output
 
enum class SimMode {
 
  Lint,
  Simulate
};
 
class World {
 public:
 
  World(const std::string instruction_filename,
        const SimMode mode = SimMode::Simulate);
 
 
  World(const std::shared_ptr<const Parameters> params,
        const std::shared_ptr<const HftList> hftlist);
 
 
  World();
 
  ~World();
 
 
  void create_simulation_unit(std::shared_ptr<Habitat> habitat);
 
 
  const Parameters& get_params() const;
 
 
  const std::list<SimulationUnit>& get_sim_units() const { return sim_units; }
 
  const bool is_activated() const { return mode == SimMode::Simulate; }
 
  struct SimDayOptions {
    SimDayOptions() {}
 
 
    bool do_herbivores = true;
 
 
    bool reset_date = false;
  };
 
 
  void simulate_day(const Date& date,
                    const SimDayOptions& opts = SimDayOptions());
 
 
  void simulate_day(const Date& date, const bool do_herbivores) {
    SimDayOptions opts;
    opts.do_herbivores = do_herbivores;
    simulate_day(date, opts);
  }
 
 private:
 
  int get_habitat_count_per_agg_unit() const;
 
  const HftList& get_hfts() const;
 
 
  Output::WriterInterface* construct_output_writer() const;
 
  const SimMode mode = SimMode::Simulate;
 
 
  bool simulation_units_checked = false;
 
 
  struct InsfileContent {
    const std::shared_ptr<const HftList> hftlist;
    const std::shared_ptr<const Parameters> params;
  } insfile;
 
  int days_since_last_establishment;
 
 
  std::unique_ptr<Fauna::Date> last_date;
 
  const std::unique_ptr<Output::Aggregator> output_aggregator;
 
  std::unique_ptr<Output::WriterInterface> output_writer;
 
  static InsfileContent read_instruction_file(const std::string& filename);
 
 
  std::list<SimulationUnit> sim_units;
 
  const std::unique_ptr<WorldConstructor> world_constructor;
};
}  // namespace Fauna
#endif  // FAUNA_WORLD_H