Skip to content

BH.oM.LadybugTools.Typology

Class structure

Implemented interfaces and base types

The Typology 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
Name string The name of this Typology. -
Shelters List<Shelter> The shelters for this Typology. -
EvaporativeCoolingEffect List<double> The proportion of evaporative cooling to add to this Typology. -
TargetWindSpeed List<Nullable<double>> Override for the wind speed that will ignore any shelter effects for each time step. Leave timesteps null to use the shelter affected wind speeds (default null). -
WindSpeedMultiplier double A multiplier to apply to the wind speed retrieved from the EPW file. -
RadiantTemperatureAdjustment List<double> A reduction or increase in MRT to be applied to results generated using this Typology. -

Inherited properties

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

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

Code and Schema

C# implementation

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

The JSON Schema is available on github here: