Flux.h

#ifndef HYDROBRICKS_FLUX_H
#define HYDROBRICKS_FLUX_H
 
#include "../base/ContentTypes.h"
#include "Includes.h"
 
class Modifier;
 
class Flux : public wxObject {
  public:
    explicit Flux();
 
    ~Flux() override = default;
 
    [[nodiscard]] virtual bool IsValid() const = 0;
 
    virtual void Validate() const;
 
    virtual void Reset();
 
    virtual double GetAmount() = 0;
 
    virtual void UpdateFlux(double amount);
 
    void LinkChangeRate(double* rate) {
        _changeRate = rate;
    }
 
    double* GetChangeRatePointer() {
        return _changeRate;
    }
 
    double* GetAmountPointer() {
        return &_amount;
    }
 
    virtual bool IsForcing() const {
        return false;
    }
 
    virtual bool IsInstantaneous() const {
        return false;
    }
 
    void SetAsStatic() {
        _static = true;
    }
 
    [[nodiscard]] bool IsStatic() const {
        return _static;
    }
 
    [[nodiscard]] bool NeedsWeighting() const {
        return _needsWeighting;
    }
 
    void NeedsWeighting(bool value) {
        _needsWeighting = value;
    }
 
    void SetFractionUnitArea(double value) {
        _fractionUnitArea = value;
        UpdateFractionTotal();
    }
 
    void SetFractionLandCover(double value) {
        _fractionLandCover = value;
        UpdateFractionTotal();
    }
 
    void UpdateFractionTotal() {
        _fractionTotal = _fractionUnitArea * _fractionLandCover;
    }
 
    ContentType GetType() const {
        return _type;
    }
 
    void SetType(const ContentType type) {
        _type = type;
    }
 
    [[nodiscard]] bool HasChangeRate() const {
        return _changeRate != nullptr;
    }
 
    [[nodiscard]] bool HasModifier() const {
        return _modifier != nullptr;
    }
 
  protected:
    double _amount{};
    double* _changeRate{};  // non-owning reference
    bool _static{};
    bool _needsWeighting{};
    double _fractionUnitArea{1.0};
    double _fractionLandCover{1.0};
    double _fractionTotal{1.0};
    Modifier* _modifier{};
    ContentType _type{ContentType::Water};
};
 
#endif  // HYDROBRICKS_FLUX_H