Inheritance diagram for Antares::Data::XCast:

Public Types
enum	{ dataCoeffAlpha = 0 , dataCoeffBeta , dataCoeffGamma , dataCoeffDelta , dataCoeffTheta , dataCoeffMu , dataMax }
	All coefficients. More...

enum	Distribution { dtNone = 0 , dtUniform = 1 , dtBeta = 2 , dtNormal = 3 , dtWeibullShapeA = 4 , dtGammaShapeA = 5 , dtMax }
	All available probability distribution. More...

enum	{ conversionMaxPoints = 100 }

enum	TSTranslationUse { tsTranslationNone = 0 , tsTranslationBeforeConversion , tsTranslationAfterConversion }

using	Vector = std::vector<XCast*>
	Vector.

using	VectorConst = std::vector<const XCast*>
	Vector with the const qualifier.

Public Member Functions
Constructor & Destructor
	XCast (TimeSeriesType ts)
	Constructor.

	~XCast ()
	Destructor.

void	resetToDefaultValues ()
	Reset to default values.

void	copyFrom (const XCast &rhs)
	Copy settings from another XCast struct.

bool	loadFromFolder (const std::filesystem::path &folder)
	Load data from a folder.

bool	saveToFolder (const AnyString &folder) const
	Save data to a folder.

Static Public Member Functions
static const char *	DistributionToCString (Distribution d)
	Convert a distribution into its human readable representation.

static Distribution	StringToDistribution (AnyString str)
	Convert a CString into a probability distribution.

static const char *	DistributionToNameID (Distribution d)
	Convert a probability distribution into its string id representation.

static const char *	TSTranslationUseToCString (TSTranslationUse use)
	How to use the timeseries average.

static TSTranslationUse	CStringToTSTranslationUse (const AnyString &str)

Memory management
Matrix< float >	data
	Data required for XCast: coefficients (coeffMax x 12)

Matrix< float >	K
	K (12x24)

Matrix< int32_t >	translation
	Time-series average.

TSTranslationUse	useTranslation
	How to use the timeseries average.

Distribution	distribution
	The probability distribution to use.

double	capacity
	The installed capacity.

bool	useConversion
	True to use the transfer function after the generation of the time-series.

Matrix< float >	conversion
	The conversion function.

const TimeSeriesType	timeSeries
	The related time-series.

bool	forceReload (bool reload=false) const
	Make sure that all data are loaded in memory.

void	markAsModified () const
	Mark the load data as modified.

void	resetTransferFunction ()

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

All coefficients.

Enumerator
dataMax	The maximum number of coefficients.

anonymous enum

Enumerator
conversionMaxPoints	Hard limit for the number of points of the transfer function.

All available probability distribution.

Enumerator
dtNone	None.
dtUniform	The uniform distribution.
dtBeta	The Beta distribution.
dtNormal	The normal distribution.
dtWeibullShapeA	The Weibul distribution, of shape A.
dtGammaShapeA	The Gamma distribution, of shape A.
dtMax	The maximum number of distributions.

Enumerator
tsTranslationNone	Do not use the time-series average.
tsTranslationBeforeConversion	Add the time-series average before computing the transfer function.
tsTranslationAfterConversion	Add the time-series average after computing the transfer function.

Matrix<float> Antares::Data::XCast::conversion

The conversion function.

The first row gives the X-Coordinates, the second one the Y-Coordinates.

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