Skip to content

BH.oM.LadybugTools.CollectionData

Class structure

Implemented interfaces and base types

The CollectionData 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
HighestValue double The maximum value in the collection. -
LowestValue double The minimum value in the collection. -
HighestIndex DateTime The date and time at which the maximum value occurs. -
LowestIndex DateTime The date and time at which the minimum value occurs. -
MedianValue double The median (50 percentile) value in the collection. -
MeanValue double The mean value of the collection. -
MonthlyMeans List<double> The mean values for each month. -

Code and Schema

C# implementation

C#
public class CollectionData : BH.oM.LadybugTools.ISimulationData, 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/CollectionData.json"
}

The JSON Schema is available on github here: