Antares::Solver::Variable::Links< VariablePerLink > Class Template Reference

Classes
struct	Statistics

Public Types
enum	{ count = NextType::count }
using	NextType = VariablePerLink
	Type of the next static variable.
using	VCardType = VCardAllLinks
	VCard.
using	ResultsType = VCardType::ResultsType
	Ancestor.

Static Public Member Functions
template<class PredicateT >
static void	RetrieveVariableList (PredicateT &predicate)
	Retrieve the list of all individual variables.

Constructor & Destructor
NextType *	pLinks
	Area list.
uint	pLinkCount
	The total number of links.
template<class I >
static void	provideInformations (I &infos)
	Links ()
	Default constructor.
	~Links ()
	Destructor.
void	initializeFromStudy (Data::Study &study)
void	initializeFromArea (Data::Study *, Data::Area *)
void	initializeFromThermalCluster (Data::Study *, Data::Area *, Data::ThermalCluster *)
void	initializeFromAreaLink (Data::Study *, Data::AreaLink *)
void	broadcastNonApplicability (bool applyNonApplicable)
void	getPrintStatusFromStudy (Data::Study &study)
void	supplyMaxNumberOfColumns (Data::Study &study)
void	simulationBegin ()
void	simulationEnd ()
void	yearBegin (uint year, unsigned int numSpace)
void	yearEndBuildPrepareDataForEachThermalCluster (State &state, uint year, uint numSpace)
void	yearEndBuildForEachThermalCluster (State &state, uint year, uint numSpace)
void	yearEndBuild (State &state, uint year)
void	yearEnd (uint year, uint numSpace)
void	computeSummary (std::map< unsigned int, unsigned int > &numSpaceToYear, unsigned int nbYearsForCurrentSummary)
void	weekBegin (State &state)
void	weekForEachArea (State &state, uint numSpace)
void	weekEnd (State &state)
void	hourBegin (uint hourInTheYear)
void	hourForEachArea (State &state, uint numSpace)
void	hourForEachLink (State &state, uint numSpace)
void	hourEnd (State &state, uint hourInTheYear)
void	buildSurveyReport (SurveyResults &results, int dataLevel, int fileLevel, int precision) const
void	buildAnnualSurveyReport (SurveyResults &results, int dataLevel, int fileLevel, int precision, uint numSpace) const
void	beforeYearByYearExport (uint year, uint numSpace)
void	buildDigest (SurveyResults &results, int digestLevel, int dataLevel) const
template<class VCardToFindT >
const double *	retrieveHourlyResultsForCurrentYear (uint) const
template<class VCardToFindT >
void	retrieveResultsForArea (Storage< VCardToFindT >::ResultsType **result, const Data::Area *)
template<class VCardToFindT >
void	retrieveResultsForThermalCluster (Storage< VCardToFindT >::ResultsType **result, const Data::ThermalCluster *)
template<class VCardToFindT >
void	retrieveResultsForLink (Storage< VCardToFindT >::ResultsType **result, const Data::AreaLink *link)
template<class SearchVCardT , class O >
void	computeSpatialAggregateWith (O &, uint)

Member Typedef Documentation

ResultsType

template<class VariablePerLink >

using Antares::Solver::Variable::Links< VariablePerLink >::ResultsType = VCardType::ResultsType

Ancestor.

List of expected results

Member Enumeration Documentation

anonymous enum

template<class VariablePerLink >

anonymous enum

Enumerator
count	How many items have we got.

Member Function Documentation

RetrieveVariableList()

template<class VariablePerLink >

template<class PredicateT >

void Antares::Solver::Variable::Links< VariablePerLink >::RetrieveVariableList ( PredicateT & predicate )

static

Retrieve the list of all individual variables.

The predicate must implement the method add(name, unit, comment).

---

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

• src/solver/variable/include/antares/solver/variable/commons/links/links.h
• src/solver/variable/include/antares/solver/variable/commons/links/links.hxx