Skip to content

BH.oM.LadybugTools.CompareEPWKeyPlotCommand

Class structure

Implemented interfaces and base types

The CompareEPWKeyPlotCommand is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
EPWFile FileSettings The EPW file that acts as the base for comparisons. -
EPWKey EPWKey Key (e.g. Dry Bulb Temperature) to compare. -
EPWCompareFiles List<FileSettings> The list of EPW files to be compared with the base file (or each other). -
PlotTimeseries bool Whether to plot a time series chart. If set to false, plots data as a histogram instead. -
OutputLocation string The location to place the image file once complete. -

Code and Schema

C# implementation

C#
public class CompareEPWKeyPlotCommand : 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/CompareEPWKeyPlotCommand.json"
}

The JSON Schema is available on github here: