Event.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 "stdafx.h"
#include "Cell.h"
#include "FireSpread.h"
 
namespace fs::sim
{
using topo::Cell;
using fs::wx::Direction;
class Event
{
public:
  static constexpr Cell NoLocation{};
  // HACK: use type, so we can sort without having to give different times to them
  enum Type
  {
    SAVE,
    END_SIMULATION,
    NEW_FIRE,
    FIRE_SPREAD,
  };
  [[nodiscard]] static Event makeEvent(
    const DurationSize time,
    const Cell& cell,
    const Type type)
  {
    return {
      time,
      cell,
      0,
      type,
      0,
      0,
      Direction::Invalid,
      0};
  }
  [[nodiscard]] static Event makeEnd(const DurationSize time)
  {
    return makeEvent(
      time,
      NoLocation,
      END_SIMULATION);
  }
  [[nodiscard]] static Event makeNewFire(
    const DurationSize time,
    const Cell& cell)
  {
    return makeEvent(
      time,
      cell,
      NEW_FIRE);
  }
  [[nodiscard]] static Event makeSave(const DurationSize time)
  {
    return makeEvent(
      time,
      NoLocation,
      SAVE);
  }
  [[nodiscard]] static Event makeFireSpread(const DurationSize time)
  {
    return makeEvent(
      time,
      NoLocation,
      FIRE_SPREAD);
  }
  [[nodiscard]] static Event makeFireSpread(
    const DurationSize time,
    const IntensitySize intensity,
    const ROSSize ros,
    const Direction raz)
  {
    return makeFireSpread(time, intensity, ros, raz, NoLocation);
  }
  [[nodiscard]] static Event makeFireSpread(
    const DurationSize time,
    const IntensitySize intensity,
    const ROSSize ros,
    const Direction raz,
    const Cell& cell)
  {
    return makeFireSpread(time, intensity, ros, raz, cell, 254);
  }
  [[nodiscard]] static Event makeFireSpread(
    const DurationSize time,
    const IntensitySize intensity,
    const ROSSize ros,
    const Direction raz,
    const Cell& cell,
    const CellIndex source)
  {
    return {time, cell, source, FIRE_SPREAD, intensity, ros, raz, 0};
  }
  ~Event() = default;
  Event(Event&& rhs) noexcept = default;
  Event(const Event& rhs) = delete;
  Event& operator=(Event&& rhs) noexcept = default;
  Event& operator=(const Event& rhs) = delete;
  [[nodiscard]] constexpr DurationSize time() const
  {
    return time_;
  }
  [[nodiscard]] constexpr Type type() const
  {
    return type_;
  }
  [[nodiscard]] constexpr DurationSize timeAtLocation() const
  {
    return time_at_location_;
  }
  [[nodiscard]] constexpr IntensitySize intensity() const
  {
    return intensity_;
  }
  [[nodiscard]] constexpr wx::Direction raz() const
  {
    return raz_;
  }
  [[nodiscard]] constexpr ROSSize ros() const
  {
    return ros_;
  }
  [[nodiscard]] constexpr const Cell& cell() const
  {
    return cell_;
  }
  [[nodiscard]] constexpr CellIndex source() const
  {
    return source_;
  }
private:
  constexpr Event(const DurationSize time,
                  const Cell& cell,
                  const CellIndex source,
                  const Type type,
                  const IntensitySize intensity,
                  const ROSSize ros,
                  const Direction raz,
                  const DurationSize time_at_location)
    : time_(time),
      time_at_location_(time_at_location),
      cell_(cell),
      type_(type),
      intensity_(intensity),
      ros_(ros),
      raz_(raz),
      source_(source)
  {
  }
  DurationSize time_;
  DurationSize time_at_location_;
  Cell cell_;
  Type type_;
  IntensitySize intensity_;
  ROSSize ros_;
  Direction raz_;
  // /**
  //  * \brief Spread information at time and place of event
  //  */
  // const SpreadInfo* spread_info_;
  CellIndex source_;
};
}