Skip to content

Commit c769d3e

Browse files
IsakNaslundBhIsakNaslundBh
committed
Update docs
1 parent 82ef780 commit c769d3e

2,556 files changed

Lines changed: 59869 additions & 47030 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 renamed to docs/oM/Adapter/Adapters.AGS/AGSSettings.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: AGSSettings
33
---
44

5-
# Adapters.AGS.AGSSettings
5+
# <small>BH.oM.Adapters.</small>**AGSSettings**
66

77
General settings for any Adapter, to be specified when instantiating the Adapter.Implement this class to make your own Toolkit settings, e.g. SpeckleAdapterSettings.
88

99
## Class structure
1010

1111
### Implemented interfaces and base types
1212

13-
???+ bhom "The AGSSettings in inheriting from the following base type(s) and implements the following interfaces:"
13+
???+ bhom "The AGSSettings is inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Adapter.[AdapterSettings](/api/oM/Framework/Adapter/AdapterSettings)
16-
- Base.[IObject](/api/oM/Framework/Base/IObject)
15+
- BH.oM.Adapter.[AdapterSettings](/api/oM/Framework/Adapter/Settings-Config/AdapterSettings)
16+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject)
1717

1818

1919
## Properties
@@ -27,7 +27,7 @@ The following properties are defined on the class
2727
| Name | Type | Description | Quantity |
2828
|------------------|------------------|------------------|------------------|
2929
| 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](/api/oM/Adapter/Adapters/AGS/BlankGeologyStrategy) | The strategy used to handle blank geology entries. | - |
30+
| BlankGeologyStraegy | [BlankGeologyStrategy](/api/oM/Adapter/Adapters.AGS/eNums/BlankGeologyStrategy) | The strategy used to handle blank geology entries. | - |
3131

3232

3333
### Inherited properties
@@ -36,9 +36,9 @@ The following properties are inherited from the base class of the object
3636
| Name | Type | Description | Quantity |
3737
|------------------|------------------|------------------|------------------|
3838
| 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](/api/oM/Framework/Adapter/PushType) | If your Toolkit does not support the Full Push (FullCRUD method), you can select another behaviour here (e.g. CreateOnly). | - |
39+
| DefaultPushType | [PushType](/api/oM/Framework/Adapter/Enums/PushType) | If your Toolkit does not support the Full Push (FullCRUD method), you can select another behaviour here (e.g. CreateOnly). | - |
4040
| 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](/api/oM/Framework/Adapter/PullType) | - | - |
41+
| DefaultPullType | [PullType](/api/oM/Framework/Adapter/Enums/PullType) | - | - |
4242
| 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. | - |
4343
| HandlePriorities | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |
4444
| UseAdapterId | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | - | - |
@@ -54,6 +54,12 @@ The following properties are inherited from the base class of the object
5454

5555
### C# implementation
5656

57+
``` C# title="C#"
58+
public class AGSSettings : BH.oM.Adapter.AdapterSettings, BH.oM.Base.IObject
59+
```
60+
61+
Assembly: AGS_oM.dll
62+
5763
The class is defined in C#. The class definition is available on github:
5864

