habitat_forage.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_FORAGE_H
#define FAUNA_HABITAT_FORAGE_H
 
#include "Fauna/forage_types.h"
#include "Fauna/forage_values.h"
#include "Fauna/grass_forage.h"
 
namespace Fauna {
 
class HabitatForage {
 public:
  HabitatForage() {}
 
  // TODO: Move this member variable to private and implement a getter.
  GrassForage grass;
 
  // ADD NEW FORAGE TYPES (E.G. BROWSE) HERE.
 
 
  Digestibility get_digestibility() const;
 
  ForageMass get_mass() const;
 
  ForageFraction get_nitrogen_content();
 
 
  ForageBase get_total() const;
 
  HabitatForage& merge(const HabitatForage& other, const double this_weight,
                       const double other_weight);
 
 
  const ForageBase& operator[](const ForageType ft) const {
    switch (ft) {
      case ForageType::Grass:
        return grass;
        // ADD NEW FORAGE TYPES HERE.
      case ForageType::Inedible:
        return inedible;
      default:
        throw std::logic_error((std::string)
                                             "Fauna::HabitatForage::operator[]()const "
                                             "Forage type \"" +
                                             get_forage_type_name(ft) + "\" "
                                             "is not implemented.");
    }
  }
 
  ForageBase& operator[](const ForageType ft) {
    switch (ft) {
      case ForageType::Grass:
        return grass;
        // ADD NEW FORAGE TYPES HERE.
      case ForageType::Inedible:
        return inedible;
      default:
        throw std::logic_error(
            "Fauna::HabitatForage::operator[]() "
            "Forage type \"" +
            get_forage_type_name(ft) +
            "\" "
            "is not implemented.");
    }
  }
 
 
  void set_nitrogen_content(const ForageFraction& nitrogen_content);
 
 private:
 
  ForageBase inedible;
};
}  // namespace Fauna
#endif  // FAUNA_HABITAT_FORAGE_H