hydrobricks
Loading...
Searching...
No Matches
TimeSeries Class Referenceabstract
Inheritance diagram for TimeSeries:
TimeSeriesDistributed TimeSeriesUniform

Public Member Functions

 TimeSeries (VariableType type)
 
virtual bool SetCursorToDate (double date)=0
 
virtual bool AdvanceOneTimeStep ()=0
 
virtual bool IsDistributed ()=0
 
virtual double GetStart ()=0
 
virtual double GetEnd ()=0
 
virtual double GetTotal (const SettingsBasin *basinSettings)=0
 
virtual TimeSeriesDataGetDataPointer (int unitId)=0
 
VariableType GetVariableType ()
 

Static Public Member Functions

static bool Parse (const string &path, vector< TimeSeries * > &vecTimeSeries)
 
static TimeSeriesCreate (const string &varName, const axd &time, const axi &ids, const axxd &data)
 

Protected Attributes

VariableType m_type
 

Member Function Documentation

◆ AdvanceOneTimeStep()

virtual bool TimeSeries::AdvanceOneTimeStep ( )
pure virtual

Advance the internal cursor to the next time step.

Returns
true if the cursor was successfully advanced to the next time step.

Implemented in TimeSeriesDistributed, and TimeSeriesUniform.

◆ 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
varNamename of the variable.
timetime data.
idsunit IDs.
datatime series data.
Returns
pointer to the created time series.

◆ GetDataPointer()

virtual TimeSeriesData * TimeSeries::GetDataPointer ( int unitId)
pure virtual

Get the data pointer for the provided unit ID.

Parameters
unitIdID of the unit.
Returns
pointer to the time series data for the provided unit ID.

Implemented in TimeSeriesDistributed, and TimeSeriesUniform.

◆ GetEnd()

virtual double TimeSeries::GetEnd ( )
pure virtual

Get the time end of the time series.

Returns
the time end of the time series.

Implemented in TimeSeriesDistributed, and TimeSeriesUniform.

◆ GetStart()

virtual double TimeSeries::GetStart ( )
pure virtual

Get the time start of the time series.

Returns
the time start of the time series.

Implemented in TimeSeriesDistributed, and TimeSeriesUniform.

◆ GetTotal()

virtual double TimeSeries::GetTotal ( const SettingsBasin * basinSettings)
pure virtual

Get the sum of the time series data for the provided basin settings.

Parameters
basinSettingssettings 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

Check if the time series is distributed.

Returns
true if the time series is distributed.

Implemented in TimeSeriesDistributed, and TimeSeriesUniform.

◆ Parse()

bool TimeSeries::Parse ( const string & path,
vector< TimeSeries * > & vecTimeSeries )
static

Parse the time series netCDF file.

Parameters
pathpath to the netCDF file.
vecTimeSeriesvector to store the parsed time series.

◆ SetCursorToDate()

virtual bool TimeSeries::SetCursorToDate ( double date)
pure virtual

Set the internal cursor to the provided date.

Parameters
datedate 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: