TimeSeriesDistributed Class Reference

Inheritance diagram for TimeSeriesDistributed:

Public Member Functions
	TimeSeriesDistributed (VariableType type)
void	AddData (TimeSeriesData *data, int unitId)
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
vecInt	m_unitIds
vector< 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

AddData()

void TimeSeriesDistributed::AddData	(	TimeSeriesData *	data,
		int	unitId )

Add data to the time series.

Parameters

data	pointer to the time series data.
unitId	ID of the unit.

AdvanceOneTimeStep()

bool TimeSeriesDistributed::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 * TimeSeriesDistributed::GetDataPointer ( int unitId )

overridevirtual

Get the data pointer for the provided unit ID.

Parameters

unitId

ID of the unit.

Returns

pointer to the time series data for the provided unit ID.

Implements TimeSeries.

GetEnd()

double TimeSeriesDistributed::GetEnd ( )

overridevirtual

Get the time end of the time series.

Returns

the time end of the time series.

Implements TimeSeries.

GetStart()

double TimeSeriesDistributed::GetStart ( )

overridevirtual

Get the time start of the time series.

Returns

the time start of the time series.

Implements TimeSeries.

GetTotal()

double TimeSeriesDistributed::GetTotal ( const SettingsBasin * basinSettings )

overridevirtual

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.

Implements TimeSeries.

IsDistributed()

bool TimeSeriesDistributed::IsDistributed ( )

inlineoverridevirtual

Check if the time series is distributed.

Returns

true if the time series is distributed.

Implements TimeSeries.

SetCursorToDate()

bool TimeSeriesDistributed::SetCursorToDate ( double date )

overridevirtual

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.

Implements TimeSeries.

---

The documentation for this class was generated from the following files:

• /github/workspace/core/src/base/TimeSeriesDistributed.h
• /github/workspace/core/src/base/TimeSeriesDistributed.cpp