Skip to content

Commit 6b1e32c

Browse files
authored
Merge pull request #15 from BHoM/automatic-api-updates
API Updates
2 parents ea2c687 + 3bbad87 commit 6b1e32c

7 files changed

Lines changed: 98 additions & 4 deletions

File tree

docs/oM/Framework/Base/BHoMObject.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,8 +285,8 @@ title: BHoMObject
285285
- BH.oM.Lighting.Analysis.[AnalysisGrid](/api/oM/Analytical/Lighting/Analysis/AnalysisGrid)
286286
- BH.oM.Lighting.Analysis.[Node](/api/oM/Analytical/Lighting/Analysis/Node)
287287
- BH.oM.Adapters.Lusas.[LibrarySettings](/api/oM/Adapter/Adapters/Lusas/Settings/LibrarySettings)
288-
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings2D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings2D)
289288
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings1D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings1D)
289+
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings2D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings2D)
290290
- BH.oM.MEP.System.[CableTray](/api/oM/Analytical/MEP/System/CableTray)
291291
- BH.oM.MEP.System.[Duct](/api/oM/Analytical/MEP/System/Duct)
292292
- BH.oM.MEP.System.[FlowSystem](/api/oM/Analytical/MEP/System/FlowSystem)

docs/oM/Framework/Base/Interface/IBHoMObject.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,8 @@ title: IBHoMObject
396396
- BH.oM.Lighting.Analysis.[AnalysisGrid](/api/oM/Analytical/Lighting/Analysis/AnalysisGrid)
397397
- BH.oM.Lighting.Analysis.[Node](/api/oM/Analytical/Lighting/Analysis/Node)
398398
- BH.oM.Adapters.Lusas.[LibrarySettings](/api/oM/Adapter/Adapters/Lusas/Settings/LibrarySettings)
399-
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings2D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings2D)
400399
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings1D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings1D)
400+
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings2D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings2D)
401401
- BH.oM.MEP.System.[CableTray](/api/oM/Analytical/MEP/System/CableTray)
402402
- BH.oM.MEP.System.[Duct](/api/oM/Analytical/MEP/System/Duct)
403403
- BH.oM.MEP.System.[FlowSystem](/api/oM/Analytical/MEP/System/FlowSystem)

docs/oM/Framework/Base/Interface/IFragment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ Describes objects that can exist independently or can be attached to other BHoM
9999
- BH.oM.LifeCycleAssessment.Fragments.[AdditionalEPDData](/api/oM/Analytical/LifeCycleAssessment/Fragments/AdditionalEPDData)
100100
- BH.oM.LifeCycleAssessment.Fragments.[EPDDensity](/api/oM/Analytical/LifeCycleAssessment/Fragments/EPDDensity)
101101
- BH.oM.Adapters.Lusas.[LusasId](/api/oM/Adapter/Adapters/Lusas/Fragments/LusasId)
102-
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings2D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings2D)
103102
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings1D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings1D)
103+
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings2D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings2D)
104104
- BH.oM.MEP.System.MaterialFragments.[InsulationMaterial](/api/oM/Analytical/MEP/System/MaterialFragments/InsulationMaterial)
105105
- BH.oM.MEP.System.MaterialFragments.[LiningMaterial](/api/oM/Analytical/MEP/System/MaterialFragments/LiningMaterial)
106106
- BH.oM.MEP.Fragments.[GeometryFragment](/api/oM/Analytical/MEP/Fragments/GeometryFragment)

