#include <join.h>

Inheritance diagram for Antares::Solver::Variable::Join< LeftT, RightT >:

Classes
struct	Statistics

Public Types
enum	{ count = 1 + RightT::count }

typedef LeftT	LeftType

typedef RightT	RightType

typedef VCardJoin	VCardType
	VCard.

typedef Variable::IVariable< Join< LeftT, RightT >, Yuni::Default, VCardType >	AncestorType
	Ancestor.

typedef VCardType::ResultsType	ResultsType
	List of expected results.

typedef VariableAccessor< ResultsType, VCardType::columnCount >	VariableAccessorType

Public Types inherited from Antares::Solver::Variable::IVariable< Join< LeftT, RightT >, Yuni::Default, VCardJoin >
typedef Join< LeftT, RightT >	ChildType
	Child.

typedef Yuni::Default	NextType
	Type of the next static variable.

typedef IVariable< Join< LeftT, RightT >, Yuni::Default, VCardJoin >	VariableType
	Variable.

typedef VCardJoin	VCardType
	VCard.

typedef VCardType::ResultsType	ResultsType
	List of expected results.

typedef VariableAccessor< ResultsType, VCardType::columnCount >	VariableAccessorType
	Proxy for accessing to the intermediate results.

typedef Storage< VCardJoin >::ResultsType	StoredResultType
	Results.

Public Member Functions
void	initializeFromStudy (Data::Study &study)

void	initializeFromArea (Data::Study study, Data::Area area)

void	initializeFromLink (Data::Study study, Data::AreaLink link)

void	initializeFromThermalCluster (Data::Study study, Data::Area area, Data::ThermalCluster *cluster)

void	simulationBegin ()

void	simulationEnd ()

void	yearBegin (unsigned int year, unsigned int numSpace)

void	yearEndBuildPrepareDataForEachThermalCluster (State &state, uint year)

void	yearEndBuildForEachThermalCluster (State &state, uint year)

void	yearEndBuild (State &state, unsigned int year, unsigned int numSpace)

void	yearEnd (unsigned int year, unsigned int numSpace)

void	computeSummary (std::map< unsigned int, unsigned int > &numSpaceToYear, unsigned int nbYearsForCurrentSummary)

void	weekBegin (State &state)

void	weekForEachArea (State &state, unsigned int numSpace)

void	weekEnd (State &state)

void	hourBegin (unsigned int hourInTheYear)

void	hourForEachArea (State &state, unsigned int numSpace)

void	hourForEachLink (State &state)

