|
static bool | Parse (const string &path, vector< TimeSeries * > &vecTimeSeries) |
|
static TimeSeries * | Create (const string &varName, const axd &time, const axi &ids, const axxd &data) |
|
◆ AdvanceOneTimeStep()
virtual bool TimeSeries::AdvanceOneTimeStep |
( |
| ) |
|
|
pure virtual |
◆ Create()
TimeSeries * TimeSeries::Create |
( |
const string & | varName, |
|
|
const axd & | time, |
|
|
const axi & | ids, |
|
|
const axxd & | data ) |
|
static |
Create a time series from the provided data.
- Parameters
-
varName | name of the variable. |
time | time data. |
ids | unit IDs. |
data | time series data. |
- Returns
- pointer to the created time series.
◆ GetDataPointer()
◆ GetEnd()
virtual double TimeSeries::GetEnd |
( |
| ) |
|
|
pure virtual |
◆ GetStart()
virtual double TimeSeries::GetStart |
( |
| ) |
|
|
pure virtual |
◆ GetTotal()
virtual double TimeSeries::GetTotal |
( |
const SettingsBasin * | basinSettings | ) |
|
|
pure virtual |
Get the sum of the time series data for the provided basin settings.
- Parameters
-
basinSettings | settings of the basin. |
- Returns
- the sum of the time series data.
Implemented in TimeSeriesDistributed, and TimeSeriesUniform.
◆ GetVariableType()
VariableType TimeSeries::GetVariableType |
( |
| ) |
|
|
inline |
Get the variable type of the time series.
- Returns
- the variable type of the time series.
◆ IsDistributed()
virtual bool TimeSeries::IsDistributed |
( |
| ) |
|
|
pure virtual |
◆ Parse()
bool TimeSeries::Parse |
( |
const string & | path, |
|
|
vector< TimeSeries * > & | vecTimeSeries ) |
|
static |
Parse the time series netCDF file.
- Parameters
-
path | path to the netCDF file. |
vecTimeSeries | vector to store the parsed time series. |
◆ SetCursorToDate()
virtual bool TimeSeries::SetCursorToDate |
( |
double | date | ) |
|
|
pure virtual |
Set the internal cursor to the provided date.
- Parameters
-
date | date to set the cursor to. |
- Returns
- true if the cursor was successfully set to the provided date.
Implemented in TimeSeriesDistributed, and TimeSeriesUniform.
The documentation for this class was generated from the following files:
- /github/workspace/core/src/base/TimeSeries.h
- /github/workspace/core/src/base/TimeSeries.cpp