Loading...
Searching...
No Matches
hydrocoupletemporal.h File Reference

Temporal interface definitions for the HydroCouple component-based modeling framework. More...

#include <cstdint>
#include "hydrocouple.h"
Include dependency graph for hydrocoupletemporal.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  HydroCouple::Temporal::IDateTime
 IDateTime interface based on a Julian day. More...
 
class  HydroCouple::Temporal::ITimeSpan
 ITimeSpan specifies an interval of time. More...
 
class  HydroCouple::Temporal::ITimeModelComponent
 ITimeModelComponent is an IModelComponent that advances through time during simulation and provides access to the current simulation time. More...
 
class  HydroCouple::Temporal::ITimeSeriesComponentDataItem
 ITimeSeriesComponentDataItem is an IComponentItem with a temporal attribute. More...
 
class  HydroCouple::Temporal::ITimeIdBasedComponentDataItem
 ITimeIdBasedComponentDataItem is an IComponentDataItem with both temporal and identifier-based dimensions for accessing multi-dimensional time-series data. More...
 

Namespaces

namespace  HydroCouple
 HydroCouple namespace contains the core interface specifications for the HydroCouple component-based modeling framework interface specification.
 
namespace  HydroCouple::Temporal
 HydroCouple's interfaces that have a time varying component.
 

Enumerations

enum class  HydroCouple::Temporal::TimeKind : uint8_t {
  HydroCouple::Temporal::Unknown = 0 ,
  HydroCouple::Temporal::Instantaneous ,
  HydroCouple::Temporal::IntervalMean ,
  HydroCouple::Temporal::IntervalMinimum ,
  HydroCouple::Temporal::IntervalMaximum ,
  HydroCouple::Temporal::Accumulated
}
 What a value's time coordinate refers to. More...
 
enum class  HydroCouple::Temporal::TimeInterpolation : uint8_t {
  HydroCouple::Temporal::Unknown = 0 ,
  HydroCouple::Temporal::None ,
  HydroCouple::Temporal::Previous ,
  HydroCouple::Temporal::Nearest ,
  HydroCouple::Temporal::Linear
}
 How a provider produces a value at an instant that is between two it holds. More...
 
enum class  HydroCouple::Temporal::TimeExtrapolation : uint8_t {
  HydroCouple::Temporal::Unknown = 0 ,
  HydroCouple::Temporal::Refuse ,
  HydroCouple::Temporal::HoldLast ,
  HydroCouple::Temporal::Linear
}
 How a provider produces a value at an instant beyond the last (or before the first) it holds. More...
 

Variables

constexpr double HydroCouple::Temporal::TIME_EQUALITY_TOLERANCE_DAYS = 1.0e-8
 Two instants are the same instant when their Julian days differ by no more than this (1e-8 days, about 0.86 ms).
 
constexpr double HydroCouple::Temporal::INTERVAL_LENGTH_CONTIGUOUS = -1.0
 The intervalLength() a time-series item returns when its intervals are contiguous but not of one length (calendar months, an irregular record).
 

Detailed Description

Temporal interface definitions for the HydroCouple component-based modeling framework.

Author
Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com
Version
2.0.0-beta.1

This header file contains the temporal interface definitions for the HydroCouple component-based modeling framework. It defines interfaces for date/time representation, time spans, time-marching model components, and time-series component data items.

License
This file and its associated files and libraries are free software. You can redistribute them and/or modify them under the terms of the MIT License. They are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MIT License for details.
Date
2014-2026