Skip to content

BH.oM.LadybugTools.DiurnalPlotCommand

Use in conjunction with the LadybugToolsAdapter to run a diurnal analysis on a specific key of an epw file, and output a plot.

Class structure

Implemented interfaces and base types

The DiurnalPlotCommand 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 to analyse. -
EPWKey EPWKey The key in the EPW file to analyse. -
Colour Color The colour of the average line on the plot. -
OutputLocation string The directory to output the file. Leave empty to return a base64 string representation of that image. -
Title string Title of the plot, will appear above any information on the top of the plot. -
Period DiurnalPeriod The diurnal period to analyse. Daily for 365 samples/timestep, weekly for 52, monthly for 30. -

Code and Schema

C# implementation

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

The JSON Schema is available on github here: