BH.oM.LadybugTools.FacadeCondensationRiskCommand¶
Command that, when executed with the LadybugToolsAdapter, simulates Condensation Risk and outputs a heatmap. Output is a string of either the path to the image (if OutputLocation is not set) or the base 64 string representation of it.
Class structure¶
Implemented interfaces and base types¶
The FacadeCondensationRiskCommand is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.LadybugTools.ISimulationCommand
- BH.oM.Adapter.IExecuteCommand
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
EPWFile | FileSettings | The path to an EPW file. | - |
Thresholds | List<double> | The list of thresholds to use. If no values are provided, default values of [10,7,4,1,-2,-5] will be used. | - |
Heatmap | bool | Set to true to return a heatmap, or set to false to return a chart and table. | - |
OutputLocation | string | Full file path (with file name) to save the plot to. Leave blank to output a base 64 string representation of the image instead. | - |
Code and Schema¶
C# implementation¶
C#
public class FacadeCondensationRiskCommand : BH.oM.LadybugTools.ISimulationCommand, BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
Assembly: LadybugTools_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.