FormIt::Analysis::Solar API

Description

Enumerations
enum	FormIt::Analysis::Solar::WeatherDataStatus { FormIt::Analysis::Solar::kWeatherDataNotLoaded = 0 , FormIt::Analysis::Solar::kWeatherDataLoaded = 1 , FormIt::Analysis::Solar::kWeatherDataNotAvailableForLocation = 2 , FormIt::Analysis::Solar::kWeatherDataFormatError = 3 }
	Status of weather data for the given location. More...

Functions
FORMIT_CORE_EXPORT bool	FormIt::Analysis::Solar::GetMethod ()
	Settings & states.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::SetMethod (bool bMonthlyPeak)
	SetMethod() function.
FORMIT_CORE_EXPORT size_t	FormIt::Analysis::Solar::GetPeakMonth ()
	GetPeakMonth() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::SetPeakMonth (size_t nMonth)
	SetPeakMonth() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::GetLimits (double &min, double &max)
	GetLimits() function.
FORMIT_CORE_EXPORT ::string	FormIt::Analysis::Solar::GetUnitString ()
	GetUnitString() function.
FORMIT_CORE_EXPORT bool	FormIt::Analysis::Solar::IsInSolarAnalysisMode ()
	IsInSolarAnalysisMode() function.
FORMIT_CORE_EXPORT bool	FormIt::Analysis::Solar::IsNewAnalysisEnabled ()
	IsNewAnalysisEnabled() function.
FORMIT_CORE_EXPORT bool	FormIt::Analysis::Solar::IsAnalysisInProgress ()
	IsAnalysisInProgress() function.
FORMIT_CORE_EXPORT bool	FormIt::Analysis::Solar::CanAnalyze ()
	CanAnalyze() function.
FORMIT_CORE_EXPORT int	FormIt::Analysis::Solar::GetNumTooltipsToShow ()
	GetNumTooltipsToShow() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::SetNumTooltipsToShow (int)
	SetNumTooltipsToShow() function.
FORMIT_CORE_EXPORT WeatherDataStatus	FormIt::Analysis::Solar::GetWeatherDataStatus ()
	GetWeatherDataStatus() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::SetWeatherDataStatus (WeatherDataStatus status)
	SetWeatherDataStatus() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::Analyze (const SolarRadiationAnalysisProgressHelper &helper, bool forceNotThreaded=false)
	Actions.
FORMIT_CORE_EXPORT size_t	FormIt::Analysis::Solar::Analyze (bool bNeedInterrupt=false, double dInterruptTime=1.0, size_t nPreviousStep=0)
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::CancelAnalysis ()
	CancelAnalysis() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::ExitAnalysisMode ()
	ExitAnalysisMode() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::EnterAnalysisMode ()
	EnterAnalysisMode() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::ToggleAnalysisMode ()
	ToggleAnalysisMode() function.
FORMIT_CORE_EXPORT void	FormIt::Analysis::Solar::ResetAnalysis ()
	ResetAnalysis() function.

Variables
FORMIT_CORE_EXPORT ::string const	FormIt::Analysis::Solar::kToggleAnalysis
	Action Id's.

Enumeration Type Documentation

WeatherDataStatus

enum FormIt::Analysis::Solar::WeatherDataStatus

Status of weather data for the given location.

Enumerator
kWeatherDataNotLoaded	No weather data loaded yet.
kWeatherDataLoaded	Weather data loaded ok.
kWeatherDataNotAvailableForLocation	No weather data for the location available. Using default weather data
kWeatherDataFormatError	Weather data is bad and unusable. Using default weather data

Function Documentation

Analyze() [1/2]

FORMIT_CORE_EXPORT size_t FormIt::Analysis::Solar::Analyze	(	bool	bNeedInterrupt = false,
		double	dInterruptTime = 1.0,
		size_t	nPreviousStep = 0
	)

Analyze() [2/2]

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::Analyze	(	const SolarRadiationAnalysisProgressHelper &	helper,
		bool	forceNotThreaded = false
	)

Actions.

Parameters

[in]	helper
[in]	forceNotThreaded

CanAnalyze()

FORMIT_CORE_EXPORT bool FormIt::Analysis::Solar::CanAnalyze

(

)

CanAnalyze() function.

CancelAnalysis()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::CancelAnalysis

(

)

CancelAnalysis() function.

EnterAnalysisMode()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::EnterAnalysisMode

(

)

EnterAnalysisMode() function.

ExitAnalysisMode()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::ExitAnalysisMode

(

)

ExitAnalysisMode() function.

GetLimits()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::GetLimits	(	double &	min,
		double &	max
	)

GetLimits() function.

Parameters

[out]	min
[out]	max

GetMethod()

FORMIT_CORE_EXPORT bool FormIt::Analysis::Solar::GetMethod

(

)

Settings & states.

GetNumTooltipsToShow()

FORMIT_CORE_EXPORT int FormIt::Analysis::Solar::GetNumTooltipsToShow

(

)

GetNumTooltipsToShow() function.

GetPeakMonth()

FORMIT_CORE_EXPORT size_t FormIt::Analysis::Solar::GetPeakMonth

(

)

GetPeakMonth() function.

GetUnitString()

FORMIT_CORE_EXPORT ::string FormIt::Analysis::Solar::GetUnitString

(

)

GetUnitString() function.

GetWeatherDataStatus()

FORMIT_CORE_EXPORT WeatherDataStatus FormIt::Analysis::Solar::GetWeatherDataStatus

(

)

GetWeatherDataStatus() function.

IsAnalysisInProgress()

FORMIT_CORE_EXPORT bool FormIt::Analysis::Solar::IsAnalysisInProgress

(

)

IsAnalysisInProgress() function.

IsInSolarAnalysisMode()

FORMIT_CORE_EXPORT bool FormIt::Analysis::Solar::IsInSolarAnalysisMode

(

)

IsInSolarAnalysisMode() function.

IsNewAnalysisEnabled()

FORMIT_CORE_EXPORT bool FormIt::Analysis::Solar::IsNewAnalysisEnabled

(

)

IsNewAnalysisEnabled() function.

ResetAnalysis()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::ResetAnalysis

(

)

ResetAnalysis() function.

SetMethod()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::SetMethod

(

bool

bMonthlyPeak

)

SetMethod() function.

Parameters

[in]

bMonthlyPeak

SetNumTooltipsToShow()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::SetNumTooltipsToShow

(

int

)

SetNumTooltipsToShow() function.

SetPeakMonth()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::SetPeakMonth

(

size_t

nMonth

)

SetPeakMonth() function.

Parameters

[in]

nMonth

SetWeatherDataStatus()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::SetWeatherDataStatus

(

WeatherDataStatus

status

)

SetWeatherDataStatus() function.

Parameters

[in]

status

ToggleAnalysisMode()

FORMIT_CORE_EXPORT void FormIt::Analysis::Solar::ToggleAnalysisMode

(

)

ToggleAnalysisMode() function.

Variable Documentation

kToggleAnalysis

FORMIT_CORE_EXPORT ::string const FormIt::Analysis::Solar::kToggleAnalysis

extern

Action Id's.