Antares::Data::ScenarioBuilder::TSNumberData Class Reference

Rules for TS numbers, for all years and a single timeseries. More...

#include <TSnumberData.h>

Inheritance diagram for Antares::Data::ScenarioBuilder::TSNumberData:

Public Types
using	MatrixType = Matrix<uint32_t>
	Matrix.

Data manupulation
MatrixType	pTSNumberRules
	All TS number overlay (0 if auto)
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)
virtual CString< 512, false >	get_prefix () const =0
virtual uint	get_tsGenCount (const Study &study) const =0

Additional Inherited Members
Public Member Functions inherited from Antares::Data::ScenarioBuilder::dataInterface
virtual bool	apply (Study &study)=0
	Apply the changes to the study corresponding data (time series, hydro levels, ...)

Detailed Description

Rules for TS numbers, for all years and a single timeseries.

Member Function Documentation

height()

uint Antares::Data::ScenarioBuilder::TSNumberData::height ( ) const

inlineoverridevirtual

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

reset()

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

overridevirtual

Reset data from the study.

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

saveToINIFile()

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

overridevirtual

Export the data into a mere INI file.

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

setTSnumber()

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

Assign a single value.

Parameters

index	An area index or a thermal cluster index
year	A year
value	The new TS number

width()

uint Antares::Data::ScenarioBuilder::TSNumberData::width ( ) const

inlineoverridevirtual

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/TSnumberData.h
• src/libs/antares/study/scenario-builder/TSnumberData.cpp