FormIt.Analysis.Solar API

Description

Functions
json	FormIt.Analysis.Solar.EnterAnalysisMode ()
	Start Solar Analysis mode. More...
json	FormIt.Analysis.Solar.ToggleAnalysisMode ()
	ToggleAnalysisMode Solar Analysis mode. More...
json	FormIt.Analysis.Solar.ExitAnalysisMode ()
	End Solar Analysis mode. More...
json	FormIt.Analysis.Solar.ToggleFaceSelections (aFacePaths)
	Toggle the face selection with the given faces. More...
json	FormIt.Analysis.Solar.ResetAnalysis ()
	Reset the analysis. More...
json	FormIt.Analysis.Solar.SetMethod (bMonthlyPeak)
	Sets the analysis method to monthly peak or yearly cumulative. More...
json	FormIt.Analysis.Solar.SetPeakMonth (month)
	Sets the month for the monthly peak analysis method. More...
json	FormIt.Analysis.Solar.GetPeakMonth ()
	Gets the month for the monthly peak analysis method. More...
json	FormIt.Analysis.Solar.GetMethod ()
	Gets the analysis method : monthly peak (true) or yearly cumulative (false). More...
json	FormIt.Analysis.Solar.GetLimits ()
	GetLimits Parameters: In: Out: {success: ,min: , max:}. More...
json	FormIt.Analysis.Solar.GetUnitString ()
	GetUnitString Parameters: In: Out: {success: , UnitString:}. More...
json	FormIt.Analysis.Solar.IsInSolarAnalysisMode ()
	IsInSolarAnalysisMode Parameters: In: Out: bool IsInSolarAnalysisMode. More...
json	FormIt.Analysis.Solar.IsNewAnalysisEnabled ()
	IsNewAnalysisEnabled Parameters: In: Out: bool. More...
json	FormIt.Analysis.Solar.IsAnalysisInProgress ()
	IsAnalysisInProgress Parameters: In: Out: bool. More...
json	FormIt.Analysis.Solar.CanAnalyze ()
	CanAnalyze Parameters: In: Out: bool. More...
json	FormIt.Analysis.Solar.GetWeatherDataStatus ()
	GetWeatherDataStatus Parameters: In: Out: status of weather data. More...
json	FormIt.Analysis.Solar.SetWeatherDataStatus (status)
	SetWeatherDataStatus Parameters: In: status of weather data Out: More...
json	FormIt.Analysis.Solar.GetNumTooltipsToShow ()
	GetNumTooltipsToShow Parameters: In: Out: Number of tooltips to show. More...
json	FormIt.Analysis.Solar.SetNumTooltipsToShow (numToolTips)
	SetNumTooltipsToShow Parameters: In: Out: JSON_UNDEFINED. More...
json	FormIt.Analysis.Solar.Analyze ()
json	FormIt.Analysis.Solar.CancelAnalysis ()
	Cancel the analysis. More...
json	FormIt.Analysis.Solar.GetValueFromFaceAtPoint (face, pt)
	Gets the analysis value for a point on a face. More...

Function Documentation

json FormIt.Analysis.Solar.Analyze

(

)

json FormIt.Analysis.Solar.CanAnalyze

(

)

CanAnalyze Parameters: In: Out: bool.

Returns

{...}

json FormIt.Analysis.Solar.CancelAnalysis

(

)

Cancel the analysis.

Parameters: In: Out: JSON_UNDEFINED

Returns

JSON_UNDEFINED, i.e. {}

json FormIt.Analysis.Solar.EnterAnalysisMode

(

)

Start Solar Analysis mode.

Parameters: In: Out: bSuccess

Returns

bSuccess

json FormIt.Analysis.Solar.ExitAnalysisMode

(

)

End Solar Analysis mode.

Parameters: In: Out: bSuccess

Returns

bSuccess

json FormIt.Analysis.Solar.GetLimits

(

)

GetLimits Parameters: In: Out: {success: ,min: , max:}.

Returns

{ "success" , false };

json FormIt.Analysis.Solar.GetMethod

(

)

Gets the analysis method : monthly peak (true) or yearly cumulative (false).

Parameters: In: Out: monthly peak true/false

Returns

false

json FormIt.Analysis.Solar.GetNumTooltipsToShow

(

)

GetNumTooltipsToShow Parameters: In: Out: Number of tooltips to show.

Returns

{...}

json FormIt.Analysis.Solar.GetPeakMonth

(

)

Gets the month for the monthly peak analysis method.

Parameters: In: Out: success, month

Returns

{ { "success" , to_json(bSuccess)}, { "month" , to_json(month)} };

json FormIt.Analysis.Solar.GetUnitString

(

)

GetUnitString Parameters: In: Out: {success: , UnitString:}.

Returns

{ "success" , false };

json FormIt.Analysis.Solar.GetValueFromFaceAtPoint	(	face	,
		pt
	)

Gets the analysis value for a point on a face.

Parameters: In: face, pt Out: success, analysis value

Parameters

[in]	face	WSM.Utils.HistoryObjects
[in]	pt	WSM.Point3d

Returns

{ { "success" , to_json(bSuccess)}, { "value" , to_json(val)} };

json FormIt.Analysis.Solar.GetWeatherDataStatus

(

)

GetWeatherDataStatus Parameters: In: Out: status of weather data.

Returns

{...}

json FormIt.Analysis.Solar.IsAnalysisInProgress

(

)

IsAnalysisInProgress Parameters: In: Out: bool.

Returns

{...}

json FormIt.Analysis.Solar.IsInSolarAnalysisMode

(

)

IsInSolarAnalysisMode Parameters: In: Out: bool IsInSolarAnalysisMode.

Returns

{...}

json FormIt.Analysis.Solar.IsNewAnalysisEnabled

(

)

IsNewAnalysisEnabled Parameters: In: Out: bool.

Returns

{...}

json FormIt.Analysis.Solar.ResetAnalysis

(

)

Reset the analysis.

Clears face selection also. Parameters: In: Out: bSuccess

Returns

bSuccess

json FormIt.Analysis.Solar.SetMethod

(

bMonthlyPeak

)

Sets the analysis method to monthly peak or yearly cumulative.

Parameters: In: bMonthlyPeak Out: bSuccess

Parameters

[in]

bMonthlyPeak

bool

Returns

bSuccess

json FormIt.Analysis.Solar.SetNumTooltipsToShow

(

numToolTips

)

SetNumTooltipsToShow Parameters: In: Out: JSON_UNDEFINED.

Parameters

[in]

numToolTips

unsigned int

Returns

JSON_UNDEFINED, i.e. {}

json FormIt.Analysis.Solar.SetPeakMonth

(

month

)

Sets the month for the monthly peak analysis method.

Parameters: In: nMonth Out: bSuccess

Parameters

[in]

month

int

Returns

bSuccess

json FormIt.Analysis.Solar.SetWeatherDataStatus

(

status

)

SetWeatherDataStatus Parameters: In: status of weather data Out:

Parameters

[in]

status

FormIt.Analysis.Solar.WeatherDataStatus

Returns

JSON_UNDEFINED, i.e. {}

json FormIt.Analysis.Solar.ToggleAnalysisMode

(

)

ToggleAnalysisMode Solar Analysis mode.

Parameters: In: Out: IsInSolarAnalysisMode

Returns

bSuccess

json FormIt.Analysis.Solar.ToggleFaceSelections

(

aFacePaths

)

Toggle the face selection with the given faces.

Parameters: In: vector of GroupInstancePath containing faces Out: bSuccess

Parameters

[in]

aFacePaths

WSM.Utils.HistoryObjects

Returns

bSuccess