FuelLookup.h

/* Copyright (c) Queen's Printer for Ontario, 2020. */
/* Copyright (c) His Majesty the King in Right of Canada as represented by the Minister of Natural Resources, 2025. */
 
/* SPDX-License-Identifier: AGPL-3.0-or-later */
 
#pragma once
#include <memory>
#include <set>
#include <string>
#include "FuelType.h"
#include "Cell.h"
#include "Util.h"
namespace fs::fuel
{
class FuelLookupImpl;
 
string simplify_fuel_name(const string& fuel);
 
class FuelLookup
{
public:
  ~FuelLookup() = default;
  explicit FuelLookup(const char* filename);
  FuelLookup(const FuelLookup& rhs) noexcept = default;
  FuelLookup(FuelLookup&& rhs) noexcept = default;
  FuelLookup& operator=(const FuelLookup& rhs) noexcept = default;
  FuelLookup& operator=(FuelLookup&& rhs) noexcept = default;
  [[nodiscard]] const FuelType* codeToFuel(FuelSize value, FuelSize nodata) const;
  void listFuels() const;
  [[nodiscard]] FuelSize fuelToCode(const FuelType* fuel) const;
  [[nodiscard]] const FuelType* operator()(FuelSize value, FuelSize nodata) const;
  [[nodiscard]] set<const FuelType*> usedFuels() const;
  [[nodiscard]] const FuelType* byName(const string& name) const;
  [[nodiscard]] const FuelType* bySimplifiedName(const string& name) const;
  static const array<const FuelType*, NUMBER_OF_FUELS> Fuels;
private:
  shared_ptr<FuelLookupImpl> impl_;
};
[[nodiscard]] constexpr const FuelType* fuel_by_code(const FuelCodeSize& code)
{
  return FuelLookup::Fuels.at(code);
}
[[nodiscard]] constexpr const FuelType* check_fuel(const topo::Cell& cell)
{
  return fuel_by_code(cell.fuelCode());
}
[[nodiscard]] constexpr bool is_null_fuel(const FuelType* fuel)
{
  return INVALID_FUEL_CODE == FuelType::safeCode(fuel);
}
[[nodiscard]] constexpr bool is_null_fuel(const topo::Cell& cell)
{
  return is_null_fuel(fuel_by_code(cell.fuelCode()));
}
}