void	hourEnd (State &state, unsigned int 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	buildDigest (SurveyResults &results, int digestLevel, int dataLevel) const

void	beforeYearByYearExport (uint year, uint numSpace)

template<class SearchVCardT , class O >
void	computeSpatialAggregateWith (O &out)

template<class SearchVCardT , class O >
void	computeSpatialAggregateWith (O &out, const Data::Area *area, uint numSpace)

template<class V >
void	yearEndSpatialAggregates (V &allVars, unsigned int year, unsigned int numSpace)

template<class V >
void	computeSpatialAggregatesSummary (V &allVars, std::map< unsigned int, unsigned int > &numSpaceToYear, unsigned int nbYearsForCurrentSummary)

template<class V >
void	simulationEndSpatialAggregates (V &allVars)

template<class VCardToFindT >
const double *	retrieveHourlyResultsForCurrentYear () const

template<class VCardToFindT >
void	retrieveResultsForArea (typename Variable::Storage< VCardToFindT >::ResultsType *result, const Data::Area area)

template<class VCardToFindT >
void	retrieveResultsForThermalCluster (typename Variable::Storage< VCardToFindT >::ResultsType *result, const Data::ThermalCluster cluster)

template<class VCardToFindT >
void	retrieveResultsForLink (typename Variable::Storage< VCardToFindT >::ResultsType *result, const Data::AreaLink link)

void	localBuildAnnualSurveyReport (SurveyResults &results, int fileLevel, int precision) const

Public Member Functions inherited from Antares::Solver::Variable::IVariable< Join< LeftT, RightT >, Yuni::Default, VCardJoin >
void	getPrintStatusFromStudy (Data::Study &study)

void	supplyMaxNumberOfColumns (Data::Study &study)

	IVariable ()
	Default constructor.

void	initializeFromStudy (Data::Study &study)
	Initialize the variable.

size_t	getMaxNumberColumns () const

void	initializeFromArea (Data::Study study, Data::Area area)
	Initialize the variable with a specific area.

void	initializeFromLink (Data::Study study, Data::AreaLink link)
	Initialize the variable with a specific link between two areas.

void	initializeFromThermalCluster (Data::Study study, Data::Area area, Data::ThermalCluster *cluster)
	Initialize the variable with a specific thermal cluster.

void	broadcastNonApplicability (bool applyNonApplicable)

void	simulationBegin ()
	Notify to all variables that the simulation is about to begin.

void	simulationEnd ()
	Notify to all variables that the simulation has finished.

void	yearBegin (uint year)
	Notify to all variables that a new year is about to start.

void	yearEndBuild (State &state, uint year)
	Notify to all variables that the year is close to end.

void	yearEndBuildPrepareDataForEachThermalCluster (State &state, uint year, uint numSpace)
	Notify to all variables to prepare data for the close to year end calculations for each thermal cluster.

void	yearEndBuildForEachThermalCluster (State &state, uint year, uint numSpace)
	Notify to all variables that the year is close to end.

void	yearEnd (uint year)
	Notify to all variables that the year is now over.

void	yearEndSpatialAggregates (V &allVars, uint year, unsigned int numSpace)

void	yearEndSpatialAggregates (V &allVars, uint year, const SetT &set)

void	simulationEndSpatialAggregates (V &allVars)

void	simulationEndSpatialAggregates (V &allVars, const SetT &set)

void	hourBegin (uint hourInTheYear)
	Event: A new hour in the year has just began.

void	hourForEachArea (State &state)
	Event: For a given hour in the year, walking through all areas.

void	hourForEachArea (State &state, unsigned int numSpace)

void	hourForEachLink (State &state, uint numSpace)
	Event: For a given hour in the year, walking through all links.

void	hourEnd (State &state, uint hourInTheYear)
	Event: A new hour in the year has just ended.

void	weekBegin (State &state)

void	weekForEachArea (State &state, uint numSpace)

void	weekEnd (State &state)

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	buildDigest (SurveyResults &results, int digestLevel, int dataLevel) const

void	beforeYearByYearExport (uint year, uint numSpace)
	Event triggered before exporting a year-by-year survey report.

void	computeSpatialAggregateWith (O &out, uint numSpace)
	Compute the spatial cluster with the results of a single variable.

void	computeSpatialAggregateWith (O &out, const Data::Area *area)
	Compute the spatial cluster with the results of a single variable and a given area.

const double *	retrieveHourlyResultsForCurrentYear (uint numSpace) const

void	retrieveResultsForArea (typename Storage< VCardToFindT >::ResultsType *result, const Data::Area area)

void	retrieveResultsForThermalCluster (typename Storage< VCardToFindT >::ResultsType *result, const Data::ThermalCluster cluster)

void	retrieveResultsForLink (typename Storage< VCardToFindT >::ResultsType *result, const Data::AreaLink link)

Antares::Memory::Stored< double >::ConstReturnType	retrieveRawHourlyValuesForCurrentYear (uint column, uint) const

const StoredResultType &	results () const
	The results.

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

template<class I >
static void	provideInformations (I &infos)

Static Public Member Functions inherited from Antares::Solver::Variable::IVariable< Join< LeftT, RightT >, Yuni::Default, VCardJoin >
static void	InitializeResultsFromStudy (R &results, Data::Study &study)
	Initialize the results of the variable.

static void	RetrieveVariableList (PredicateT &predicate)
	Retrieve the list of all individual variables.

static void	provideInformations (I &infos)
	"Print" informations about the variable tree

Additional Inherited Members
Static Public Attributes inherited from Antares::Solver::Variable::IVariable< Join< LeftT, RightT >, Yuni::Default, VCardJoin >
static constexpr uint8_t	categoryDataLevel

static constexpr uint8_t	categoryFileLevel

Protected Attributes inherited from Antares::Solver::Variable::IVariable< Join< LeftT, RightT >, Yuni::Default, VCardJoin >
StoredResultType	pResults
	All the results about this variable.

bool *	isNonApplicable

bool *	isPrinted

uint	pColumnCount

Detailed Description

template<class LeftT, class RightT>
class Antares::Solver::Variable::Join< LeftT, RightT >

Join.

Member Enumeration Documentation

◆ anonymous enum

template<class LeftT , class RightT >

anonymous enum

Enumerator
count	How many items have we got.

Member Function Documentation

◆ RetrieveVariableList()

template<class LeftT , class RightT >

template<class PredicateT >

static void Antares::Solver::Variable::Join< LeftT, RightT >::RetrieveVariableList ( PredicateT & predicate )

inlinestatic

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 file:

src/solver/variable/include/antares/solver/variable/commons/join.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ RetrieveVariableList()