Skip to content

BH.oM.LadybugTools.SunPathPlotCommand

Command that when used in conjunction with the LadybugToolsAdapter, will plot a sun path based off of the location data in an EPW file.

Class structure

Implemented interfaces and base types

The SunPathPlotCommand 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 use for analysis. -
AnalysisPeriod AnalysisPeriod The analysis period to analyse. -
SunSize double The size of the sun on the plot. -
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 SunPathPlotCommand : 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/SunPathPlotCommand.json"
}

The JSON Schema is available on github here: