hydrobricks
Loading...
Searching...
No Matches
TimeSeriesData Class Referenceabstract
Inheritance diagram for TimeSeriesData:
TimeSeriesDataIrregular TimeSeriesDataRegular

Public Member Functions

virtual bool SetValues (const vecDouble &values)
 
virtual double GetValueFor (double date)
 
virtual double GetCurrentValue ()
 
virtual double GetSum ()
 
virtual bool SetCursorToDate (double date)=0
 
virtual bool AdvanceOneTimeStep ()=0
 
virtual double GetStart ()=0
 
virtual double GetEnd ()=0
 

Protected Attributes

vecDouble m_values
 
int m_cursor
 

Member Function Documentation

◆ AdvanceOneTimeStep()

virtual bool TimeSeriesData::AdvanceOneTimeStep ( )
pure virtual

Advance the cursor to the next time step.

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

Implemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

◆ GetCurrentValue()

double TimeSeriesData::GetCurrentValue ( )
virtual

Get the current value.

Returns
the current value.

Reimplemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

◆ GetEnd()

virtual double TimeSeriesData::GetEnd ( )
pure virtual

Get the end date of the time series data.

Returns
the end date of the time series data.

Implemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

◆ GetStart()

virtual double TimeSeriesData::GetStart ( )
pure virtual

Get the start date of the time series data.

Returns
the start date of the time series data.

Implemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

◆ GetSum()

double TimeSeriesData::GetSum ( )
virtual

Get the sum of the values.

Returns
the sum of the values.

Reimplemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

◆ GetValueFor()

double TimeSeriesData::GetValueFor ( double date)
virtual

Get the value for the provided date.

Parameters
datedate to get the value for.
Returns
the value for the provided date.

Reimplemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

◆ SetCursorToDate()

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

Set the 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 TimeSeriesDataIrregular, and TimeSeriesDataRegular.

◆ SetValues()

bool TimeSeriesData::SetValues ( const vecDouble & values)
virtual

Set the values of the time series data.

Parameters
valuesvector of values to set.
Returns
true if the values were successfully set.

Reimplemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.


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