docs/oM/Framework/Base/Interface/IObject.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -921,8 +921,8 @@ title: IObject
921921
- BH.oM.Adapters.Lusas.[LusasId](/api/oM/Adapter/Adapters/Lusas/Fragments/LusasId)
922922
- BH.oM.Adapters.Lusas.[LibrarySettings](/api/oM/Adapter/Adapters/Lusas/Settings/LibrarySettings)
923923
- BH.oM.Adapters.Lusas.[LusasSettings](/api/oM/Adapter/Adapters/Lusas/Settings/LusasSettings)
924-
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings2D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings2D)
925924
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings1D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings1D)
925+
- BH.oM.Adapters.Lusas.Fragments.[MeshSettings2D](/api/oM/Adapter/Adapters/Lusas/Fragments/MeshSettings2D)
926926
- BH.oM.Matter.Options.[DensityExtractionOptions](/api/oM/Dimensional/Matter/Options/DensityExtractionOptions)
927927
- BH.oM.MEP.System.[CableTray](/api/oM/Analytical/MEP/System/CableTray)
928928
- BH.oM.MEP.System.[Duct](/api/oM/Analytical/MEP/System/Duct)
@@ -1564,6 +1564,7 @@ title: IObject
15641564
- BH.oM.Test.Results.[TestResult](/api/oM/Framework/Test/Results/TestResult)
15651565
- BH.oM.Test.Adapter.[TestAdapterId](/api/oM/Framework/Test/Adapter/TestAdapterId)
15661566
- BH.oM.UI.[BHoMInformation](/api/oM/UI/UI/BHoMInformation)
1567+
- BH.oM.UI.[CodeElementRecord](/api/oM/UI/UI/CodeElementRecord)
15671568
- BH.oM.UI.[ComponentRequest](/api/oM/UI/UI/ComponentRequest)
15681569
- BH.oM.UI.[CustomItem](/api/oM/UI/UI/CustomItem)
15691570
- BH.oM.UI.[ParamInfo](/api/oM/UI/UI/ParamInfo)

docs/oM/UI/UI/CodeElementRecord.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: CodeElementRecord
3+
---
4+
5+
# <small>BH.oM.UI.</small>**CodeElementRecord**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The CodeElementRecord is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/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+
| AssemblyName | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
29+
| AssemblyModifiedTime | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/System.DateTime?view=netstandard-2.0) | - | - |
30+
| Type | [CodeElementType](/api/oM/UI/UI/CodeElementType) | - | - |
31+
| DisplayText | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
32+
| Json | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
33+
34+
35+
## Code and Schema
36+
37+
### C# implementation
38+
39+
``` C# title="C#"
40+
public class CodeElementRecord : BH.oM.Base.IObject
41+
```
42+
43+
Assembly: UI_oM.dll
44+
45+
The C# class definition is available on github:
46+
47+
- [CodeElementRecord.cs](https://github.com/BHoM/BHoM_UI/blob/develop/UI_oM/CodeElementRecord.cs)
48+
49+
All history and changes of the class can be found by inspection the history.

docs/oM/UI/UI/CodeElementType.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: CodeElementType
3+
---
4+
5+
# <small>BH.oM.UI.</small>**CodeElementType**
6+
7+
8+
9+
## Enum values
10+
11+
| Name | Description |
12+
|-----------------|----------------------------------------------------------------|
13+
| Undefined | - |
14+
| AdapterConstructor | - |
15+
| ConstructableObject | - |
16+
| ConstructableRequest | - |
17+
| Enum | - |
18+
| Library | - |
19+
| Method_Compute | - |
20+
| Method_Convert | - |
21+
| Method_External | - |
22+
| Method_Modify | - |
23+
| Method_Query | - |
24+
| ObjectCreator | - |
25+
| RequestCreator | - |
26+
| Type | - |
27+
28+
29+
## Code and Schema
30+
31+
### C# implementation
32+
33+
``` C# title="C#"
34+
public enum CodeElementType : System.Enum, System.ValueType, System.IComparable, System.ISpanFormattable, System.IFormattable, System.IConvertible
35+
```
36+
37+
Assembly: UI_oM.dll
38+
39+
The C# enum definition is available on github:
40+
41+
- [CodeElementType.cs](https://github.com/BHoM/BHoM_UI/blob/develop/UI_oM/CodeElementType.cs)
42+
43+
All history and changes of the class can be found by inspection the history.

docs/oM/UI/UI/SearchItem.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The following properties are defined on the class
3232
| Icon | [Bitmap](https://learn.microsoft.com/en-us/dotnet/api/System.Drawing.Bitmap?view=netstandard-2.0) | - | - |
3333
| Text | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
3434
| Weight | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | - | - |
35+
| Json | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
3536

3637

3738
### Inherited properties

0 commit comments

Comments
 (0)