FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::Analysis::Solar Namespace Reference

Enumerations

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

Functions

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

Variables

FORMIT_CORE_EXPORT::string const kToggleAnalysis
 Action Id's. More...