hydrobricks
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
TimeSeriesUniform Class Reference
Inheritance diagram for TimeSeriesUniform:
TimeSeries

Public Member Functions

 TimeSeriesUniform (VariableType type)
 
void SetData (TimeSeriesData *data)
 
bool SetCursorToDate (double date) override
 
bool AdvanceOneTimeStep () override
 
bool IsDistributed () override
 
double GetStart () override
 
double GetEnd () override
 
double GetTotal (const SettingsBasin *basinSettings) override
 
TimeSeriesData * GetDataPointer (int unitId) override
 
- Public Member Functions inherited from TimeSeries
 TimeSeries (VariableType type)
 
VariableType GetVariableType ()
 

Protected Attributes

TimeSeriesData * m_data
 
- Protected Attributes inherited from TimeSeries
VariableType m_type
 

Additional Inherited Members

- Static Public Member Functions inherited from TimeSeries
static bool Parse (const string &path, vector< TimeSeries * > &vecTimeSeries)
 
static TimeSeries * Create (const string &varName, const axd &time, const axi &ids, const axxd &data)
 

Member Function Documentation

◆ AdvanceOneTimeStep()

bool TimeSeriesUniform::AdvanceOneTimeStep ( )
overridevirtual

Advance the internal cursor to the next time step.

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

Implements TimeSeries.

◆ GetDataPointer()

TimeSeriesData * TimeSeriesUniform::GetDataPointer ( int unitId)
overridevirtual

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.

Implements TimeSeries.

◆ GetEnd()

double TimeSeriesUniform::GetEnd ( )
overridevirtual

Get the time end of the time series.

Returns
the time end of the time series.

Implements TimeSeries.

◆ GetStart()

double TimeSeriesUniform::GetStart ( )
overridevirtual

Get the time start of the time series.

Returns
the time start of the time series.

Implements TimeSeries.

◆ GetTotal()

double TimeSeriesUniform::GetTotal ( const SettingsBasin * basinSettings)
overridevirtual

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.

Implements TimeSeries.

◆ IsDistributed()

bool TimeSeriesUniform::IsDistributed ( )
inlineoverridevirtual

Check if the time series is distributed.

Returns
true if the time series is distributed.

Implements TimeSeries.

◆ SetCursorToDate()

bool TimeSeriesUniform::SetCursorToDate ( double date)
overridevirtual

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.

Implements TimeSeries.

◆ SetData()

void TimeSeriesUniform::SetData ( TimeSeriesData * data)
inline

Set the time series data.

Parameters
datapointer to the time series data.
The documentation for this class was generated from the following files: