Antares Simulator
Power System Simulator
Public Member Functions | List of all members
Antares::Data::RenewableClusterList Class Referencefinal

List of renewable clusters. More...

#include <cluster_list.h>

Inheritance diagram for Antares::Data::RenewableClusterList:
Antares::Data::ClusterList< RenewableCluster >

Public Member Functions

std::string typeID () const override
 
bool loadFromFolder (const std::filesystem::path &folder, Area *area)
 
bool validateClusters () const
 
- Public Member Functions inherited from Antares::Data::ClusterList< RenewableCluster >
void clearAll ()
 
bool empty () const
 
RenewableCluster * 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< RenewableCluster > > 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< RenewableCluster > cluster)
 
void sortCompleteList ()
 
bool loadDataSeriesFromFolder (Study &study, const std::filesystem::path &folder)
 
bool saveDataSeriesToFolder (const AnyString &folder) const
 

Additional Inherited Members

- Public Types inherited from Antares::Data::ClusterList< RenewableCluster >
using SharedPtr = typename std::shared_ptr< RenewableCluster >
 
- Protected Member Functions inherited from Antares::Data::ClusterList< RenewableCluster >
void rebuildIndexes ()
 
- Protected Attributes inherited from Antares::Data::ClusterList< RenewableCluster >
std::vector< std::shared_ptr< RenewableCluster > > allClusters_
 

Detailed Description

List of renewable clusters.

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