Skip to content

Commit 1842eb1

Browse files
adecleradecler
authored
Merge pull request #12 from BHoM/automatic-api-updates
API Updates
2 parents ddef9e8 + 0893a66 commit 1842eb1

11 files changed

Lines changed: 290 additions & 0 deletions

File tree

‎docs/oM/Adapter/Adapters/GSA/Elements/Joint.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,16 @@ The C# class definition is available on github:
6565
- [Joint.cs](https://github.com/BHoM/GSA_Toolkit/blob/develop/GSA_oM/Elements\Joint.cs)
6666

6767
All history and changes of the class can be found by inspection the history.
68+
### JSON Schema implementation
69+
70+
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/).
71+
72+
``` json title="JSON Schema"
73+
{
74+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/GSA_oM/Elements/Joint.json"
75+
}
76+
```
77+
78+
The JSON Schema is available on github here:
79+
80+
- [Joint.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/GSA_oM/Elements/Joint.json)

‎docs/oM/Adapter/Adapters/Robot/Enums/CombinationType.md‎

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

‎docs/oM/Adapter/Adapters/Robot/Fragments/ContourLoadPanelNumbers.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: ContourLoadPanelNumbers
3+
---
4+
5+
# <small>BH.oM.Adapters.Robot.</small>**ContourLoadPanelNumbers**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The ContourLoadPanelNumbers is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Base.[IFragment](/api/oM/Framework/Base/Interface/IFragment)
16+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/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+
| PanelNumbers | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0)&gt; | - | - |
30+
31+
32+
## Code and Schema
33+
34+
### C# implementation
35+
36+
``` C# title="C#"
37+
public class ContourLoadPanelNumbers : BH.oM.Base.IFragment, BH.oM.Base.IObject
38+
```
39+
40+
Assembly: Robot_oM.dll
41+
42+
The C# class definition is available on github:
43+
44+
- [ContourLoadPanelNumbers.cs](https://github.com/BHoM/Robot_Toolkit/blob/develop/Robot_oM/Fragments\ContourLoadPanelNumbers.cs)
45+
46+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/Robot/Fragments/LoadCombinationType.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: LoadCombinationType
3+
---
4+
5+
# <small>BH.oM.Adapters.Robot.</small>**LoadCombinationType**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The LoadCombinationType is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Base.[IFragment](/api/oM/Framework/Base/Interface/IFragment)
16+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/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+
| CombinationType | [CombinationType](/api/oM/Adapter/Adapters/Robot/Enums/CombinationType) | - | - |
30+
31+
32+
## Code and Schema
33+
34+
### C# implementation
35+
36+
``` C# title="C#"
37+
public class LoadCombinationType : BH.oM.Base.IFragment, BH.oM.Base.IObject
38+
```
39+
40+
Assembly: Robot_oM.dll
41+
42+
The C# class definition is available on github:
43+
44+
- [LoadCombinationType.cs](https://github.com/BHoM/Robot_Toolkit/blob/develop/Robot_oM/Fragments\LoadCombinationType.cs)
45+
46+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/LadybugTools/Config/LadybugConfig.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The following properties are defined on the class
2828
|------------------|------------------|------------------|------------------|
2929
| JsonFile | [FileSettings](/api/oM/Framework/Adapter/FileSettings) | File settings for the json file to pull/push to. | - |
3030
| CacheFileMaximumAge | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | The amount of time (in days) any files that have been created by the adapter for caching purposes should exist before being removed/recreated. <br> Files are only deleted/updated . <br> Set to 0 to force a recompute of a simulation that has a stored cache. | - |
31+
| SkipEPWCheck | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Skips EPW file checks to allow epw files that are not on a drive accessible to the adapter. In general this should be set to false. | - |
3132

3233

3334
### Inherited properties

‎docs/oM/Adapter/LadybugTools/ExecuteCommands/EPWToCSVCommand.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: EPWToCSVCommand
3+
---
4+
5+
# <small>BH.oM.LadybugTools.</small>**EPWToCSVCommand**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The EPWToCSVCommand is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Adapter.[IExecuteCommand](/api/oM/Framework/Adapter/ExecuteCommands/_IExecuteCommand)
16+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/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+
| EPWFile | [FileSettings](/api/oM/Framework/Adapter/FileSettings) | The epw file to convert to a csv file. | - |
30+
| OutputDirectory | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | The directory to place the output csv file. | - |
31+
| IncludeAdditionalCalculated | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Whether to include additional calculated values (e.g. sun positions) in the output file. | - |
32+
33+
34+
## Code and Schema
35+
36+
### C# implementation
37+
38+
``` C# title="C#"
39+
public class EPWToCSVCommand : BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
40+
```
41+
42+
Assembly: LadybugTools_oM.dll
43+
44+
The C# class definition is available on github:
45+
46+
- [EPWToCSVCommand.cs](https://github.com/BHoM/LadybugTools_Toolkit/blob/develop/LadybugTools_oM/ExecuteCommands\EPWToCSVCommand.cs)
47+
48+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/LadybugTools/ExecuteCommands/GEMToHBJSONCommand.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: GEMToHBJSONCommand
3+
---
4+
5+
# <small>BH.oM.LadybugTools.</small>**GEMToHBJSONCommand**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The GEMToHBJSONCommand is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Adapter.[IExecuteCommand](/api/oM/Framework/Adapter/ExecuteCommands/_IExecuteCommand)
16+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/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+
| GEMFile | [FileSettings](/api/oM/Framework/Adapter/FileSettings) | The GEM file to convert to an HBJSON file. | - |
30+
| OutputDirectory | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | The directory to place the output HBJSON file. | - |
31+
32+
33+
## Code and Schema
34+
35+
### C# implementation
36+
37+
``` C# title="C#"
38+
public class GEMToHBJSONCommand : BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
39+
```
40+
41+
Assembly: LadybugTools_oM.dll
42+
43+
The C# class definition is available on github:
44+
45+
- [GEMToHBJSONCommand.cs](https://github.com/BHoM/LadybugTools_Toolkit/blob/develop/LadybugTools_oM/ExecuteCommands\GEMToHBJSONCommand.cs)
46+
47+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/LadybugTools/ExecuteCommands/HBJSONToGEMCommand.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: HBJSONToGEMCommand
3+
---
4+
5+
# <small>BH.oM.LadybugTools.</small>**HBJSONToGEMCommand**
6+
7+
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The HBJSONToGEMCommand is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Adapter.[IExecuteCommand](/api/oM/Framework/Adapter/ExecuteCommands/_IExecuteCommand)
16+
- BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/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+
| HBJSONFile | [FileSettings](/api/oM/Framework/Adapter/FileSettings) | The HBJSON file to convert to a GEM file. | - |
30+
| OutputDirectory | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | The directory to place the output GEM file. | - |
31+
32+
33+
## Code and Schema
34+
35+
### C# implementation
36+
37+
``` C# title="C#"
38+
public class HBJSONToGEMCommand : BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
39+
```
40+
41+
Assembly: LadybugTools_oM.dll
42+
43+
The C# class definition is available on github:
44+
45+
- [HBJSONToGEMCommand.cs](https://github.com/BHoM/LadybugTools_Toolkit/blob/develop/LadybugTools_oM/ExecuteCommands\HBJSONToGEMCommand.cs)
46+
47+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Framework/Adapter/ExecuteCommands/_IExecuteCommand.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,12 @@ Classes implementing IExecuteCommand are commands compatible with the `Execute`
4242
- BH.oM.Adapters.File.[MoveCommand](/api/oM/Adapter/Adapters/File/Commands/MoveCommand)
4343
- BH.oM.Adapters.File.[RenameCommand](/api/oM/Adapter/Adapters/File/Commands/RenameCommand)
4444
- BH.oM.LadybugTools.[DiurnalPlotCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/DiurnalPlotCommand)
45+
- BH.oM.LadybugTools.[EPWToCSVCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/EPWToCSVCommand)
4546
- BH.oM.LadybugTools.[FacadeCondensationRiskCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/FacadeCondensationRiskCommand)
47+
- BH.oM.LadybugTools.[GEMToHBJSONCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/GEMToHBJSONCommand)
4648
- BH.oM.LadybugTools.[GetMaterialCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/GetMaterialCommand)
4749
- BH.oM.LadybugTools.[GetTypologyCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/GetTypologyCommand)
50+
- BH.oM.LadybugTools.[HBJSONToGEMCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/HBJSONToGEMCommand)
4851
- BH.oM.LadybugTools.[HeatPlotCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/HeatPlotCommand)
4952
- BH.oM.LadybugTools.[RunExternalComfortCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/RunExternalComfortCommand)
5053
- BH.oM.LadybugTools.[RunSimulationCommand](/api/oM/Adapter/LadybugTools/ExecuteCommands/RunSimulationCommand)

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,8 @@ Describes objects that can exist independently or can be attached to other BHoM
130130
- BH.oM.Adapters.RFEM6.IntermediateDatastructure.Geometry.[RFEMLine](/api/oM/Adapter/Adapters/RFEM6/IntermediateDatastructure/Geometry/RFEMLine)
131131
- BH.oM.Adapters.RFEM6.IntermediateDatastructure.Geometry.[RFEMOpening](/api/oM/Adapter/Adapters/RFEM6/IntermediateDatastructure/Geometry/RFEMOpening)
132132
- BH.oM.Adapters.RFEM6.BHoMDataStructure.SupportDatastrures.[RFEM6GeometricalLineLoadTypes](/api/oM/Adapter/Adapters/RFEM6/BHoMDataStructure/SupportDatastrures/RFEM6GeometricalLineLoadTypes)
133+
- BH.oM.Adapters.Robot.[ContourLoadPanelNumbers](/api/oM/Adapter/Adapters/Robot/Fragments/ContourLoadPanelNumbers)
134+
- BH.oM.Adapters.Robot.[LoadCombinationType](/api/oM/Adapter/Adapters/Robot/Fragments/LoadCombinationType)
133135
- BH.oM.Adapters.Robot.[LoadCaseLabel](/api/oM/Adapter/Adapters/Robot/Fragments/LoadCaseLabel)
134136
- BH.oM.Adapters.Robot.[PanelFiniteElementIds](/api/oM/Adapter/Adapters/Robot/Fragments/PanelFiniteElementIds)
135137
- BH.oM.Adapters.Robot.[RobotId](/api/oM/Adapter/Adapters/Robot/Fragments/RobotId)

0 commit comments

Comments
 (0)