Antares::Data::DataSeriesHydro Class Reference

Data series (Hydro) More...

#include <series.h>

Public Member Functions
Constructor
	DataSeriesHydro ()
	Default constructor.
void	copyGenerationTS (const DataSeriesHydro &source)
void	copyMaxPowerTS (const DataSeriesHydro &source)

Data
TimeSeriesNumbers	timeseriesNumbers
TimeSeries	ror
	Run-of-the-river - ROR (MW)
TimeSeries	storage
	Mod (MW)
TimeSeries	mingen
	Minimum Generation (MW)
TimeSeries	maxHourlyGenPower
	Maximum Generation (MW)
TimeSeries	maxHourlyPumpPower
	Maximum Pumping (MW)
void	reset ()
	Reset all data, as if it were a new area.
void	resizeTS (uint nbSeries)
bool	forceReload (bool reload=false) const
	Load all data not already loaded.
void	markAsModified () const
bool	loadGenerationTS (const AreaName &areaID, const std::filesystem::path &folder, StudyVersion version)
bool	LoadMaxPower (const std::string &areaID, const std::filesystem::path &folder)
void	buildHourlyMaxPowerFromDailyTS (const Matrix< double >::ColumnType &DailyMaxGenPower, const Matrix< double >::ColumnType &DailyMaxPumpPower)
bool	saveToFolder (const AreaName &areaID, const AnyString &folder, Parameters::Compatibility::HydroPmax hydroPmax) const
	Save data series for hydro into a folder (input/hydro/series)
uint	TScount () const
void	resizeTSinDeratedMode (bool derated, StudyVersion version, Parameters::Compatibility::HydroPmax hydroPmax, bool useBySolver)

Detailed Description

Data series (Hydro)

Member Function Documentation

forceReload()

bool Antares::Data::DataSeriesHydro::forceReload

(

bool

reload = false

)

const

Load all data not already loaded.

If the load-on-demand is enabled, some data might not be loaded (see Matrix)

saveToFolder()

bool Antares::Data::DataSeriesHydro::saveToFolder	(	const AreaName &	areaID,
		const AnyString &	folder,
		Parameters::Compatibility::HydroPmax	hydroPmax ) const

Save data series for hydro into a folder (input/hydro/series)

Nothing will be done if the pointer to the structure is null.

Parameters

d	The data series for hydro
folder	The target folder

Returns

A non-zero value if the operation succeeded, 0 otherwise

Member Data Documentation

maxHourlyGenPower

TimeSeries Antares::Data::DataSeriesHydro::maxHourlyGenPower

Maximum Generation (MW)

Merely a matrix of TimeSeriesCount * HOURS_PER_YEAR values

maxHourlyPumpPower

TimeSeries Antares::Data::DataSeriesHydro::maxHourlyPumpPower

Maximum Pumping (MW)

Merely a matrix of TimeSeriesCount * HOURS_PER_YEAR values

mingen

TimeSeries Antares::Data::DataSeriesHydro::mingen

Minimum Generation (MW)

Merely a matrix of TimeSeriesCount * HOURS_PER_YEAR values

ror

TimeSeries Antares::Data::DataSeriesHydro::ror

Run-of-the-river - ROR (MW)

(it was DAYS_PER_YEAR before 3.9)

storage

TimeSeries Antares::Data::DataSeriesHydro::storage

Mod (MW)

Merely a matrix of TimeSeriesCount * 365 values This matrix is not used in adequation mode.

---

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

• src/libs/antares/study/include/antares/study/parts/hydro/series.h
• src/libs/antares/study/parts/hydro/series.cpp