Flux.h

#ifndef HYDROBRICKS_FLUX_H
#define HYDROBRICKS_FLUX_H
 
#include "Includes.h"
 
class Modifier;
 
class Flux : public wxObject {
  public:
    explicit Flux();
 
    virtual bool IsOk() = 0;
 
    virtual void Reset();
 
    virtual double GetAmount() = 0;
 
    virtual void UpdateFlux(double amount);
 
    void LinkChangeRate(double* rate) {
        m_changeRate = rate;
    }
 
    double* GetChangeRatePointer() {
        return m_changeRate;
    }
 
    double* GetAmountPointer() {
        return &m_amount;
    }
 
    virtual bool IsForcing() {
        return false;
    }
 
    virtual bool IsInstantaneous() {
        return false;
    }
 
    void SetAsStatic() {
        m_static = true;
    }
 
    bool IsStatic() {
        return m_static;
    }
 
    bool NeedsWeighting() {
        return m_needsWeighting;
    }
 
    void NeedsWeighting(bool value) {
        m_needsWeighting = value;
    }
 
    void SetFractionUnitArea(double value) {
        m_fractionUnitArea = value;
        UpdateFractionTotal();
    }
 
    void SetFractionLandCover(double value) {
        m_fractionLandCover = value;
        UpdateFractionTotal();
    }
 
    void UpdateFractionTotal() {
        m_fractionTotal = m_fractionUnitArea * m_fractionLandCover;
    }
 
    string GetType() {
        return m_type;
    }
 
    void SetType(const string& type) {
        m_type = type;
    }
 
  protected:
    double m_amount;
    double* m_changeRate;
    bool m_static;
    bool m_needsWeighting;
    double m_fractionUnitArea;
    double m_fractionLandCover;
    double m_fractionTotal;
    Modifier* m_modifier;
    string m_type;
};
 
#endif  // HYDROBRICKS_FLUX_H