Class utility for building CSV results files. More...

#include <surveyresults.h>

Public Types
typedef Yuni::CString< 10, false >	PrecisionType
	Precision.

typedef Yuni::CString< 128, false >	CaptionType
	Caption.

Constructor & Destructor
enum	{ captionCount = 3 }

Solver::Variable::Private::SurveyResultsData	data
	Data (not related to the template parameter)

CaptionType	variableCaption
	Caption for the current variable.

std::string	variableUnit

double **	values
	Matrix where to store all results.

CaptionType *	captions [captionCount]
	Array to store all variable names.

PrecisionType *	precision
	Precision to for each column (in the printf format)

bool *	nonApplicableStatus
	Non applicable status for each column (in the printf format)

uint	digestSize

bool **	digestNonApplicableStatus

uint	maxVariables
	The total number of variables.

bool	yearByYearResults
	Flag to known if we are in the year-by-year mode.

bool *	isCurrentVarNA

bool *	isPrinted
	Same thing for print status (do we print the current output variable ?)

IResultWriter &	pResultWriter

	SurveyResults (const Data::Study &s, const Yuni::String &o, IResultWriter &writer)
	Default constructor.

	~SurveyResults ()
	Destructor.

void	saveToFile (int dataLevel, int fileLevel, int precisionLevel)
	Write the data into a file.

void	exportGridInfos ()
	Export informations about the current study.

void	resetValuesAtLine (uint)

void	exportDigestAllYears (std::string &buffer)
	Export the digest file.

void	exportDigestMatrix (const char *title, std::string &buffer)

Detailed Description

Class utility for building CSV results files.

Constructor & Destructor Documentation

◆ SurveyResults()

Antares::Solver::Variable::SurveyResults::SurveyResults	(	const Data::Study &	s,
		const Yuni::String &	o,
		IResultWriter &	writer )

Default constructor.

Parameters

maxVars	The maximum total of variables that we may need for writing the report
s	Reference to the study
o	The output folder
year	The current year, if any

Member Function Documentation

◆ exportGridInfos()

void Antares::Solver::Variable::SurveyResults::exportGridInfos ( )

Export informations about the current study.

It is composed by several files to completely describe the system and provide a good support for Excel macros.

Member Data Documentation

◆ isCurrentVarNA

bool* Antares::Solver::Variable::SurveyResults::isCurrentVarNA

When looping over output variables, is current variable non applicable ? In the static type list of variables, there is a need to convey the non applicable status to variables statistic results through an instance of the current class. Furthermore, some unusual variables are actually "multi-variables", that is they contain actually several variables. Therefore, the following is a pointer on the current output variable's non applicable status. In case of a multi-variable, it is a pointer on the current sub-variable's non applicable status. This pointer references a TEMPORARY boolean value. It is NEVER used to allocate a table.

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

src/solver/variable/include/antares/solver/variable/surveyresults/surveyresults.h
src/solver/variable/surveyresults/surveyresults.cpp

Public Types