BH.oM.LadybugTools.RunExternalComfortCommand¶
Command that when executed with the LadybugTools Adapter, runs an External Comfort simulation and returns an ExternalComfort object containing results.
Class structure¶
Implemented interfaces and base types¶
The RunExternalComfortCommand 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. | - |
SimulationResult | SimulationResult | A SimulationResult object generated by the RunSimulation Execute command. | - |
Typology | Typology | A Typology object. | - |
Code and Schema¶
C# implementation¶
C#
public class RunExternalComfortCommand : 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/RunExternalComfortCommand.json"
}
The JSON Schema is available on github here: