|
| 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)<[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)> | - | - | |
| 42 | +| CustomData | [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2?view=netstandard-2.0)<[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)> | - | - | |
| 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) |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments