Skip to content

Commit ef4a1b8

Browse files
github-actions[bot]github-actions[bot]
committed
APIGenerator workflow results - 2025-09-14 01:35:54
1 parent 24e2fea commit ef4a1b8

19 files changed

Lines changed: 594 additions & 4 deletions

‎docs/oM/Analytical/LifeCycleAssessment/Configs/GlobalEmissionFactors.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: GlobalEmissionFactors
3+
---
4+
5+
# <small>BH.oM.LifeCycleAssessment.Configs.</small>**GlobalEmissionFactors**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The GlobalEmissionFactors is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Base.[BHoMObject](/api/oM/Framework/Base/BHoMObject)
16+
- BH.oM.Base.[IBHoMObject](/api/oM/Framework/Base/Interface/IBHoMObject)
17+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject)
18+
- BH.oM.LifeCycleAssessment.Configs.[IEvaluationConfig](/api/oM/Analytical/LifeCycleAssessment/Configs/IEvaluationConfig)
19+
20+
21+
## Properties
22+
23+
24+
25+
### Defining properties
26+
27+
The following properties are defined on the class
28+
29+
| Name | Type | Description | Quantity |
30+
|------------------|------------------|------------------|------------------|
31+
| PreConstructionDemolition | [PreConstructionDemolition](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/Construction/PreConstructionDemolition) | The demolition activities associated with the pre-construction process, which will increase the emissions associated with the construction phase of the building lifecycle. The impact on the final element will be scaled according to its part of the total mass of the building. | - |
32+
| ConstructionActivities | [ConstructionActivities](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/Construction/ConstructionActivities) | The construction activities associated with the construction process, which will increase the emissions associated with the construction phase of the building lifecycle. The impact on the final element will be scaled according to its part of the total mass of the building. | - |
33+
| TotalBuildingMass | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | The total mass of the building. When evaluating an element, its part impact for pre-construction demolition as well as site activities will be scaled by this factor. | [Mass](/api/oM/Dimensional/Quantities/Attributes/Mass) [kg] |
34+
| StructuresOnlyMass | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Boolean that indicates if the provided mass is only the mass of the structure (true) or the total mass of the building including non-structural elements (false). This is relevant for scaling the pre-construction demolition and construction activities emissions which are provided per unit area. | - |
35+
36+
37+
### Inherited properties
38+
The following properties are inherited from the base class of the object
39+
40+
| Name | Type | Description | Quantity |
41+
|------------------|------------------|------------------|------------------|
42+
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
43+
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
44+
| Fragments | [FragmentSet](/api/oM/Framework/Base/FragmentSet) | - | - |
45+
| Tags | [HashSet](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.HashSet-1?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | - | - |
46+
| CustomData | [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0), [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | - | - |
47+
48+
49+
## Code and Schema
50+
51+
### C# implementation
52+
53+
``` C# title="C#"
54+
public class GlobalEmissionFactors : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.LifeCycleAssessment.Configs.IEvaluationConfig
55+
```
56+
57+
Assembly: LifeCycleAssessment_oM.dll
58+
59+
The C# class definition is available on github:
60+
61+
- [GlobalEmissionFactors.cs](https://github.com/BHoM/BHoM/blob/develop/LifeCycleAssessment_oM/Configs\GlobalEmissionFactors.cs)
62+
63+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Analytical/LifeCycleAssessment/Configs/IEvaluationConfig.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Base interface for evaluation configs controling how metrics should be evaluated
2020

2121
???+ bhom "The following classes are implementing this interface:"
2222

23+
- BH.oM.LifeCycleAssessment.Configs.[GlobalEmissionFactors](/api/oM/Analytical/LifeCycleAssessment/Configs/GlobalEmissionFactors)
2324
- BH.oM.LifeCycleAssessment.Configs.[IStructEEvaluationConfig](/api/oM/Analytical/LifeCycleAssessment/Configs/IStructEEvaluationConfig)
2425

2526

‎docs/oM/Analytical/LifeCycleAssessment/MaterialFragments/CombinedLifeCycleAssessmentFactors.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ The following properties are defined on the class
3232
|------------------|------------------|------------------|------------------|
3333
| EnvironmentalProductDeclaration | [EnvironmentalProductDeclaration](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/EnvironmentalProductDeclaration) | THe Environmental Product Declaration as the basis for the life cycle assessment. Commnly outlines the metrics for A1-A3 modules, but might contain metrics beyond those modules. | - |
3434
| A4TransportFactors | [ITransportFactors](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/Transport/ITransportFactors) | Factors for computing the emissions relating to Module A4 which captures the impacts associated with the transportation of the materials and components from the factory gate to and from the project site. | - |
35+
| A5_3ConstructionWasteEmissions | [ConstructionWasteEmissions](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/Construction/ConstructionWasteEmissions) | Factors for computing the emissions relating to the Construction and instalation process (A5). | - |
3536
| C2TransportFactors | [ITransportFactors](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/Transport/ITransportFactors) | Factors for computing the emissions relating to Module C2. Module C2 Transport impacts consists of any carbon impacts associated with the transportation of material from deconstruction and demolition to the appropriate final location, including any interim stations. | - |
37+
| C3C4WasteAndDisposalFactors | [WasteAndDisposalFactors](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/EndOfLife/WasteAndDisposalFactors) | Factors for computing the emissions relating to Module C3 (waste processing) and C4 (disposal). WasteAndDisposalFactors defines the end of life waste processing and disposal factors to be applied to the material fragment. These factors are applied in addition to any end of life factors provided by an Environmental Product Declaration, and can be used to fill gaps where no EPD data is available. If applied this will help populate all Climate change metrics available, with LandUseFactor being set to 0. | - |
3638

3739

3840
### Inherited properties

‎docs/oM/Analytical/LifeCycleAssessment/MaterialFragments/Construction/ConstructionActivities.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: ConstructionActivities
3+
---
4+
5+
# <small>BH.oM.LifeCycleAssessment.MaterialFragments.Construction.</small>**ConstructionActivities**
6+
7+
A class defining the environmental impacts associated with the construction activities of a building.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The ConstructionActivities is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Base.[BHoMObject](/api/oM/Framework/Base/BHoMObject)
16+
- BH.oM.Base.[IBHoMObject](/api/oM/Framework/Base/Interface/IBHoMObject)
17+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject)
18+
19+
20+
## Properties
21+
22+
23+
24+
### Defining properties
25+
26+
The following properties are defined on the class
27+
28+
| Name | Type | Description | Quantity |
29+
|------------------|------------------|------------------|------------------|
30+
| EnvironmentalFactors | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[IEnvironmentalFactor](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/EnvironmentalFactors/IEnvironmentalFactor)&gt; | List of environmental factors associated with the construction process. The default values are indicative only and should be replaced with project specific data where available. All factors stated per unit area. | - |
31+
| ConstructedFloorArea | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | The total gross internal area (GIA) of the constructed building. This is used to scale the environmental factors above. | [Area](/api/oM/Dimensional/Quantities/Attributes/Area) [m²] |
32+
33+
34+
### Inherited properties
35+
The following properties are inherited from the base class of the object
36+
37+
| Name | Type | Description | Quantity |
38+
|------------------|------------------|------------------|------------------|
39+
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
40+
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
41+
| Fragments | [FragmentSet](/api/oM/Framework/Base/FragmentSet) | - | - |
42+
| Tags | [HashSet](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.HashSet-1?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | - | - |
43+
| CustomData | [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0), [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | - | - |
44+
45+
46+
## Code and Schema
47+
48+
### C# implementation
49+
50+
``` C# title="C#"
51+
public class ConstructionActivities : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject
52+
```
53+
54+
Assembly: LifeCycleAssessment_oM.dll
55+
56+
The C# class definition is available on github:
57+
58+
- [ConstructionActivities.cs](https://github.com/BHoM/BHoM/blob/develop/LifeCycleAssessment_oM/MaterialFragments\Construction\ConstructionActivities.cs)
59+
60+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Analytical/LifeCycleAssessment/MaterialFragments/Construction/ConstructionWasteEmissions.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: ConstructionWasteEmissions
3+
---
4+
5+
# <small>BH.oM.LifeCycleAssessment.MaterialFragments.Construction.</small>**ConstructionWasteEmissions**
6+
7+
Production, transportation, storage and end-of-life treatment and disposal of any material/waste on-site: transport, waste management and disposal of packaging materials.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The ConstructionWasteEmissions is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Base.[BHoMObject](/api/oM/Framework/Base/BHoMObject)
16+
- BH.oM.Base.[IBHoMObject](/api/oM/Framework/Base/Interface/IBHoMObject)
17+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject)
18+
19+
20+
## Properties
21+
22+
23+
24+
### Defining properties
25+
26+
The following properties are defined on the class
27+
28+
| Name | Type | Description | Quantity |
29+
|------------------|------------------|------------------|------------------|
30+
| WasteRate | [WasteRate](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/Construction/WasteRate) | The waste rate associated with the construction process. This factor is used to compute A5.3 emissions based on outputs for A1 to A4 and C2 to C4 available from either EPD and/or transport as well as disposal factors.<br>This value should be the percentage of material brought to site that goes to waste. This is turned into a waste factor to allow for evaluating based on quantities of the built asset. | - |
31+
| ResuedOnSite | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Whether the material is reused on site, which would reduce the emissions associated with transport and processing. Controls whether the C2 factor for the material should be included or not when computing the emissions based on the A5.3 (waste) factor. Defaults to false, meaning the C2 factor is included. | - |
32+
33+
34+
### Inherited properties
35+
The following properties are inherited from the base class of the object
36+
37+
| Name | Type | Description | Quantity |
38+
|------------------|------------------|------------------|------------------|
39+
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
40+
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
41+
| Fragments | [FragmentSet](/api/oM/Framework/Base/FragmentSet) | - | - |
42+
| Tags | [HashSet](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.HashSet-1?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | - | - |
43+
| CustomData | [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0), [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | - | - |
44+
45+
46+
## Code and Schema
47+
48+
### C# implementation
49+
50+
``` C# title="C#"
51+
public class ConstructionWasteEmissions : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject
52+
```
53+
54+
Assembly: LifeCycleAssessment_oM.dll
55+
56+
The C# class definition is available on github:
57+
58+
- [ConstructionWasteEmissions.cs](https://github.com/BHoM/BHoM/blob/develop/LifeCycleAssessment_oM/MaterialFragments\Construction\ConstructionWasteEmissions.cs)
59+
60+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Analytical/LifeCycleAssessment/MaterialFragments/Construction/PreConstructionDemolition.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: PreConstructionDemolition
3+
---
4+
5+
# <small>BH.oM.LifeCycleAssessment.MaterialFragments.Construction.</small>**PreConstructionDemolition**
6+
7+
A class defining the environmental impacts associated with the demolition of existing buildings prior to construction of a new building.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The PreConstructionDemolition is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Base.[BHoMObject](/api/oM/Framework/Base/BHoMObject)
16+
- BH.oM.Base.[IBHoMObject](/api/oM/Framework/Base/Interface/IBHoMObject)
17+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject)
18+
19+
20+
## Properties
21+
22+
23+
24+
### Defining properties
25+
26+
The following properties are defined on the class
27+
28+
| Name | Type | Description | Quantity |
29+
|------------------|------------------|------------------|------------------|
30+
| EnvironmentalFactors | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[IEnvironmentalFactor](/api/oM/Analytical/LifeCycleAssessment/MaterialFragments/EnvironmentalFactors/IEnvironmentalFactor)&gt; | List of environmental factors associated with the demolition process. The default values are indicative only and should be replaced with project specific data where available. All factors stated per unit area. | - |
31+
| DemolishedFloorArea | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | The area of floor that is demolished prior to construction of the new building. This is used to scale the environmental factors above. | [Area](/api/oM/Dimensional/Quantities/Attributes/Area) [m²] |
32+
33+
34+
### Inherited properties
35+
The following properties are inherited from the base class of the object
36+
37+
| Name | Type | Description | Quantity |
38+
|------------------|------------------|------------------|------------------|
39+
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
40+
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
41+
| Fragments | [FragmentSet](/api/oM/Framework/Base/FragmentSet) | - | - |
42+
| Tags | [HashSet](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.HashSet-1?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | - | - |
43+
| CustomData | [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0), [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | - | - |
44+
45+
46+
## Code and Schema
47+
48+
### C# implementation
49+
50+
``` C# title="C#"
51+
public class PreConstructionDemolition : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject
52+
```
53+
54+
Assembly: LifeCycleAssessment_oM.dll
55+
56+
The C# class definition is available on github:
57+
58+
- [PreConstructionDemolition.cs](https://github.com/BHoM/BHoM/blob/develop/LifeCycleAssessment_oM/MaterialFragments\Construction\PreConstructionDemolition.cs)
59+
60+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Analytical/LifeCycleAssessment/MaterialFragments/Construction/WasteRate.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: WasteRate
3+
---
4+
5+
# <small>BH.oM.LifeCycleAssessment.MaterialFragments.Construction.</small>**WasteRate**
6+
7+
A class defining the waste rate associated with a construction material.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The WasteRate is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Base.[BHoMObject](/api/oM/Framework/Base/BHoMObject)
16+
- BH.oM.Base.[IBHoMObject](/api/oM/Framework/Base/Interface/IBHoMObject)
17+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject)
18+
19+
20+
## Properties
21+
22+
23+
24+
### Defining properties
25+
26+
The following properties are defined on the class
27+
28+
| Name | Type | Description | Quantity |
29+
|------------------|------------------|------------------|------------------|
30+
| Rate | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | The percentage of waste expected during construction, expressed as a value between 0 and 1. | - |
31+
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | The name of the material to which the waste rate applies. | - |
32+
33+
34+
### Inherited properties
35+
The following properties are inherited from the base class of the object
36+
37+
| Name | Type | Description | Quantity |
38+
|------------------|------------------|------------------|------------------|
39+
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
40+
| Fragments | [FragmentSet](/api/oM/Framework/Base/FragmentSet) | - | - |
41+
| Tags | [HashSet](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.HashSet-1?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | - | - |
42+
| CustomData | [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0), [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | - | - |
43+
44+
45+
## Code and Schema
46+
47+
### C# implementation
48+
49+
``` C# title="C#"
50+
public class WasteRate : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject
51+
```
52+
53+
Assembly: LifeCycleAssessment_oM.dll
54+
55+
The C# class definition is available on github:
56+
57+
- [WasteRate.cs](https://github.com/BHoM/BHoM/blob/develop/LifeCycleAssessment_oM/MaterialFragments\Construction\WasteRate.cs)
58+
59+
All history and changes of the class can be found by inspection the history.

0 commit comments

Comments
 (0)