Antares Simulator
Power System Simulator
Public Types | List of all members
Antares::Data::RenewableCluster Class Referencefinal
Inheritance diagram for Antares::Data::RenewableCluster:
Antares::Data::Cluster

Public Types

enum  TimeSeriesMode { powerGeneration = 0 , productionFactor }
 
using Set = std::set< RenewableCluster *, CompareClusterName >
 Set of renewable clusters.
 
- Public Types inherited from Antares::Data::Cluster
using Set = std::set< Cluster *, CompareClusterName >
 

Constructor & Destructor

enum TimeSeriesMode tsMode = powerGeneration
 
class RenewableClusterList
 
 RenewableCluster (Data::Area *parent)
 Default constructor, with a parent area.
 
bool forceReload (bool reload) const override
 Invalidate all data associated to the renewable cluster.
 
void markAsModified () const override
 Mark the renewable cluster as modified.
 
void reset () override
 Reset to default values. More...
 
bool integrityCheck () override
 Check and fix all values of a renewable cluster. More...
 
void copyFrom (const RenewableCluster &cluster)
 Copy data from another cluster. More...
 
bool setTimeSeriesModeFromString (const YString &value)
 
YString getTimeSeriesModeAsString () const
 
double valueAtTimeStep (uint year, uint hourInYear) const
 

Additional Inherited Members

- Public Member Functions inherited from Antares::Data::Cluster
 Cluster (Area *parent)
 
const std::string & id () const
 
const std::string & name () const
 
void setName (const AnyString &newname)
 
Yuni::String getFullName () const
 
void setGroup (const std::string &group)
 
std::string getGroup () const
 
void invalidateArea ()
 Invalidate the whole attached area.
 
bool isVisibleOnLayer (const size_t &layerID) const
 Check wether the cluster is visible in a layer (it's parent area is visible in the layer)
 
bool saveDataSeriesToFolder (const AnyString &folder) const
 
bool loadDataSeriesFromFolder (Study &s, const std::filesystem::path &folder)
 
bool isEnabled () const
 
- Public Attributes inherited from Antares::Data::Cluster
uint unitCount = 0
 
bool enabled = true
 
Area * parentArea
 The associate area (alias)
 
double nominalCapacity = 0.
 Capacity of reference per unit (MW) (pMax)
 
unsigned int areaWideIndex = (uint)-1
 The index of the cluster from the area's point of view.
 
unsigned int enabledIndex = (uint)-1
 
TimeSeriesNumbers tsNumbers
 tsNumbers must be constructed before series
 
TimeSeries series
 Series.
 
Matrix modulation
 Modulation matrix. More...
 
- Protected Attributes inherited from Antares::Data::Cluster
std::string pName
 
std::string pID
 

Member Enumeration Documentation

◆ TimeSeriesMode

enum Antares::Data::RenewableCluster::TimeSeriesMode
Enumerator
powerGeneration 

TS contain power generation for each unit Nominal capacity is ignored

productionFactor 

TS contain production factor for each unit Nominal capacity is used as a multiplicative factor

Member Function Documentation

◆ copyFrom()

void Antares::Data::RenewableCluster::copyFrom ( const RenewableCluster &  cluster)

Copy data from another cluster.

The name and the id will remain untouched.

◆ integrityCheck()

bool Antares::Data::RenewableCluster::integrityCheck ( )
overridevirtual

Check and fix all values of a renewable cluster.

Returns
False if an error has been detected and fixed with a default value

Implements Antares::Data::Cluster.

◆ reset()

void Antares::Data::RenewableCluster::reset ( )
overridevirtual

Reset to default values.

This method should only be called from the GUI

Reimplemented from Antares::Data::Cluster.

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