Skip to content

Commit ea2c687

Browse files
authored
Merge pull request #14 from BHoM/automatic-api-updates
API Updates
2 parents 450d146 + 8366b31 commit ea2c687

File tree

60 files changed

+131
-55
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+131
-55
lines changed
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Tower
3+
---
4+
5+
# <small>BH.oM.Adapters.ETABS.Fragments.</small>**Tower**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The Tower 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.Base.[IFragment](/api/oM/Framework/Base/Interface/IFragment)
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+
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Name of the Tower the element belongs to. | - |
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 Tower : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Base.IFragment
51+
```
52+
53+
Assembly: ETABS_oM.dll
54+
55+
The C# class definition is available on github:
56+
57+
- [Tower.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Fragments\Tower.cs)
58+
59+
All history and changes of the class can be found by inspection the history.
60+
### JSON Schema implementation
61+
62+
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](https://www.jsonschemavalidator.net/).
63+
64+
``` json title="JSON Schema"
65+
{
66+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/ETABS_oM/Fragments/Tower.json"
67+
}
68+
```
69+
70+
The JSON Schema is available on github here:
71+
72+
- [Tower.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/ETABS_oM/Fragments/Tower.json)

docs/oM/Analytical/LifeCycleAssessment/Enums/Module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ title: Module
3939
| B7_1 | Module B7.1 Water used by integrated systems consists of Water for sanitation, cooking and drinking; irrigation of associated landscape areas, green roofs and walls; and heating, cooling, ventilation and humidification systems. |
4040
| B7_2 | Module B7.2 Water used by other integrated systems consists of water used by fountains, swimming pools and saunas. |
4141
| B7_3 | Module B7.3 Water used by non-integrated systems consists of water used for dishwashers, washing machines and washing cars. |
42-
| B8 | Module B8 User activities in buildings covers impacts associated with user activities taking place during the operation of buildings that are not covered by B1-B7. There are 3 sub-modules to B8 including: B8.1 Energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional), B8.2 Energy-related impacts associated with building user charging of electric vehicles on-site (optional), and B8.3 Other energy related impacts associated with building user activities relating to the buildings intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). |
42+
| B8 | Module B8 User activities in buildings covers impacts associated with user activities taking place during the operation of buildings that are not covered by B1-B7. There are 3 sub-modules to B8 including: B8.1 Energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional), B8.2 Energy-related impacts associated with building user charging of electric vehicles on-site (optional), and B8.3 Other energy related impacts associated with building user activities relating to the buildings intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). |
4343
| B8_1 | Module B8.1 consists of energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional). |
4444
| B8_2 | Module B8.2 consists of energy-related impacts associated with building user charging of electric vehicles on-site (optional). |
4545
| B8_3 | Module B8.3 consists of other energy related impacts associated with building user activities relating to the building's intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). |

docs/oM/Analytical/LifeCycleAssessment/MaterialFragments/EnvironmentalMetrics/AbioticDepletionFossilResourcesMetric.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The following properties are optional and can be included on a object definition
7171
| B7_1 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.1 Water used by integrated systems consists of Water for sanitation, cooking and drinking; irrigation of associated landscape areas, green roofs and walls; and heating, cooling, ventilation and humidification systems. | [EnergyPerQuantity](/api/oM/Dimensional/Quantities/Attributes/EnergyPerQuantity) [J per unit] |
7272
| B7_2 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.2 Water used by other integrated systems consists of water used by fountains, swimming pools and saunas. | [EnergyPerQuantity](/api/oM/Dimensional/Quantities/Attributes/EnergyPerQuantity) [J per unit] |
7373
| B7_3 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.3 Water used by non-integrated systems consists of water used for dishwashers, washing machines and washing cars. | [EnergyPerQuantity](/api/oM/Dimensional/Quantities/Attributes/EnergyPerQuantity) [J per unit] |
74-
| B8 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8 User activities in buildings covers impacts associated with user activities taking place during the operation of buildings that are not covered by B1-B7. There are 3 sub-modules to B8 including: B8.1 Energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional), B8.2 Energy-related impacts associated with building user charging of electric vehicles on-site (optional), and B8.3 Other energy related impacts associated with building user activities relating to the buildings intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [EnergyPerQuantity](/api/oM/Dimensional/Quantities/Attributes/EnergyPerQuantity) [J per unit] |
74+
| B8 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8 User activities in buildings covers impacts associated with user activities taking place during the operation of buildings that are not covered by B1-B7. There are 3 sub-modules to B8 including: B8.1 Energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional), B8.2 Energy-related impacts associated with building user charging of electric vehicles on-site (optional), and B8.3 Other energy related impacts associated with building user activities relating to the buildings intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [EnergyPerQuantity](/api/oM/Dimensional/Quantities/Attributes/EnergyPerQuantity) [J per unit] |
7575
| B8_1 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.1 consists of energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional). | [EnergyPerQuantity](/api/oM/Dimensional/Quantities/Attributes/EnergyPerQuantity) [J per unit] |
7676
| B8_2 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.2 consists of energy-related impacts associated with building user charging of electric vehicles on-site (optional). | [EnergyPerQuantity](/api/oM/Dimensional/Quantities/Attributes/EnergyPerQuantity) [J per unit] |
7777
| B8_3 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.3 consists of other energy related impacts associated with building user activities relating to the building's intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [EnergyPerQuantity](/api/oM/Dimensional/Quantities/Attributes/EnergyPerQuantity) [J per unit] |

docs/oM/Analytical/LifeCycleAssessment/MaterialFragments/EnvironmentalMetrics/AbioticDepletionMineralsAndMetalsMetric.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The following properties are optional and can be included on a object definition
7171
| B7_1 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.1 Water used by integrated systems consists of Water for sanitation, cooking and drinking; irrigation of associated landscape areas, green roofs and walls; and heating, cooling, ventilation and humidification systems. | [AbioticDepletionMineralsAndMetalsPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AbioticDepletionMineralsAndMetalsPerQuantity) [kg Sb eq per unit] |
7272
| B7_2 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.2 Water used by other integrated systems consists of water used by fountains, swimming pools and saunas. | [AbioticDepletionMineralsAndMetalsPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AbioticDepletionMineralsAndMetalsPerQuantity) [kg Sb eq per unit] |
7373
| B7_3 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.3 Water used by non-integrated systems consists of water used for dishwashers, washing machines and washing cars. | [AbioticDepletionMineralsAndMetalsPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AbioticDepletionMineralsAndMetalsPerQuantity) [kg Sb eq per unit] |
74-
| B8 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8 User activities in buildings covers impacts associated with user activities taking place during the operation of buildings that are not covered by B1-B7. There are 3 sub-modules to B8 including: B8.1 Energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional), B8.2 Energy-related impacts associated with building user charging of electric vehicles on-site (optional), and B8.3 Other energy related impacts associated with building user activities relating to the buildings intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [AbioticDepletionMineralsAndMetalsPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AbioticDepletionMineralsAndMetalsPerQuantity) [kg Sb eq per unit] |
74+
| B8 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8 User activities in buildings covers impacts associated with user activities taking place during the operation of buildings that are not covered by B1-B7. There are 3 sub-modules to B8 including: B8.1 Energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional), B8.2 Energy-related impacts associated with building user charging of electric vehicles on-site (optional), and B8.3 Other energy related impacts associated with building user activities relating to the buildings intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [AbioticDepletionMineralsAndMetalsPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AbioticDepletionMineralsAndMetalsPerQuantity) [kg Sb eq per unit] |
7575
| B8_1 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.1 consists of energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional). | [AbioticDepletionMineralsAndMetalsPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AbioticDepletionMineralsAndMetalsPerQuantity) [kg Sb eq per unit] |
7676
| B8_2 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.2 consists of energy-related impacts associated with building user charging of electric vehicles on-site (optional). | [AbioticDepletionMineralsAndMetalsPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AbioticDepletionMineralsAndMetalsPerQuantity) [kg Sb eq per unit] |
7777
| B8_3 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.3 consists of other energy related impacts associated with building user activities relating to the building's intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [AbioticDepletionMineralsAndMetalsPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AbioticDepletionMineralsAndMetalsPerQuantity) [kg Sb eq per unit] |

docs/oM/Analytical/LifeCycleAssessment/MaterialFragments/EnvironmentalMetrics/AcidificationMetric.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The following properties are optional and can be included on a object definition
7171
| B7_1 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.1 Water used by integrated systems consists of Water for sanitation, cooking and drinking; irrigation of associated landscape areas, green roofs and walls; and heating, cooling, ventilation and humidification systems. | [AcidificationPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AcidificationPerQuantity) [mol H+ eq per unit] |
7272
| B7_2 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.2 Water used by other integrated systems consists of water used by fountains, swimming pools and saunas. | [AcidificationPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AcidificationPerQuantity) [mol H+ eq per unit] |
7373
| B7_3 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B7.3 Water used by non-integrated systems consists of water used for dishwashers, washing machines and washing cars. | [AcidificationPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AcidificationPerQuantity) [mol H+ eq per unit] |
74-
| B8 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8 User activities in buildings covers impacts associated with user activities taking place during the operation of buildings that are not covered by B1-B7. There are 3 sub-modules to B8 including: B8.1 Energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional), B8.2 Energy-related impacts associated with building user charging of electric vehicles on-site (optional), and B8.3 Other energy related impacts associated with building user activities relating to the buildings intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [AcidificationPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AcidificationPerQuantity) [mol H+ eq per unit] |
74+
| B8 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8 User activities in buildings covers impacts associated with user activities taking place during the operation of buildings that are not covered by B1-B7. There are 3 sub-modules to B8 including: B8.1 Energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional), B8.2 Energy-related impacts associated with building user charging of electric vehicles on-site (optional), and B8.3 Other energy related impacts associated with building user activities relating to the buildings intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [AcidificationPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AcidificationPerQuantity) [mol H+ eq per unit] |
7575
| B8_1 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.1 consists of energy-related impacts associated with building user mobility/ transport not covered in B6, such as user mobility/ commuting to a building (optional). | [AcidificationPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AcidificationPerQuantity) [mol H+ eq per unit] |
7676
| B8_2 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.2 consists of energy-related impacts associated with building user charging of electric vehicles on-site (optional). | [AcidificationPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AcidificationPerQuantity) [mol H+ eq per unit] |
7777
| B8_3 | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Module B8.3 consists of other energy related impacts associated with building user activities relating to the building's intended use, such as upstream embodied impacts of consumables used in the building, e.g. stationery and printing paper for an office (optional). | [AcidificationPerQuantity](/api/oM/Dimensional/Quantities/Attributes/AcidificationPerQuantity) [mol H+ eq per unit] |

0 commit comments

Comments
 (0)