TimeSeriesData Class Reference

Inheritance diagram for TimeSeriesData:

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 () const =0
virtual double	GetEnd () const =0
virtual bool	IsValid () const =0
virtual void	Validate () const =0

Protected Attributes
vecDouble	_values
int	_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 ( ) const

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 ( ) const

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

date	date to get the value for.

Returns

the value for the provided date.

Reimplemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

IsValid()

virtual bool TimeSeriesData::IsValid ( ) const

nodiscardpure virtual

Check if the time series data is valid. Verifies that the data has values and date range is set correctly.

Returns

true if the time series data is valid, false otherwise.

Implemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

SetCursorToDate()

virtual bool TimeSeriesData::SetCursorToDate ( double date )

pure virtual

Set the 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.

Implemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

SetValues()

bool TimeSeriesData::SetValues ( const vecDouble & values )

virtual

Set the values of the time series data.

Parameters

values

vector of values to set.

Returns

true if the values were successfully set.

Reimplemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

Validate()

virtual void TimeSeriesData::Validate ( ) const

pure virtual

Validate the time series data. Throws an exception if the time series data is invalid.

Exceptions

ModelConfigError

if validation fails.

Implemented in TimeSeriesDataIrregular, and TimeSeriesDataRegular.

---

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

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