5965
- [AGSSettings.cs](https://github.com/BHoM/AGS_Toolkit/blob/develop/AGS_oM/AGSSettings.cs)

docs/oM/Adapter/Adapters/AGS/BlankGeologyStrategy.md renamed to docs/oM/Adapter/Adapters.AGS/eNums/BlankGeologyStrategy.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: BlankGeologyStrategy
33
---
44

5-
# Adapters.AGS.BlankGeologyStrategy
5+
# <small>BH.oM.Adapters.</small>**BlankGeologyStrategy**
66

77
Different approaches for the AGS_Toolkit to handle blank geology.
88

@@ -20,8 +20,14 @@ Different approaches for the AGS_Toolkit to handle blank geology.
2020

2121
### C# implementation
2222

23+
``` C# title="C#"
24+
public enum BlankGeologyStrategy : System.Enum, System.ValueType, System.IComparable, System.ISpanFormattable, System.IFormattable, System.IConvertible
25+
```
26+
27+
Assembly: AGS_oM.dll
28+
2329
The enum is defined in C#. The class definition is available on github:
2430

25-
- [BlankGeologyStrategy.cs](https://github.com/BHoM/AGS_Toolkit/blob/develop/AGS_oM/eNums/BlankGeologyStrategy.cs)
31+
- [BlankGeologyStrategy.cs](https://github.com/BHoM/AGS_Toolkit/blob/develop/AGS_oM/eNums\BlankGeologyStrategy.cs)
2632

2733
All history and changes of the class can be found by inspection the history.

docs/oM/Adapter/Adapters/CarbonQueryDatabase/CQDConfig.md renamed to docs/oM/Adapter/Adapters.CarbonQueryDatabase/Adapter/CQDConfig.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: CQDConfig
33
---
44

5-
# Adapters.CarbonQueryDatabase.CQDConfig
5+
# <small>BH.oM.Adapters.</small>**CQDConfig**
66

77
This Config can be specified in the `ActionConfig` input of any Adapter Action (e.g. Push).
88

99
## Class structure
1010

1111
### Implemented interfaces and base types
1212

13-
???+ bhom "The CQDConfig in inheriting from the following base type(s) and implements the following interfaces:"
13+
???+ bhom "The CQDConfig is inheriting from the following base type(s) and implements the following interfaces:"
1414

15-
- Adapter.[ActionConfig](/api/oM/Framework/Adapter/ActionConfig)
16-
- Base.[IObject](/api/oM/Framework/Base/IObject)
15+
- BH.oM.Adapter.[ActionConfig](/api/oM/Framework/Adapter/Settings-Config/ActionConfig)
16+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject)
1717

1818

1919
## Properties
@@ -26,7 +26,7 @@ The following properties are defined on the class
2626

2727
| Name | Type | Description | Quantity |
2828
|------------------|------------------|------------------|------------------|
29-
| Type | [EPDType](/api/oM/Analytical/LifeCycleAssessment/EPDType) | The Type of Environmental Product Declaration | - |
29+
| Type | [EPDType](/api/oM/Analytical/LifeCycleAssessment/Enums/EPDType) | The Type of Environmental Product Declaration | - |
3030
| 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. | - |
3131
| 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 | - |
3232
| 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 | - |
@@ -47,8 +47,14 @@ The following properties are inherited from the base class of the object
4747

4848
### C# implementation
4949

50+
``` C# title="C#"
51+
public class CQDConfig : BH.oM.Adapter.ActionConfig, BH.oM.Base.IObject
52+
```
53+
54+
Assembly: CarbonQueryDatabase_oM.dll
55+
5056
The class is defined in C#. The class definition is available on github:
5157

52-
- [CQDConfig.cs](https://github.com/BHoM/CarbonQueryDatabase_Toolkit/blob/develop/CarbonQueryDatabase_oM/Adapter/CQDConfig.cs)
58+
- [CQDConfig.cs](https://github.com/BHoM/CarbonQueryDatabase_Toolkit/blob/develop/CarbonQueryDatabase_oM/Adapter\CQDConfig.cs)
5359

5460
All history and changes of the class can be found by inspection the history.

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Diaphragm
3+
---
4+
5+
# <small>BH.oM.Adapters.ETABS.</small>**Diaphragm**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The Diaphragm 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+
| Rigidity | [DiaphragmType](/api/oM/Adapter/Adapters.ETABS/Enums/Diaphragm) | - | - |
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 Diaphragm : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Base.IFragment
52+
```
53+
54+
Assembly: ETABS_oM.dll
55+
56+
The class is defined in C#. The class definition is available on github:
57+
58+
- [Diaphragm.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Elements\Diaphragm.cs)
59+
60+
All history and changes of the class can be found by inspection the history.

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

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Pier
3+
---
4+
5+
# <small>BH.oM.Adapters.ETABS.</small>**Pier**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The Pier 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+
### Inherited properties
24+
The following properties are inherited from the base class of the object
25+
26+
| Name | Type | Description | Quantity |
27+
|------------------|------------------|------------------|------------------|
28+
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
29+
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
30+
| Fragments | [FragmentSet](/api/oM/Framework/Base/FragmentSet) | - | - |
31+
| 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; | - | - |
32+
| 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; | - | - |
33+
34+
35+
## Code and Schema
36+
37+
### C# implementation
38+
39+
``` C# title="C#"
40+
public class Pier : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Base.IFragment
41+
```
42+
43+
Assembly: ETABS_oM.dll
44+
45+
The class is defined in C#. The class definition is available on github:
46+
47+
- [Pier.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Elements\Pier.cs)
48+
49+
All history and changes of the class can be found by inspection the history.

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

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Spandrel
3+
---
4+
5+
# <small>BH.oM.Adapters.ETABS.</small>**Spandrel**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The Spandrel 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+
### Inherited properties
24+
The following properties are inherited from the base class of the object
25+
26+
| Name | Type | Description | Quantity |
27+
|------------------|------------------|------------------|------------------|
28+
| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
29+
| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
30+
| Fragments | [FragmentSet](/api/oM/Framework/Base/FragmentSet) | - | - |
31+
| 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; | - | - |
32+
| 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; | - | - |
33+
34+
35+
## Code and Schema
36+
37+
### C# implementation
38+
39+
``` C# title="C#"
40+
public class Spandrel : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Base.IFragment
41+
```
42+
43+
Assembly: ETABS_oM.dll
44+
45+
The class is defined in C#. The class definition is available on github:
46+
47+
- [Spandrel.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Elements\Spandrel.cs)
48+
49+
All history and changes of the class can be found by inspection the history.

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

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: BarInsertionPoint
3+
---
4+
5+
# <small>BH.oM.Adapters.</small>**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+
``` C# title="C#"
31+
public enum BarInsertionPoint : System.Enum, System.ValueType, System.IComparable, System.ISpanFormattable, System.IFormattable, System.IConvertible
32+
```
33+
34+
Assembly: ETABS_oM.dll
35+
36+
The enum is defined in C#. The class definition is available on github:
37+
38+
- [BarInsertionPoint.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Enums\BarInsertionPoint.cs)
39+
40+
All history and changes of the class can be found by inspection the history.

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: DiaphragmType
3+
---
4+
5+
# <small>BH.oM.Adapters.</small>**DiaphragmType**
6+
7+
8+
9+
## Enum values
10+
11+
| Name | Description |
12+
|-----------------|----------------------------------------------------------------|
13+
| RigidDiaphragm | - |
14+
| SemiRigidDiaphragm | - |
15+
16+
17+
## Code and Schema
18+
19+
### C# implementation
20+
21+
``` C# title="C#"
22+
public enum DiaphragmType : System.Enum, System.ValueType, System.IComparable, System.ISpanFormattable, System.IFormattable, System.IConvertible
23+
```
24+
25+
Assembly: ETABS_oM.dll
26+
27+
The enum is defined in C#. The class definition is available on github:
28+
29+
- [DiaphragmType.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Enums\Diaphragm.cs)
30+
31+
All history and changes of the class can be found by inspection the history.

docs/oM/Adapter/Adapters/ETABS/SectionDatabase.md renamed to docs/oM/Adapter/Adapters.ETABS/Enums/SectionDatabase.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: SectionDatabase
33
---
44

5-
# Adapters.ETABS.SectionDatabase
5+
# <small>BH.oM.Adapters.</small>**SectionDatabase**
66

77
The ETABS defined section databases to read sections from if the name of the sections you push share a name with one avalible in the database
88

@@ -44,8 +44,14 @@ The ETABS defined section databases to read sections from if the name of the sec
4444

4545
### C# implementation
4646

47+
``` C# title="C#"
48+
public enum SectionDatabase : System.Enum, System.ValueType, System.IComparable, System.ISpanFormattable, System.IFormattable, System.IConvertible
49+
```
50+
51+
Assembly: ETABS_oM.dll
52+
4753
The enum is defined in C#. The class definition is available on github:
4854

49-
- [SectionDatabase.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Enums/SectionDatabase.cs)
55+
- [SectionDatabase.cs](https://github.com/BHoM/ETABS_Toolkit/blob/develop/ETABS_oM/Enums\SectionDatabase.cs)
5056

5157
All history and changes of the class can be found by inspection the history.

0 commit comments

Comments
 (0)