FormIt.Analysis.Solar API

Description

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

Function Documentation

Analyze()

json FormIt.Analysis.Solar.Analyze

(

)

CanAnalyze()

json FormIt.Analysis.Solar.CanAnalyze

(

)

CanAnalyze Parameters: In: Out: bool

Returns

{...}

CancelAnalysis()

json FormIt.Analysis.Solar.CancelAnalysis

(

)

Cancel the analysis.

Parameters: In: Out: JSON_UNDEFINED

Returns

JSON_UNDEFINED, i.e. {}

EnterAnalysisMode()

json FormIt.Analysis.Solar.EnterAnalysisMode

(

)

Start Solar Analysis mode.

Parameters: In: Out: bSuccess

Returns

bSuccess

ExitAnalysisMode()

json FormIt.Analysis.Solar.ExitAnalysisMode

(

)

End Solar Analysis mode.

Parameters: In: Out: bSuccess

Returns

bSuccess

GetLimits()

json FormIt.Analysis.Solar.GetLimits

(

)

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

Returns

{ "success" , false };

GetMethod()

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

GetNumTooltipsToShow()

json FormIt.Analysis.Solar.GetNumTooltipsToShow

(

)

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

Returns

{...}

GetPeakMonth()

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)} };

GetUnitString()

json FormIt.Analysis.Solar.GetUnitString

(

)

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

Returns

{ "success" , false };

GetValueFromFaceAtPoint()

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)} };

GetWeatherDataStatus()

json FormIt.Analysis.Solar.GetWeatherDataStatus

(

)

GetWeatherDataStatus Parameters: In: Out: status of weather data

Returns

{...}

IsAnalysisInProgress()

json FormIt.Analysis.Solar.IsAnalysisInProgress

(

)

IsAnalysisInProgress Parameters: In: Out: bool

Returns

{...}

IsInSolarAnalysisMode()

json FormIt.Analysis.Solar.IsInSolarAnalysisMode

(

)

IsInSolarAnalysisMode Parameters: In: Out: bool IsInSolarAnalysisMode

Returns

{...}

IsNewAnalysisEnabled()

json FormIt.Analysis.Solar.IsNewAnalysisEnabled

(

)

IsNewAnalysisEnabled Parameters: In: Out: bool

Returns

{...}

ResetAnalysis()

json FormIt.Analysis.Solar.ResetAnalysis

(

)

Reset the analysis.

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

Returns

bSuccess

SetMethod()

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

SetNumTooltipsToShow()

json FormIt.Analysis.Solar.SetNumTooltipsToShow

(

numToolTips

)

SetNumTooltipsToShow Parameters: In: Out: JSON_UNDEFINED

Parameters

[in]

numToolTips

unsigned int

Returns

JSON_UNDEFINED, i.e. {}

SetPeakMonth()

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

SetWeatherDataStatus()

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. {}

ToggleAnalysisMode()

json FormIt.Analysis.Solar.ToggleAnalysisMode

(

)

ToggleAnalysisMode Solar Analysis mode.

Parameters: In: Out: IsInSolarAnalysisMode

Returns

bSuccess

ToggleFaceSelections()

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