BH.oM.LadybugTools.WalkabilityPlotCommand¶
Class structure¶
Implemented interfaces and base types¶
The WalkabilityPlotCommand 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 EPW file to use for analysis. | - |
| ExternalComfort | ExternalComfort | The external comfort object containing the UTCI data to plot. If the UTCI collection is null or empty, then a simulation will be run before plotting to get these values. | - |
| OutputLocation | string | The location to place any images generated by the command. Leave empty to return a base64 string representation of the image. | - |
Code and Schema¶
C# implementation¶
C#
public class WalkabilityPlotCommand : 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.
JSON Schema implementation¶
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.
JSON Schema
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/LadybugTools_oM/WalkabilityPlotCommand.json"
}
The JSON Schema is available on github here: