Antares::Data::ScenarioBuilder::ntcTSNumberData Class Reference

Inheritance diagram for Antares::Data::ScenarioBuilder::ntcTSNumberData:

Public Member Functions
bool	reset (const Study &study) override
	Reset data from the study.
void	saveToINIFile (const Study &study, Yuni::IO::File::Stream &file) const override
	Export the data into a mere INI file.
void	attachArea (const Area *area)
void	setTSnumber (const Antares::Data::AreaLink *link, const uint year, uint value)
uint	get (const Antares::Data::AreaLink *link, const uint year) const
bool	apply (Study &study) override
	Apply the changes to the study corresponding data (time series, hydro levels, ...)
CString< 512, false >	get_prefix () const override
uint	get_tsGenCount (const Study &study) const override
Public Member Functions inherited from Antares::Data::ScenarioBuilder::TSNumberData
bool	reset (const Study &study) override
	Reset data from the study.
void	saveToINIFile (const Study &study, Yuni::IO::File::Stream &file) const override
	Export the data into a mere INI file.
void	setTSnumber (uint index, uint year, uint value)
	Assign a single value.
uint	width () const override
uint	height () const override
double	get_value (uint x, uint y) const
void	set_value (uint x, uint y, uint value)
Public Member Functions inherited from Antares::Data::ScenarioBuilder::dataInterface

Additional Inherited Members
Public Types inherited from Antares::Data::ScenarioBuilder::TSNumberData
using	MatrixType = Matrix<uint32_t>
	Matrix.
Protected Member Functions inherited from Antares::Data::ScenarioBuilder::TSNumberData
Protected Attributes inherited from Antares::Data::ScenarioBuilder::TSNumberData
MatrixType	pTSNumberRules
	All TS number overlay (0 if auto)

Member Function Documentation

apply()

bool Antares::Data::ScenarioBuilder::ntcTSNumberData::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.

get_prefix()

CString< 512, false > Antares::Data::ScenarioBuilder::ntcTSNumberData::get_prefix ( ) const

inlineoverridevirtual

Implements Antares::Data::ScenarioBuilder::TSNumberData.

get_tsGenCount()

uint Antares::Data::ScenarioBuilder::ntcTSNumberData::get_tsGenCount ( const Study & study ) const

overridevirtual

Implements Antares::Data::ScenarioBuilder::TSNumberData.

reset()

bool Antares::Data::ScenarioBuilder::ntcTSNumberData::reset ( const Study & study )

overridevirtual

Reset data from the study.

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

saveToINIFile()

void Antares::Data::ScenarioBuilder::ntcTSNumberData::saveToINIFile ( const Study & study, Yuni::IO::File::Stream & file ) const

overridevirtual

Export the data into a mere INI file.

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

---

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

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