Antares::Data::Cluster Class Reference

Inheritance diagram for Antares::Data::Cluster:

Public Types
using	Set = std::set< Cluster *, CompareClusterName >

Public Member Functions
	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
virtual bool	integrityCheck ()=0
	Check and fix all values of a renewable cluster. More...
virtual bool	forceReload (bool reload) const =0
	Invalidate all data associated to the cluster.
void	invalidateArea ()
	Invalidate the whole attached area.
virtual void	markAsModified () const =0
	Mark the cluster as modified.
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)
virtual void	reset ()
	Reset to default values. More...
bool	saveDataSeriesToFolder (const AnyString &folder) const
bool	loadDataSeriesFromFolder (Study &s, const std::filesystem::path &folder)
bool	isEnabled () const

Public Attributes
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
std::string	pName
std::string	pID

Member Function Documentation

integrityCheck()

virtual bool Antares::Data::Cluster::integrityCheck ( )

pure virtual

Check and fix all values of a renewable cluster.

Returns

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

Implemented in Antares::Data::ThermalCluster, and Antares::Data::RenewableCluster.

reset()

void Antares::Data::Cluster::reset ( )

virtual

Reset to default values.

This method should only be called from the GUI

Reimplemented in Antares::Data::ThermalCluster, and Antares::Data::RenewableCluster.

Member Data Documentation

modulation

Matrix Antares::Data::Cluster::modulation

Modulation matrix.

It is merely a 3x8760 matrix [modulation cost, modulation capacity, market bid modulation] per hour

---

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

• src/libs/antares/study/include/antares/study/parts/common/cluster.h
• src/libs/antares/study/parts/common/cluster.cpp