BH.oM.LadybugTools.SimulationResult¶
Class structure¶
Implemented interfaces and base types¶
The SimulationResult is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.LadybugTools.ILadybugTools
- BH.oM.Base.IImmutable
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| EpwFile | FileSettings | The EPW file associated with this object. | - |
| GroundMaterial | IEnergyMaterialOpaque | The ground material used in the processing of this object. | - |
| ShadeMaterial | IEnergyMaterialOpaque | The shade material used in the processing of this object. | - |
| Name | string | The identifier used to distinguish existing results for this object. | - |
| ShadedDownTemperature | HourlyContinuousCollection | The Shaded Down Temperature used in the processing of this object | - |
| ShadedUpTemperature | HourlyContinuousCollection | The Shaded Up Temperature used in the processing of this object | - |
| ShadedRadiantTemperature | HourlyContinuousCollection | The Shaded Radiant Temperature used in the processing of this object | - |
| ShadedLongwaveMeanRadiantTemperatureDelta | HourlyContinuousCollection | The Shaded Longwave Mean Radiant Temperature Delta used in the processing of this object | - |
| ShadedShortwaveMeanRadiantTemperatureDelta | HourlyContinuousCollection | The Shaded Shortwave Mean Radiant Temperature Delta used in the processing of this object | - |
| ShadedMeanRadiantTemperature | HourlyContinuousCollection | The Shaded Mean Radiant Temperature used in the processing of this object | - |
| UnshadedDownTemperature | HourlyContinuousCollection | The Unshaded Down Temperature used in the processing of this object | - |
| UnshadedUpTemperature | HourlyContinuousCollection | The Unshaded Up Temperature used in the processing of this object | - |
| UnshadedRadiantTemperature | HourlyContinuousCollection | The Unshaded Radiant Temperature used in the processing of this object | - |
| UnshadedLongwaveMeanRadiantTemperatureDelta | HourlyContinuousCollection | The Unshaded Longwave Mean Radiant Temperature Delta used in the processing of this object | - |
| UnshadedShortwaveMeanRadiantTemperatureDelta | HourlyContinuousCollection | The Unshaded Shortwave Mean Radiant Temperature Delta used in the processing of this object | - |
| UnshadedMeanRadiantTemperature | HourlyContinuousCollection | The Unshaded Mean Radiant Temperature used in the processing of this object | - |
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 SimulationResult : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.LadybugTools.ILadybugTools, BH.oM.Base.IImmutable
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/SimulationResult.json"
}
The JSON Schema is available on github here: