Public Types
enum	Mode { modeNone = 0 , modeAnnual = 1 , modeMonthly = 2 }

Public Member Functions
Constructor & Destructor
	Correlation ()
	Default Constructor.

	~Correlation ()=default
	Destructor.

Mode
void	mode (Mode mode)
	Reset the mode.

Mode	mode () const
	Get the current mode.

void	set (Matrix<> &m, const Area &from, const Area &to, double v)

template<class StringT >
void	set (Matrix<> &m, const Area &from, const Area &to, const StringT &value)

Static Public Member Functions
static const char *	ModeToCString (Mode mode)
	Convert a correlation mode into its string representation.

static Mode	CStringToMode (const AnyString &str)
	Convert a string into the corresponding mode.

Load / Save
Matrix	annual
	The correlation matrix for the whole year.

std::vector< Matrix<> >	monthly
	All correlation matrices per month (12)

Yuni::CString< 30, false >	correlationName
	The name to displays in logs.

int	timeSeries
	The associate time-series.

void	reset (Study &study)
	Reset the matrices.

bool	loadFromFile (Study &study, const AnyString &filename, bool warnings=true)
	Load correlated values from an INI file. More...

bool	saveToFile (Study &study, const AnyString &filename) const
	Save the correlation matrices into an INI file.

void	clear ()
	Clear all data.

void	copyFrom (const Correlation &source, const Study &studySource, const AreaName &areaSource, const AreaNameMapping &mapping, const Study &study)
	Copy correlation coefficients from another correlation grid. More...

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

void	markAsModified () const
	Mark as modified.

Member Function Documentation

◆ copyFrom()

void Antares::Data::Correlation::copyFrom	(	const Correlation &	source,
		const Study &	studySource,
		const AreaName &	areaSource,
		const AreaNameMapping &	mapping,
		const Study &	study
	)

Copy correlation coefficients from another correlation grid.

Parameters

source	The correlation matrix source
studySource	The associated study for the given correlation grid
areaSource	Name of the area to import
mapping	Area's name Mapping from the source to the target
study	Study for the local correlation grid

bool Antares::Data::Correlation::loadFromFile	(	Study &	study,
		const AnyString &	filename,
		bool	warnings = `true`
	)

Load correlated values from an INI file.

Parameters

study	The attached study
filename	The INI file
warnings	True to enable warnings
version	Format version expected. Use studyVersionUnknown to use the format version of the given study

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