Loading [MathJax]/jax/output/HTML-CSS/config.js
Antares Simulator
Power System Simulator
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Modules Pages Concepts
Antares::Data::ScenarioBuilder::Rules Class Referencefinal

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

#include <rules.h>

Inheritance diagram for Antares::Data::ScenarioBuilder::Rules:

Public Types

using Ptr = std::shared_ptr<Rules>
 Smart pointer.
 
using Map = std::map<RulesScenarioName, Ptr>
 Map.
 
using MappingID = std::map<int, Ptr>
 Map ID.
 

Public Member Functions

Constructor & Destructor
 Rules (Study &study)
 Default constructor.
 
 ~Rules ()=default
 Destructor.
 

Data manupulation

loadTSNumberData load
 Load.
 
solarTSNumberData solar
 Solar.
 
hydroTSNumberData hydro
 Hydro.
 
windTSNumberData wind
 Wind.
 
std::vector< thermalTSNumberDatathermal
 Thermal (array [0..pAreaCount - 1])
 
std::vector< renewableTSNumberDatarenewable
 Renewable (array [0..pAreaCount - 1])
 
hydroLevelsData hydroInitialLevels = {"hl,", initLevelApply}
 hydro initial levels
 
hydroLevelsData hydroFinalLevels = {"hfl,", finalLevelApply}
 hydro final levels
 
std::vector< ntcTSNumberDatalinksNTC
 
BindingConstraintsTSNumberData binding_constraints
 
bool reset ()
 Initialize data from the study.
 
bool readLine (const AreaName::Vector &splitKey, const String &value, bool updaterMode=false)
 Load information from a single line (extracted from an INI file)
 
void saveToINIFile (Yuni::IO::File::Stream &file) const
 Export the data into a mere INI file.
 
uint areaCount () const
 Get the number of areas.
 
const RulesScenarioName & name () const
 Name of the rules set.
 
void setName (RulesScenarioName name)
 
bool apply ()
 Apply the changes to the timeseries number matrices.
 
void sendWarningsForDisabledClusters ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Rules()

Antares::Data::ScenarioBuilder::Rules::Rules ( Study & study)
explicit

Default constructor.

Parameters
tstypeType of the timeseries

Member Function Documentation

◆ apply()

bool Antares::Data::ScenarioBuilder::Rules::apply ( )

Apply the changes to the timeseries number matrices.

This method is only useful when launched from the solver.


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