Skip to content

BH.oM.LadybugTools.AnalysisPeriod

Class structure

Implemented interfaces and base types

The AnalysisPeriod 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
StartMonth int The start month. -
StartDay int The start day. -
StartHour int The start hour. -
EndMonth int The end month. -
EndDay int The end day. -
EndHour int The end hour. -
IsLeapYear bool Boolean flag for whether this represents a leap year. -
TimeStep int The number of timesteps per hour. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
BHoM_Guid Guid - -
Name string - -
Fragments FragmentSet - -
Tags HashSet<string> - -
CustomData Dictionary<string, object> - -

Code and Schema

C# implementation

C#
public class AnalysisPeriod : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.LadybugTools.ILadybugTools

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/AnalysisPeriod.json"
}

The JSON Schema is available on github here: