hydrocoupletemporal.h

Go to the documentation of this file.

 
#ifndef HYDROCOUPLETEMPORAL_H
#define HYDROCOUPLETEMPORAL_H
 
#include "hydrocouple.h"
 
 
namespace HydroCouple
{
  namespace Temporal
  {
    class IDateTime : public virtual HydroCouple::IPropertyChanged
    {
    public:
      virtual ~IDateTime() = default;
 
      [[nodiscard]] virtual double julianDay() const = 0;
 
      [[nodiscard]] virtual double modifiedJulianDay() const = 0;
 
      [[nodiscard]] virtual double serialDate() const = 0;
    };
 
    class ITimeSpan : public virtual IDateTime
    {
 
    public:
      virtual ~ITimeSpan() = default;
 
      [[nodiscard]] virtual double duration() const = 0;
    };
 
    class ITimeModelComponent : public virtual HydroCouple::IModelComponent
    {
    public:
      virtual ~ITimeModelComponent() = default;
 
      [[nodiscard]] virtual IDateTime *currentDateTime() const = 0;
 
      [[nodiscard]] virtual ITimeSpan *simulationPeriod() const = 0;
    };
 
    class ITimeSeriesComponentDataItem : public virtual IComponentDataItem
    {
    
    public:
      using IComponentDataItem::getValue;
      using IComponentDataItem::getValues;
      using IComponentDataItem::setValue;
      using IComponentDataItem::setValues;
 
      virtual ~ITimeSeriesComponentDataItem() = default;
 
      [[nodiscard]] virtual const IDateTime *time(int timeIndex) const = 0;
 
      [[nodiscard]] virtual int timeCount() const = 0;
 
      [[nodiscard]] virtual ITimeSpan *timeSpan() const = 0;
 
      [[nodiscard]] virtual IDimension *timeDimension() const = 0;
 
      virtual void getValue(
        hydrocouple_variant& data,
        int timeDimensionIndex,
        std::span<const int> dimensionIndexes = {}) const = 0;
 
      virtual void getValues(
        hydrocouple_variant *data,
        int timeDimensionIndex,
        std::span<const int>dimensionIndexes = {},
        int timeDimensionIndexLength = 1,
        std::span<const int>dimensionLengths = {}) const = 0;
 
      virtual void setValue(
        const hydrocouple_variant &data,
        int timeDimensionIndex,
        std::span<const int>dimensionIndexes = {}) = 0;
 
      virtual void setValues(
        const hydrocouple_variant *data,
        int timeDimensionIndex,
        std::span<const int>dimensionIndexes = {},
        int timeDimensionIndexLength = 1,
        std::span<const int>dimensionLengths = {}) = 0;
 
    };
 
    class ITimeIdBasedComponentDataItem : public virtual IComponentDataItem,
                                          public virtual ITimeSeriesComponentDataItem
    {
 
 
 
    public:
        
        using IComponentDataItem::getValue;
        using IComponentDataItem::getValues;
        using IComponentDataItem::setValue;
        using IComponentDataItem::setValues;
        using ITimeSeriesComponentDataItem::getValue;
        using ITimeSeriesComponentDataItem::getValues;
        using ITimeSeriesComponentDataItem::setValue;
        using ITimeSeriesComponentDataItem::setValues;
 
      virtual ~ITimeIdBasedComponentDataItem() = default;
 
      [[nodiscard]] virtual std::vector<std::string> identifiers() const = 0;
 
      [[nodiscard]] virtual IDimension *identifierDimension() const = 0;
 
      virtual void getValue(
        hydrocouple_variant &data,
        int timeIndex, 
        int idIndex, 
        std::span<const int>dimensionIndexes = {}) const = 0;
 
      virtual void getValues(
        hydrocouple_variant *data,
        int timeIndex, 
        int idIndex, 
        std::span<const int>dimensionIndexes = {},
        int timeIndexLength = 1,
        int idIndexLength = 1,
        std::span<const int>dimensionLengths = {}) const = 0;
 
      virtual void setValue(
        const hydrocouple_variant &data,
        int timeIndex, 
        int idIndex, 
        std::span<const int>dimensionIndexes = {}) = 0;
 
      virtual void setValues(
        const hydrocouple_variant *data,
        int timeIndex,
        int idIndex,
        std::span<const int>dimensionIndexes = {},
        int timeIndexLength = 1,
        int idIndexLength = 1,
        std::span<const int>dimensionLengths = {}) = 0;
    };
  }
}
 
#endif // HYDROCOUPLETEMPORAL_H