#include <loopFlow.h>

Inheritance diagram for Antares::Solver::Variable::Economy::LoopFlow< NextT >:

Classes
struct	Statistics

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

typedef NextT	NextType
	Type of the next static variable.

typedef VCardLoopFlow	VCardType
	VCard.

typedef Variable::IVariable< LoopFlow< NextT >, NextT, 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< LoopFlow< Container::EndOfList >, Container::EndOfList, VCardLoopFlow >
typedef LoopFlow< Container::EndOfList >	ChildType
	Child.

typedef Container::EndOfList	NextType
	Type of the next static variable.

typedef IVariable< LoopFlow< Container::EndOfList >, Container::EndOfList, VCardLoopFlow >	VariableType
	Variable.

typedef VCardLoopFlow	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< VCardLoopFlow >::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	initializeFromAreaLink (Data::Study study, Data::AreaLink link)

void	simulationBegin ()

void	simulationEnd ()

void	yearBegin (uint year, unsigned int numSpace)

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

void	yearEnd (uint year, unsigned int numSpace)

void	computeSummary (unsigned int year, unsigned int numSpace)

void	hourBegin (uint hourInTheYear)

void	hourForEachArea (State &state, unsigned int numSpace)

void	hourForEachLink (State &state, unsigned int numSpace)

void	buildDigest (SurveyResults &results, int digestLevel, int dataLevel) const

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

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

Public Member Functions inherited from Antares::Solver::Variable::IVariable< LoopFlow< Container::EndOfList >, Container::EndOfList, VCardLoopFlow >
void	getPrintStatusFromStudy (Data::Study &study)

void	supplyMaxNumberOfColumns (Data::Study &study)

	IVariable ()
	Default constructor.

	~IVariable ()

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

size_t	getMaxNumberColumns () const

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

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

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

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. More...

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

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. More...

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

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

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. More...

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

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 R >
static void	InitializeResultsFromStudy (R &results, Data::Study &study)

Static Public Member Functions inherited from Antares::Solver::Variable::IVariable< LoopFlow< Container::EndOfList >, Container::EndOfList, VCardLoopFlow >
static void	InitializeResultsFromStudy (R &results, Data::Study &study)
	Initialize the results of the variable. More...

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

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

Additional Inherited Members
Static Public Attributes inherited from Antares::Solver::Variable::IVariable< LoopFlow< Container::EndOfList >, Container::EndOfList, VCardLoopFlow >
static constexpr uint8_t	categoryDataLevel

static constexpr uint8_t	categoryFileLevel

Protected Types inherited from Antares::Solver::Variable::Container::EndOfList
enum	{ count = 0 }

typedef void	NextType
	Type of the next static variable.

Protected Member Functions inherited from Antares::Solver::Variable::Container::EndOfList
	EndOfList ()

	~EndOfList ()

void	broadcastNonApplicability (bool)

void	getPrintStatusFromStudy ([[maybe_unused]] Data::Study &study)

void	supplyMaxNumberOfColumns ([[maybe_unused]] Data::Study &study)

template<class V >
void	yearEndSpatialAggregates (V &, unsigned int, uint)

template<class V , class SetT >
void	yearEndSpatialAggregates (V &, unsigned int, const SetT &, uint numSpace)

template<class V , class SetT >
void	simulationEndSpatialAggregates (V &, const SetT &)

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

void	localBuildAnnualSurveyReport (SurveyResults &, int, int, unsigned int) const

Static Protected Member Functions inherited from Antares::Solver::Variable::Container::EndOfList
template<class PredicateT >
static void	RetrieveVariableList (PredicateT &)
	Retrieve the list of all individual variables. More...

static void	initializeFromStudy ([[maybe_unused]] Data::Study &study)

static void	initializeFromArea (Data::Study , Data::Area )

static void	initializeFromThermalCluster (Data::Study , Data::Area , Data::ThermalCluster *)

static void	initializeFromAreaLink (Data::Study , Data::AreaLink )

static void	simulationBegin ()

static void	simulationEnd ()

static void	yearBegin (unsigned int, unsigned int)

static void	yearEndBuildPrepareDataForEachThermalCluster (State &state, uint year, uint numSpace)

static void	yearEndBuildForEachThermalCluster (State &state, uint year, uint numSpace)

static void	yearEndBuild (State &, unsigned int, unsigned int)

static void	yearEnd (unsigned int, unsigned int)

static void	computeSummary (unsigned int year, unsigned int numSpace)

template<class V >
static void	computeSpatialAggregatesSummary (V &, unsigned int, unsigned int)

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

static void	weekBegin (State &)

static void	weekForEachArea (State &, uint numSpace)

static void	weekEnd (State &)

static void	hourBegin (unsigned int)

static void	hourForEachArea (State &, uint numSpace)

static void	hourForEachLink (State &, uint numSpace)

static void	hourEnd (State &, unsigned int)

static void	buildSurveyReport (SurveyResults &, int, int, int)

static void	buildAnnualSurveyReport (SurveyResults &, int, int, int, uint)

static void	buildDigest (SurveyResults &, int, int)

static void	beforeYearByYearExport (uint, uint)

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

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

template<class SearchVCardT , class O >
static void	computeSpatialAggregateWith (O &, const Data::Area *)

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

template<class VCardToFindT , class O >
static void	retrieveResultsForArea (O *, const Data::Area )

template<class VCardToFindT , class O >
static void	retrieveResultsForThermalCluster (O *, const Data::ThermalCluster )

template<class VCardToFindT , class O >
static void	retrieveResultsForLink (O *, const Data::AreaLink )

Protected Attributes inherited from Antares::Solver::Variable::IVariable< LoopFlow< Container::EndOfList >, Container::EndOfList, VCardLoopFlow >
StoredResultType	pResults
	All the results about this variable.

bool *	isNonApplicable

bool *	isPrinted

uint	pColumnCount

Detailed Description

template<class NextT = Container::EndOfList>
class Antares::Solver::Variable::Economy::LoopFlow< NextT >

LoopFlow.

Member Enumeration Documentation

◆ anonymous enum

template<class NextT = Container::EndOfList>

anonymous enum

Enumerator
count	How many items have we got.

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

src/solver/variable/include/antares/solver/variable/economy/links/loopFlow.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class NextT = Container::EndOfList> class Antares::Solver::Variable::Economy::LoopFlow< NextT >

Member Enumeration Documentation

◆ anonymous enum

template<class NextT = Container::EndOfList>
class Antares::Solver::Variable::Economy::LoopFlow< NextT >