Skip to content

Commit 0026f0d

Browse files
IsakNaslundBhIsakNaslundBh
committed
Add initial version of all classes
1 parent 38bcff1 commit 0026f0d

1,765 files changed

Lines changed: 104865 additions & 0 deletions

File tree

Some content is hidden

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

‎docs/oM/Adapter/Adapters/AGS/AGSSettings.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: AGSSettings
3+
---
4+
5+
# Adapters.AGS.AGSSettings
6+
7+
General settings for any Adapter, to be specified when instantiating the Adapter.Implement this class to make your own Toolkit settings, e.g. SpeckleAdapterSettings.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The AGSSettings in inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- Adapter.[AdapterSettings](/documentation/oM/Framework/Adapter/AdapterSettings)
16+
- Base.[IObject](/documentation/oM/Framework/Base/IObject)
17+
18+
19+
## Properties
20+
21+
22+
23+
### Defining properties
24+
25+
The following properties are defined on the class
26+
27+
| Name | Type | Description | Quantity |
28+
|------------------|------------------|------------------|------------------|
29+
| BlankGeology | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Only implemented when the BlankGeologyStrategy is set to replacement. <br>If blank geology occurs in the GEOL_GEOL columns, assign a geology to replace it e.g. Made ground. | - |
30+
| BlankGeologyStraegy | [BlankGeologyStrategy](/documentation/oM/Adapter/Adapters/AGS/BlankGeologyStrategy) | The strategy used to handle blank geology entries. | - |
31+
32+
33+
### Inherited properties
34+
The following properties are inherited from the base class of the object
35+
36+
| Name | Type | Description | Quantity |
37+
|------------------|------------------|------------------|------------------|
38+
| WrapNonBHoMObjects | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If your Toolkit needs support for non-BHoM objects, set this to true. | - |
39+
| DefaultPushType | [PushType](/documentation/oM/Framework/Adapter/PushType) | If your Toolkit does not support the Full Push (FullCRUD method), you can select another behaviour here (e.g. CreateOnly). | - |
40+
| CloneBeforePush | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Deep clones the objects before Pushing them.As the objects get modified during the Push (e.g. their externalId is added to them),this avoids backpropagation in visual programming environments like Grasshopper. | - |
41+
| DefaultPullType | [PullType](/documentation/oM/Framework/Adapter/PullType) | - | - |
42+
| HandleDependencies | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If your adapter does not define DependencyTypes, this can be set to false for performance. | - |
43+
| HandlePriorities | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |
44+
| UseAdapterId | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |
45+
| UseHashComparerAsDefault | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |
46+
| ProcessInMemory | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |
47+
| OnlyUpdateChangedObjects | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, Objects found to be the same according to the AdapterComparer for the provided type are checked for full equality using the HashComparer of the type (which by default checks every property except BHoM_Guid). If equal according to the HashComparer, they are not updated.<br>Otherwise, Objects found identical according to the AdapterComparer for the provided type are sent to the Update method. | - |
48+
| CacheCRUDobjects | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, CRUD operations will attempt read/write cache objects to speed things during a same Action. | - |
49+
| CreateOnly_DistinctObjects | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, CreateOnly method calls Distinct() on the first-level objects. | - |
50+
| CreateOnly_DistinctDependencies | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, CreateOnly method calls Distinct() on the dependency objects. | - |
51+
52+
53+
## Code and Schema
54+
55+
### C# implementation
56+
57+
The class is defined in C#. The class definition is available on github:
58+
59+
- [AGSSettings.cs](https://github.com/BHoM/AGS_Toolkit/blob/develop/AGS_oM/AGSSettings.cs)
60+
61+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/AGS/BlankGeologyStrategy.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: BlankGeologyStrategy
3+
---
4+
5+
# Adapters.AGS.BlankGeologyStrategy
6+
7+
Different approaches for the AGS_Toolkit to handle blank geology.
8+
9+
## Enum values
10+
11+
| Name | Description |
12+
|-----------------|----------------------------------------------------------------|
13+
| Replace | Replace any entries of blank geology with a specificed string. |
14+
| Description | Replace any entries of blank geology using the description attribute (GEOL_DESC) with words in CAPS. |
15+
| Legend | Replace any entries of blank geology using the legend (GEOL_LEG). |
16+
| Lexicon | Replace any entries of blank geology using the lexicon code (GEOL_BGS). |
17+
18+
19+
## Code and Schema
20+
21+
### C# implementation
22+
23+
The enum is defined in C#. The class definition is available on github:
24+
25+
- [BlankGeologyStrategy.cs](https://github.com/BHoM/AGS_Toolkit/blob/develop/AGS_oM/eNums/BlankGeologyStrategy.cs)
26+
27+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/CarbonQueryDatabase/CQDConfig.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: CQDConfig
3+
---
4+
5+
# Adapters.CarbonQueryDatabase.CQDConfig
6+
7+
This Config can be specified in the `ActionConfig` input of any Adapter Action (e.g. Push).
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The CQDConfig in inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- Adapter.[ActionConfig](/documentation/oM/Framework/Adapter/ActionConfig)
16+
- Base.[IObject](/documentation/oM/Framework/Base/IObject)
17+
18+
19+
## Properties
20+
21+
22+
23+
### Defining properties
24+
25+
The following properties are defined on the class
26+
27+
| Name | Type | Description | Quantity |
28+
|------------------|------------------|------------------|------------------|
29+
| Type | [EPDType](/documentation/oM/Analytical/LifeCycleAssessment/EPDType) | The Type of Environmental Product Declaration | - |
30+
| Id | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Specifies ID to search and return objects for in CarbonQueryDatabase. If this is specified it supersedes other input parameters. | - |
31+
| Count | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | Sets maximum amount of items to return from CarbonQueryDatabase | - |
32+
| NameLike | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Specifies string to search and return objects for in CarbonQueryDatabase, ie RedBuilt RedLam LVL | - |
33+
| PlantName | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Specifies plant name to search and return objects for in CarbonQueryDatabase, ie Dupont | - |
34+
35+
36+
### Inherited properties
37+
The following properties are inherited from the base class of the object
38+
39+
| Name | Type | Description | Quantity |
40+
|------------------|------------------|------------------|------------------|
41+
| WrapNonBHoMObjects | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, the Push action wraps any non-BHoM type into a BH.oM.Adapter.ObjectWrapper, allowing them to make use of the full Adapter workflow. | - |
42+
| AllowHashForComparing | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true and if no specific EqualityComparer is found for the type, Diffing hashes are computed and used to compare the objects. | - |
43+
| DiffingConfig | [DiffingConfig](/documentation/oM/Framework/Diffing/DiffingConfig) | Configurations for the Diffing hashing. Requires `AllowHashForComparing` to be set to true. | - |
44+
45+
46+
## Code and Schema
47+
48+
### C# implementation
49+
50+
The class is defined in C#. The class definition is available on github:
51+
52+
- [CQDConfig.cs](https://github.com/BHoM/CarbonQueryDatabase_Toolkit/blob/develop/CarbonQueryDatabase_oM/Adapter/CQDConfig.cs)
53+
54+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/ETABS/BarInsertionPoint.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: BarInsertionPoint
3+
---
4+
5+
# Adapters.ETABS.BarInsertionPoint
6+
7+
8+
9+
## Enum values
10+
11+
| Name | Description |
12+
|-----------------|----------------------------------------------------------------|
13+
| BottomLeft | - |
14+
| BottomCenter | - |
15+
| BottomRight | - |
16+
| MiddleLeft | - |
17+
| MiddleCenter | - |
18+
| MiddleRight | - |
19+
| TopLeft | - |
20+
| TopCenter | - |
21+
| TopRight | - |
22+
| Centroid | - |
23+
| ShearCenter | - |
24+
25+
26+
## Code and Schema
27+
28+
### C# implementation
29+
30+
The enum is defined in C#. The class definition is available on github:
31+
32+
- [BarInsertionPoint.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Enums/BarInsertionPoint.cs)
33+
34+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/ETABS/DatabaseSettings.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: DatabaseSettings
3+
---
4+
5+
# Adapters.ETABS.DatabaseSettings
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The DatabaseSettings in inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- Base.[IObject](/documentation/oM/Framework/Base/IObject)
16+
17+
18+
## Properties
19+
20+
21+
22+
### Defining properties
23+
24+
The following properties are defined on the class
25+
26+
| Name | Type | Description | Quantity |
27+
|------------------|------------------|------------------|------------------|
28+
| SectionDatabase | [SectionDatabase](/documentation/oM/Adapter/Adapters/ETABS/SectionDatabase) | The ETABS defined section database to read sections from if the name of the sections you push share a name with one avalible in the database | - |
29+
30+
31+
## Code and Schema
32+
33+
### C# implementation
34+
35+
The class is defined in C#. The class definition is available on github:
36+
37+
- [DatabaseSettings.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Settings/DataBaseSettings.cs)
38+
39+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/ETABS/DiaphragmType.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: DiaphragmType
3+
---
4+
5+
# Adapters.ETABS.DiaphragmType
6+
7+
8+
9+
## Enum values
10+
11+
| Name | Description |
12+
|-----------------|----------------------------------------------------------------|
13+
| RigidDiaphragm | - |
14+
| SemiRigidDiaphragm | - |
15+
16+

‎docs/oM/Adapter/Adapters/ETABS/ETABSId.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: ETABSId
3+
---
4+
5+
# Adapters.ETABS.ETABSId
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The ETABSId in inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- Base.[IAdapterId](/documentation/oM/Framework/Base/IAdapterId)
16+
- Base.[IFragment](/documentation/oM/Framework/Base/IFragment)
17+
- Base.[IObject](/documentation/oM/Framework/Base/IObject)
18+
- Base.[IPersistentAdapterId](/documentation/oM/Framework/Base/IPersistentAdapterId)
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+
| Id | [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0) | Id or multi-ids of the element as assigned in ETABS. | - |
32+
| Label | [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0) | Label of the element in Etabs. Only populated for Element-type objects. | - |
33+
| Story | [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0) | Name of the story of the element in Etabs. Only populated for Element-type objects. | - |
34+
| PersistentId | [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0) | Persistent GUID assigned by ETABS upon element creation. This does not vary when the element is modified. Only populated for Element-type objects. | - |
35+
36+
37+
## Code and Schema
38+
39+
### C# implementation
40+
41+
The class is defined in C#. The class definition is available on github:
42+
43+
- [ETABSId.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Fragments/ETABSId.cs)
44+
45+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/ETABS/Elements/AutoLengthOffset.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: AutoLengthOffset
3+
---
4+
5+
# Adapters.ETABS.Elements.AutoLengthOffset
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The AutoLengthOffset in inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- Base.[IFragment](/documentation/oM/Framework/Base/IFragment)
16+
- Base.[IObject](/documentation/oM/Framework/Base/IObject)
17+
18+
19+
## Properties
20+
21+
22+
23+
### Defining properties
24+
25+
The following properties are defined on the class
26+
27+
| Name | Type | Description | Quantity |
28+
|------------------|------------------|------------------|------------------|
29+
| AutoOffset | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |
30+
| RigidZoneFactor | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Value descibing the factor of the rigid zone. Needs to be between 0 and 1 | - |
31+
32+
33+
## Code and Schema
34+
35+
### C# implementation
36+
37+
The class is defined in C#. The class definition is available on github:
38+
39+
- [AutoLengthOffset.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Fragments/AutoLengthOffset.cs)
40+
41+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/ETABS/Elements/Diaphragm.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: Diaphragm
3+
---
4+
5+
# Adapters.ETABS.Elements.Diaphragm
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The Diaphragm in inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- Base.[BHoMObject](/documentation/oM/Framework/Base/BHoMObject)
16+
- Base.[IBHoMObject](/documentation/oM/Framework/Base/IBHoMObject)
17+
- Base.[IObject](/documentation/oM/Framework/Base/IObject)
18+
- Base.[IFragment](/documentation/oM/Framework/Base/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+
| Rigidity | [DiaphragmType](/documentation/oM/Adapter/Adapters/ETABS/DiaphragmType) | - | - |
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](/documentation/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+

0 commit comments

Comments
 (0)