PublicStudy Class Referencefinal
Inheritance diagram for PublicStudy:
Public Member Functions | |
| bool | internalLoadBindingConstraints (const StudyLoadOptions &options) override |
| Load all binding constraints. | |
| bool | internalLoadBindingConstraints (const StudyLoadOptions &options) override |
| Load all binding constraints. | |
 Public Member Functions inherited from Antares::Data::Study | |
| Study (bool forTheSolver=false) | |
| Default Constructor. More... | |
| virtual | ~Study () |
| Destructor. | |
| void | createAsNew () |
| Create a clean study. | |
| void | relocate (const std::filesystem::path &newFolder) |
| Relocate the study into a new folder. More... | |
| bool | loadFromFolder (const std::string &path, const StudyLoadOptions &options) |
| Load a study from a folder. More... | |
| void | clear () |
| Clear all ressources held by the study. | |
| void | reloadCorrelation () |
| Reload all correlation. | |
| bool | reloadXCastData () |
| Reload all XCast Data. | |
| bool | saveToFolder (const AnyString &newfolder) |
| Save the study into a folder. More... | |
| bool | resetFolderIcon () const |
| Reset the folder icon (Windows only) More... | |
| bool | forceReload (bool reload=false) const |
| Invalidate the whole study. More... | |
| void | markAsModified () const |
| Mark the whole study as modified. | |
| void | resizeAllTimeseriesNumbers (uint n) |
| Resize all matrices dedicated to the sampled timeseries numbers. More... | |
| template<TimeSeriesType TimeSeriesT> | |
| void | storeTimeSeriesNumbers (Solver::IResultWriter &resultWriter) const |
| Store the timeseries numbers. More... | |
| template<TimeSeriesType TS> | |
| void | destroyTSGeneratorData () |
| Destroy all data of the TS generator '@TS'. | |
| bool | importTimeseriesIntoInput () |
| Import all time-series into the input folder. More... | |
| unsigned | getNumberOfCoresPerMode (unsigned nbLogicalCores, int ncMode) |
| Computes a raw number of cores table. More... | |
| void | getNumberOfCores (const bool forceParallel, const uint nbYearsParallelForced) |
| Computes number of cores. More... | |
| void | removeTimeseriesIfTSGeneratorEnabled () |
| Remove timeseries if ts-generator is enabled. | |
| bool | checkForFilenameLimits (bool output, const YString &chfolder=nullptr) const |
| Check for filename limits restriction on some platforms. More... | |
| void | ensureDataAreLoadedForAllBindingConstraints () |
| Load all matrices within the binding constraints if not already done. More... | |
| void | importLogsToOutputFolder (Solver::IResultWriter &resultWriter) const |
| Copy the log file from the 'logs' folder to the current output folder. | |
| void | computePThetaInfForThermalClusters () const |
| Check validity between Min Stable Power and capacity modulation for each thermal cluster in the all area in the study. Should be call then all inforation is suplied in to the thermal clusters. | |
| void | performTransformationsBeforeLaunchingSimulation () |
| Perform several modifications required when launching a simulation (like computing the DSM values) More... | |
| bool | initializeRuntimeInfos () |
| Initialize runtime informations required by the solver. | |
| void | prepareOutput () |
| Prepare the output where the results of the simulation will be written. | |
| void | saveAboutTheStudy (Solver::IResultWriter &resultWriter) |
| void | initializeProgressMeter (bool tsGeneratorOnly) |
| Initialize the progress meter. | |
| bool | modifyAreaNameIfAlreadyTaken (AreaName &out, const AreaName &basename) |
| Try to find a name for a new area. More... | |
| Area * | areaAdd (const AreaName &name, bool update=false) |
| Add an area and make all required initialization. More... | |
| void | scenarioRulesLoadIfNotAvailable () |
| Load the data related to the scenario builder if not available. | |
| void | scenarioRulesCreate () |
| Re-Initialize/Re-Load the scenario builder data. | |
| void | scenarioRulesDestroy () |
| Release the scenario builder. | |
| Antares::Modeler::Data * | getModelerData () const |
| Public Member Functions inherited from Antares::Data::LayerData | |
| LayerData (size_t activeLayer, bool showLayer) | |
Additional Inherited Members | |
| Public Types inherited from Antares::Data::Study | |
| using | Ptr = std::shared_ptr< Study > |
| using | Set = std::set< Ptr > |
| Set of studies. | |
| using | List = std::list< Ptr > |
| List of studies. | |
| using | SetsOfAreas = Antares::Data::Sets |
| Multiple sets of areas. | |
| using | FileExtension = std::string |
| Extension filename. | |
| Static Public Member Functions inherited from Antares::Data::Study | |
| static bool | TitleFromStudyFolder (const AnyString &folder, YString &out, bool warnings=false) |
| Extract the title of a study. More... | |
| static bool | IsRootStudy (const AnyString &folder) |
| Get if a folder if a study. More... | |
| static bool | IsRootStudy (const AnyString &folder, YString &buffer) |
| Get if a folder if a study. More... | |
| static bool | IsInsideStudyFolder (const AnyString &path, YString &location, YString &title) |
| Check if a path is within a study folder. More... | |
| Public Attributes inherited from Antares::Data::Study | |
| std::filesystem::path | folder |
| The source folder of the study. | |
| std::filesystem::path | folderInput |
| The input folder. | |
| std::filesystem::path | folderOutput |
| The output folder. | |
| std::filesystem::path | folderSettings |
| The settings folder. | |
| BindingConstraintsRepository | bindingConstraints |
| Binding constraints. | |
| BindingConstraintGroupRepository | bindingConstraintsGroups |
| Correlation | preproLoadCorrelation |
| Correlation matrix for the load time series generated by the prepro. | |
| Correlation | preproSolarCorrelation |
| Correlation matrix for the solar time series generated by the prepro. | |
| Correlation | preproWindCorrelation |
| Correlation matrix for the wind time series generated by the prepro. | |
| Correlation | preproHydroCorrelation |
| Correlation matrix for the hydro time series generated by the prepro. | |
| SetsOfAreas | setsOfAreas |
| Sets of areas. | |
| YString | buffer |
| A buffer for temporary operations on filename. | |
| Matrix ::BufferType | dataBuffer |
| A buffer for temporary operations on large amount of data. | |
| YString | bufferLoadingTS |
| A buffer used when loading time-series for dealing with filenames (prepro/series only) | |
| std::shared_ptr< Yuni::Job::QueueService > | pQueueService |
| The queue service that runs every set of parallel years. | |
| StudyHeader | header |
| Header (general information about the study) | |
| SimulationComments | simulationComments |
| The current Simulation. | |
| int64_t | pStartTime |
| uint | maxNbYearsInParallel = 1 |
| uint | maxNbYearsInParallel_save = 0 |
| uint | nbYearsParallelRaw = 1 |
| uint | minNbYearsInParallel = 0 |
| uint | minNbYearsInParallel_save = 0 |
| Parameters | parameters |
| Parameters. | |
| Date::Calendar | calendar |
| Calendar. More... | |
| Date::Calendar | calendarOutput |
| Calendar output. More... | |
| AreaList | areas |
| All available areas. | |
| std::unique_ptr< ScenarioBuilder::Sets > | scenarioRules |
| Rules for building scenarios (can be null) | |
| TimeSeries::TS | scenarioInitialHydroLevels |
| TimeSeries::TS | scenarioFinalHydroLevels |
| StudyRuntimeInfos | runtime |
| Runtime informations. More... | |
| UIRuntimeInfo * | uiinfo = nullptr |
| Specific data related to the User Interface. | |
| FileExtension | inputExtension = "txt" |
| The file extension for file within the input ('txt' or 'csv') More... | |
| Solver::Progression | progression |
| Progression about the current action performed on the study. | |
| void * | cacheTSGenerator [timeSeriesCount] |
| Time-series generators used by the solver. More... | |
| const bool | usedByTheSolver |
| A non-zero value when the study will be used by the solver. More... | |
| Public Attributes inherited from Antares::Data::LayerData | |
| std::map< size_t, std::string > | layers |
| All available layers. | |
| size_t | activeLayerID |
| bool | showAllLayer |
| Protected Member Functions inherited from Antares::Data::Study | |
| bool | internalLoadFromFolder (const std::filesystem::path &path, const StudyLoadOptions &options) |
| Load a study from a folder. | |
| bool | internalLoadHeader (const std::filesystem::path &folder) |
| Load the study header. | |
| bool | internalLoadCorrelationMatrices (const StudyLoadOptions &options) |
| Load all correlation matrices. | |
| bool | internalLoadSets () |
| Load all set of areas and links. | |
| bool | internalLoadIni (const std::filesystem::path &path, const StudyLoadOptions &options) |
| void | loadModelerComponents () |
| Load extra modeler components for hybrid studies and verify compatibility. | |
| void | checkModelerDataCompatibility () const |
| void | parameterFiller (const StudyLoadOptions &options) |
| void | reduceMemoryUsage () |
| Release all unnecessary buffers. | |
| Protected Member Functions inherited from Antares::Data::LayerData | |
| bool | saveLayers (const AnyString &filename) |
| void | loadLayers (const std::filesystem::path &filename) |
The documentation for this class was generated from the following files:
- src/tests/src/libs/antares/study/constraint/test_group.cpp
- src/tests/src/solver/simulation/test-time_series.cpp
