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

Public Member Functions

 TimeSeriesDataRegular (double start, double end, int timeStep, TimeUnit timeStepUnit)
 
bool SetValues (const vecDouble &values) override
 
double GetValueFor (double date) override
 
double GetCurrentValue () override
 
double GetSum () override
 
bool SetCursorToDate (double date) override
 
bool AdvanceOneTimeStep () override
 
double GetStart () override
 
double GetEnd () override
 
- Public Member Functions inherited from TimeSeriesData

Protected Attributes

double m_start
 
double m_end
 
int m_timeStep
 
TimeUnit m_timeStepUnit
 
- Protected Attributes inherited from TimeSeriesData
vecDouble m_values
 
int m_cursor
 

Member Function Documentation

◆ AdvanceOneTimeStep()

bool TimeSeriesDataRegular::AdvanceOneTimeStep ( )
overridevirtual

Advance the cursor to the next time step.

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

Implements TimeSeriesData.

◆ GetCurrentValue()

double TimeSeriesDataRegular::GetCurrentValue ( )
overridevirtual

Get the current value.

Returns
the current value.

Reimplemented from TimeSeriesData.

◆ GetEnd()

double TimeSeriesDataRegular::GetEnd ( )
overridevirtual

Get the end date of the time series data.

Returns
the end date of the time series data.

Implements TimeSeriesData.

◆ GetStart()

double TimeSeriesDataRegular::GetStart ( )
overridevirtual

Get the start date of the time series data.

Returns
the start date of the time series data.

Implements TimeSeriesData.

◆ GetSum()

double TimeSeriesDataRegular::GetSum ( )
overridevirtual

Get the sum of the values.

Returns
the sum of the values.

Reimplemented from TimeSeriesData.

◆ GetValueFor()

double TimeSeriesDataRegular::GetValueFor ( double date)
overridevirtual

Get the value for the provided date.

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

Reimplemented from TimeSeriesData.

◆ SetCursorToDate()

bool TimeSeriesDataRegular::SetCursorToDate ( double date)
overridevirtual

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.

Implements TimeSeriesData.

◆ SetValues()

bool TimeSeriesDataRegular::SetValues ( const vecDouble & values)
overridevirtual

Set the values of the time series data.

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

Reimplemented from TimeSeriesData.


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