Antares::Data::RenewableCluster Class Reference

Inheritance diagram for Antares::Data::RenewableCluster:

Public Types
enum	RenewableGroup {   windOffShore = 0 , windOnShore , thermalSolar , PVSolar ,   rooftopSolar , renewableOther1 , renewableOther2 , renewableOther3 ,   renewableOther4 , groupMax }
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 RenewableGroup	groupID = renewableOther1
	The group ID.
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.
void	setGroup (Data::ClusterName newgrp) override
	Set the group.
bool	integrityCheck () override
	Check and fix all values of a renewable cluster.
void	copyFrom (const RenewableCluster &cluster)
	Copy data from another cluster.
uint	groupId () const override
	Group ID as an uint.
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 ClusterName &	id () const
const ClusterName &	group () const
const ClusterName &	name () const
void	setName (const AnyString &newname)
Yuni::String	getFullName () 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.
Protected Attributes inherited from Antares::Data::Cluster
Data::ClusterName	pName
Data::ClusterName	pID
Data::ClusterName	pGroup

Member Enumeration Documentation

RenewableGroup

enum Antares::Data::RenewableCluster::RenewableGroup

Enumerator
windOffShore	Wind offshore.
windOnShore	Wind onshore.
thermalSolar	Concentration solar.
PVSolar	PV solar.
rooftopSolar	Rooftop solar.
renewableOther1	Other 1.
renewableOther2	Other 2.
renewableOther3	Other 3.
renewableOther4	Other 4.
groupMax	The highest value.

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::Data::RenewableCluster::copyFrom

(

const RenewableCluster &

cluster

)

Copy data from another cluster.

The name and the id will remain untouched.

forceReload()

bool Antares::Data::Data::RenewableCluster::forceReload ( bool reload ) const

overridevirtual

Invalidate all data associated to the renewable cluster.

Implements Antares::Data::Cluster.

groupId()

uint Antares::Data::RenewableCluster::groupId ( ) const

overridevirtual

Group ID as an uint.

Implements Antares::Data::Cluster.

integrityCheck()

bool Antares::Data::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.

markAsModified()

void Antares::Data::Data::RenewableCluster::markAsModified ( ) const

overridevirtual

Mark the renewable cluster as modified.

Implements Antares::Data::Cluster.

reset()

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

overridevirtual

Reset to default values.

This method should only be called from the GUI

Reimplemented from Antares::Data::Cluster.

setGroup()

void Antares::Data::Data::RenewableCluster::setGroup ( Data::ClusterName newgrp )

overridevirtual

Set the group.

Implements Antares::Data::Cluster.

Member Data Documentation

groupID

enum RenewableGroup Antares::Data::RenewableCluster::groupID = renewableOther1

The group ID.

This value is computed from the field 'group' in 'group()

See also

group()

---

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

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