habitat.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_HABITAT_H
#define FAUNA_HABITAT_H
 
#include <cassert>
#include <list>
#include <memory>
#include "Fauna/Output/habitat_data.h"
 
namespace Fauna {
// Forward Declarations
struct HabitatEnvironment;
 
 
class Habitat {
 public:
 
  virtual ~Habitat() {}
 
 
  virtual const char* get_aggregation_unit() const = 0;
 
 
  virtual HabitatForage get_available_forage() const = 0;
 
 
  virtual HabitatEnvironment get_environment() const = 0;
 
 
  virtual void init_day(const int today);
 
  bool is_dead() const { return killed; }
 
 
  void kill() { killed = true; }
 
 
  virtual void remove_eaten_forage(const ForageMass& eaten_forage) {
    get_todays_output().eaten_forage += eaten_forage;
  }
 
 
  int get_day() const { return day_of_year; }
 
  const Output::HabitatData& get_todays_output() const {
    return current_output;
  }
 
 protected:
  Output::HabitatData& get_todays_output() { return current_output; }
 
 private:
  Output::HabitatData current_output;
  int day_of_year;
  bool killed = false;
};
 
typedef std::list<const Habitat*> HabitatList;
}  // namespace Fauna
#endif  // FAUNA_HABITAT_H