Antares::Data::ScenarioBuilder::dataInterface Class Reference

Interface for scenario builder data (time series, hydro levels, ...) More...

#include <scBuilderDataInterface.h>

Inheritance diagram for Antares::Data::ScenarioBuilder::dataInterface:

Public Member Functions
Data manupulation
virtual bool	reset (const Study &study)=0
	Reset data from the study.
virtual void	saveToINIFile (const Study &study, Yuni::IO::File::Stream &file) const =0
	Export the data into a mere INI file.
virtual uint	width () const =0
virtual uint	height () const =0
virtual bool	apply (Study &study)=0
	Apply the changes to the study corresponding data (time series, hydro levels, ...)

Detailed Description

Interface for scenario builder data (time series, hydro levels, ...)

Member Function Documentation

apply()

virtual bool Antares::Data::ScenarioBuilder::dataInterface::apply ( Study & study )

pure virtual

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

This method is only useful when launched from the solver.

Implemented in Antares::Data::ScenarioBuilder::BindingConstraintsTSNumberData, Antares::Data::ScenarioBuilder::hydroLevelsData, Antares::Data::ScenarioBuilder::hydroTSNumberData, Antares::Data::ScenarioBuilder::loadTSNumberData, Antares::Data::ScenarioBuilder::ntcTSNumberData, Antares::Data::ScenarioBuilder::renewableTSNumberData, Antares::Data::ScenarioBuilder::solarTSNumberData, Antares::Data::ScenarioBuilder::thermalTSNumberData, and Antares::Data::ScenarioBuilder::windTSNumberData.

reset()

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

pure virtual

Reset data from the study.

Implemented in Antares::Data::ScenarioBuilder::BindingConstraintsTSNumberData, Antares::Data::ScenarioBuilder::hydroLevelsData, Antares::Data::ScenarioBuilder::ntcTSNumberData, Antares::Data::ScenarioBuilder::renewableTSNumberData, Antares::Data::ScenarioBuilder::thermalTSNumberData, and Antares::Data::ScenarioBuilder::TSNumberData.

saveToINIFile()

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

pure virtual

Export the data into a mere INI file.

Implemented in Antares::Data::ScenarioBuilder::BindingConstraintsTSNumberData, Antares::Data::ScenarioBuilder::hydroLevelsData, Antares::Data::ScenarioBuilder::ntcTSNumberData, Antares::Data::ScenarioBuilder::renewableTSNumberData, Antares::Data::ScenarioBuilder::thermalTSNumberData, and Antares::Data::ScenarioBuilder::TSNumberData.

---

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

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