Antares::Data::ScenarioBuilder::hydroLevelsData Class Reference

Rules for hydro levels, for all years and areas. More...

#include <hydroLevelsData.h>

Inheritance diagram for Antares::Data::ScenarioBuilder::hydroLevelsData:

Public Types
using	MatrixType = Matrix< double >
	Matrix.

Public Member Functions
	hydroLevelsData (const std::string &iniFilePrefix, std::function< void(Study &, MatrixType &)> applyToTarget)
Data manupulation

Data manupulation
bool	reset (const Study &study) override
	Reset data from the study.
void	setTSnumber (uint index, uint year, double value)
	Assign a single value. More...
uint	width () const override
uint	height () const override
double	get_value (uint x, uint y) const
void	set_value (uint x, uint y, double value)
bool	apply (Study &study) override
	Apply the changes to the study corresponding data (time series, hydro levels, ...) More...

Detailed Description

Rules for hydro levels, for all years and areas.

Member Function Documentation

apply()

bool Antares::Data::ScenarioBuilder::hydroLevelsData::apply ( Study &  study )

overridevirtual

Apply the changes to the study corresponding data (time series, hydro levels, ...)

This method is only useful when launched from the solver.

Implements Antares::Data::ScenarioBuilder::dataInterface.

setTSnumber()

void Antares::Data::ScenarioBuilder::hydroLevelsData::setTSnumber ( uint  index, uint  year, double  value  )

inline

Assign a single value.

Parameters

index	An area index
year	A year
value	The new hydro level

---

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

• src/libs/antares/study/include/antares/study/scenario-builder/hydroLevelsData.h
• src/libs/antares/study/scenario-builder/hydroLevelsData.cpp