Antares::TSGenerator::XCast::StudyData Class Reference

Constructor & Destructor
Data::Area::Vector	localareas
	List of all areas (sub-set of the complete list)
std::array< Matrix< float >, 12 >	correlation
	Correlation coefficients for each month.
Data::Correlation::Mode	mode
	Correlation mode (monthly / annual)
	StudyData ()
	~StudyData ()=default
	Destructor.
template<class PredicateT >
void	loadFromStudy (Data::Study &study, const Data::Correlation &correlation, PredicateT &predicate)
	Load all informations from a study and a predicate. More...

Member Function Documentation

loadFromStudy()

template<class PredicateT >

void StudyData::loadFromStudy	(	Data::Study &	study,
		const Data::Correlation &	correlation,
		PredicateT &	predicate
	)

Load all informations from a study and a predicate.

Example of a predicate:

struct WindPredicate
{
    bool operator () (const Area&) const
    {
        return true;
    }
 
    Data::XCast* retrieveXCastData(const Area* area) const
    {
        return area->wind.prepro->xcast;
    }
};

All areas excluded from the list will see their time-series matrix reset to 1x8760.

Parameters

study	A study
predicate	Predicate to determine whether the specified object meets some criteria and to retrive some specific data from the area

---

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

• src/solver/ts-generator/include/antares/solver/ts-generator/xcast/studydata.h
• src/solver/ts-generator/include/antares/solver/ts-generator/xcast/studydata.hxx
• src/solver/ts-generator/xcast/studydata.cpp