List of clusters. More...

#include <cluster_list.h>

Inheritance diagram for Antares::Data::ThermalClusterList:

Public Member Functions
std::string	typeID () const override

bool	loadFromFolder (Study &s, const std::filesystem::path &folder, Area *area)
	Get the size (bytes) occupied in memory by a `ThermalClusterList` structure. More...

Constructor & Destructor
	ThermalClusterList ()
	Default constructor.

virtual	~ThermalClusterList ()
	Destructor.

Spinning
void	calculationOfSpinning ()
	Calculation of Spinning for all thermal clusters.

void	reverseCalculationOfSpinning ()
	Calculation of Spinning for all thermal clusters (reverse)

Public Member Functions inherited from Antares::Data::ClusterList< ThermalCluster >
void	clearAll ()

bool	empty () const

ThermalCluster *	findInAll (std::string_view id) const
	Try to find a cluster from its id (const) in the complete cluster list. More...

bool	exists (const std::string &id) const
	Get if a cluster exists. More...

auto	each_enabled () const

std::vector< std::shared_ptr< ThermalCluster > >	all () const

bool	rename (std::string idToFind, std::string newName)
	Rename a cluster. More...

virtual bool	remove (const std::string &id)
	Remove properly a cluster.

SharedPtr	operator[] (std::size_t idx)

SharedPtr	operator[] (std::size_t idx) const

SharedPtr	enabledClusterAt (unsigned int index) const

void	resizeAllTimeseriesNumbers (uint n) const
	Resize all matrices dedicated to the sampled timeseries numbers. More...

void	storeTimeseriesNumbers (Solver::IResultWriter &writer) const

bool	forceReload (bool reload=false) const
	Invalidate all clusters.

void	markAsModified () const
	Mark the clusters as modified.

void	retrieveTotalCapacityAndUnitCount (double &total, uint &unitCount) const
	Retrieve the total capacity and the total unit count. More...

unsigned int	enabledCount () const

unsigned int	allClustersCount () const

void	addToCompleteList (std::shared_ptr< ThermalCluster > cluster)

void	sortCompleteList ()

bool	loadDataSeriesFromFolder (Study &study, const std::filesystem::path &folder)

bool	saveDataSeriesToFolder (const AnyString &folder) const

Mustrun
void	enableMustrunForEveryone ()
	Enable the 'mustrun' mode for every cluster. More...

auto	each_mustrun_and_enabled () const

auto	each_enabled_and_not_mustrun () const

void	ensureDataPrepro ()
	Ensure data for the prepro are initialized. More...

bool	loadPreproFromFolder (Study &s, const std::filesystem::path &folder)
	Load data related to the preprocessor from a list of thermal clusters from a folder. More...

bool	validatePrepro (const Study &study)

bool	validateClusters (const Parameters &param) const

bool	loadEconomicCosts (Study &s, const std::filesystem::path &folder)

bool	savePreproToFolder (const AnyString &folder) const

bool	saveEconomicCosts (const AnyString &folder) const

unsigned int	enabledAndMustRunCount () const

unsigned int	enabledAndNotMustRunCount () const

Additional Inherited Members
Public Types inherited from Antares::Data::ClusterList< ThermalCluster >
using	SharedPtr = typename std::shared_ptr< ThermalCluster >

Protected Member Functions inherited from Antares::Data::ClusterList< ThermalCluster >
void	rebuildIndexes ()

Protected Attributes inherited from Antares::Data::ClusterList< ThermalCluster >
std::vector< std::shared_ptr< ThermalCluster > >	allClusters_

Detailed Description

List of clusters.

Member Function Documentation

◆ enableMustrunForEveryone()

void Antares::Data::ThermalClusterList::enableMustrunForEveryone ( )

Enable the 'mustrun' mode for every cluster.

This method is especially useful for the adequacy mode, where all clusters must be in mustrun mode

◆ ensureDataPrepro()

void Antares::Data::ThermalClusterList::ensureDataPrepro ( )

Ensure data for the prepro are initialized.

Todo:: Remaining of old C-library. this routine should be moved into the appropriate class

Parameters

l	The list of thermal clusters

◆ loadFromFolder()

bool Antares::Data::ThermalClusterList::loadFromFolder	(	Study &	s,
		const std::filesystem::path &	folder,
		Area *	area
	)

Get the size (bytes) occupied in memory by a ThermalClusterList structure.

Returns: A size (in bytes)

◆ loadPreproFromFolder()

bool Antares::Data::ThermalClusterList::loadPreproFromFolder	(	Study &	s,
		const std::filesystem::path &	folder
	)

Load data related to the preprocessor from a list of thermal clusters from a folder.

Todo:: Remaining of old C-library. this routine should be moved into the appropriate class

Parameters

l	A list of thermal clusters
folder	The target folder

Returns: A non-zero value if the operation succeeded, 0 otherwise

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

src/libs/antares/study/include/antares/study/parts/thermal/cluster_list.h
src/libs/antares/study/parts/thermal/cluster_list.cpp

Public Member Functions