SpeciesFields.h

#pragma once
 
#include "ParameterLibrary.h"
 
#include <functional>
#include <optional>
#include <string>
#include <vector>
 
namespace environment
{
class EnvironmentProvider;
}
 
enum class WithoutSpecies
{
   Allow,   
   Exclude, 
   Refuse,  
};
 
struct SpeciesFieldRules
{
   std::string              namesParameter;                          
   std::vector<std::string> removedKeys;                             
   std::string              removedReason;                           
   WithoutSpecies           withoutSpecies = WithoutSpecies::Refuse; 
   bool                     lengthRequired = true;                   
};
 
struct BoundSpeciesField
{
   std::string                      name;              
   int                              handle = -1;       
   std::string                      speciesKey;        
   const ParameterLibrary::Species* model   = nullptr; 
   double                           lengthM = 0.0;     
};
 
struct SpeciesBinding
{
   std::optional<ParameterLibrary> library;  
   std::vector<BoundSpeciesField>  fields;   
   std::vector<std::string>        excluded; 
   std::vector<std::string>        errors;   
};
 
inline constexpr const char* kSpeciesLengthKey = "LengthM";
 
std::vector<std::string> DiscoverSpeciesFieldNames(const environment::EnvironmentProvider& environment);
 
SpeciesBinding BindSpeciesFields(const environment::EnvironmentProvider& environment, const std::vector<std::string>& names,
      const SpeciesFieldRules& rules, const std::function<ParameterLibrary()>& loadLibrary);