|
| 1 | +--- |
| 2 | +title: CompareEPWKeyPlotCommand |
| 3 | +--- |
| 4 | + |
| 5 | +# <small>BH.oM.LadybugTools.</small>**CompareEPWKeyPlotCommand** |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +## Class structure |
| 10 | + |
| 11 | +### Implemented interfaces and base types |
| 12 | + |
| 13 | +???+ bhom "The CompareEPWKeyPlotCommand is inheriting from the following base type(s) and implements the following interfaces:" |
| 14 | + |
| 15 | + - BH.oM.LadybugTools.[ISimulationCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/ISimulationCommand) |
| 16 | + - BH.oM.Adapter.[IExecuteCommand](/api/oM/Framework/Adapter/ExecuteCommands/_IExecuteCommand) |
| 17 | + - BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject) |
| 18 | + |
| 19 | + |
| 20 | +## Properties |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | +### Defining properties |
| 25 | + |
| 26 | +The following properties are defined on the class |
| 27 | + |
| 28 | +| Name | Type | Description | Quantity | |
| 29 | +|------------------|------------------|------------------|------------------| |
| 30 | +| EPWFile | [FileSettings](/api/oM/Framework/Adapter/FileSettings) | The EPW file that acts as the base for comparisons. | - | |
| 31 | +| EPWKey | [EPWKey](/api/oM/Adapter/LadybugTools/Enum/EPWKeys) | Key (e.g. Dry Bulb Temperature) to compare. | - | |
| 32 | +| EPWCompareFiles | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[FileSettings](/api/oM/Framework/Adapter/FileSettings)> | The list of EPW files to be compared with the base file (or each other). | - | |
| 33 | +| PlotTimeseries | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Whether to plot a time series chart. If set to false, plots data as a histogram instead. | - | |
| 34 | +| OutputLocation | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | The location to place the image file once complete. | - | |
| 35 | + |
| 36 | + |
| 37 | +## Code and Schema |
| 38 | + |
| 39 | +### C# implementation |
| 40 | + |
| 41 | +``` C# title="C#" |
| 42 | +public class CompareEPWKeyPlotCommand : BH.oM.LadybugTools.ISimulationCommand, BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject |
| 43 | +``` |
| 44 | + |
| 45 | +Assembly: LadybugTools_oM.dll |
| 46 | + |
| 47 | +The C# class definition is available on github: |
| 48 | + |
| 49 | +- [CompareEPWKeyPlotCommand.cs](https://github.com/BHoM/LadybugTools_Toolkit/blob/develop/LadybugTools_oM/ExecuteCommands\CompareEPWKeyPlotCommand.cs) |
| 50 | + |
| 51 | +All history and changes of the class can be found by inspection the history. |
0 commit comments