Skip to content

Commit 74da303

Browse files
authored
Merge pull request #17 from BHoM/automatic-api-updates
API Updates
2 parents e2efdbd + 2753578 commit 74da303

15 files changed

Lines changed: 41 additions & 41 deletions

File tree

docs/oM/Adapter/Adapters/XML/Enums/Schema.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ title: Schema
44

55
# <small>BH.oM.Adapters.XML.Enums.</small>**Schema**
66

7-
Defines the XML Schema that is being used within the context of the XML Toolkit
7+
Defines the XML Schema that is being used within the context of the XML Toolkit.
88

99
## Enum values
1010

1111
| Name | Description |
1212
|-----------------|----------------------------------------------------------------|
1313
| Undefined | - |
1414
| Bluebeam | Bluebeam markup files with data pulled through for specific workflows. |
15-
| CSProject | CSProject files are used to work out compiling information for code projects. Typically seen in Visual Studio solution files |
16-
| EnergyPlusLoads | EnergyPlusLoads is the XML schema for load results calculated using the EnergyPlus software |
17-
| GBXML | gbXML Schema is the Green Building XML Schema, used by environment modelling software for the transfer of building geometry and data to tools such as IES, TAS, and more |
18-
| KML | KML is a file format used to display geographic data in an Earth browser such as Google Earth |
15+
| CSProject | CSProject files are used to work out compiling information for code projects. Typically seen in Visual Studio solution files. |
16+
| EnergyPlusLoads | EnergyPlusLoads is the XML schema for load results calculated using the EnergyPlus software. |
17+
| GBXML | gbXML Schema is the Green Building XML Schema, used by environment modelling software for the transfer of building geometry and data to tools such as IES, TAS, and more. |
18+
| KML | KML is a file format used to display geographic data in an Earth browser such as Google Earth. |
1919

2020

2121
## Code and Schema

docs/oM/Adapter/Adapters/XML/Settings/GBXMLSettings.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,19 @@ The following properties are defined on the class
2828

2929
| Name | Type | Description | Quantity |
3030
|------------------|------------------|------------------|------------------|
31-
| ReplaceCurtainWalls | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to true if you want to replace curtain walls to have openings the same size as the wall. This is useful for IES exports. Default false | - |
32-
| ReplaceSolidOpeningsIntoDoors | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to true if you want to replace an opening which is marked as solid into a door. Useful for IES exports. Default false | - |
33-
| IncludeConstructions | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to true if you want to include construction and material data in the export. Default false | - |
34-
| FixIncorrectAirTypes | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to true if you want air types with one adjacent space (i.e. external air walls) to have their type fixed based on their tilt. Default false | - |
35-
| NewFile | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to false if you want to append to a file when pushing XML. If set to true then a file will be created. If a file exists, it will be overwritten. Default true | - |
36-
| ResultsUnitType | [UnitType](/api/oM/Adapter/Adapters/XML/Enums/UnitType) | Set the unit type for the results to be either SI or Imperial. Default SI | - |
37-
| ExportDetail | [ExportDetail](/api/oM/Adapter/Adapters/XML/Enums/ExportDetail) | Set the detail of your export to be either full (whole building), shell (exterior walls only), or spaces (each individual space as its own XML file). Default full | - |
38-
| DistanceTolerance | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Set the tolerance for distance between points to define a 'short' segment which should be removed from export, default is set to BH.oM.Geometry.Tolerance.Distance | - |
39-
| PlanarTolerance | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Set tolerance for planar surfaces, default is set to BH.oM.Geometry.Tolerance.Distance | - |
40-
| OffsetDistance | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Set a distance to offset openings that have a area &gt;= the area of the host panel. Value should be negative. Defaults to -0.001 | - |
41-
| AngleTolerance | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Set the tolerance for angle calculations when exporting to XML. Default is set to BH.oM.Geometry.Tolerance.Angle | - |
42-
| RoundingSettings | [RoundingSettings](/api/oM/Adapter/Adapters/XML/GBXML/RoundingSettings) | Set the rounding options for numerical outputs to be used within gbXML creation. Default is per the Rounding Settings defaults | - |
43-
| UnitSetUp | [GBXMLUnitSetUp](/api/oM/Adapter/Adapters/XML/GBXML/GBXMLUnitSetUp) | Set the units to be used for the export of a gbXML file. Default units will be in SI using the defaults of the GBXMLSetUp object if none are provided | - |
31+
| ReplaceCurtainWalls | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to true if you want to replace curtain walls to have openings the same size as the wall. This is useful for IES exports. Default false. | - |
32+
| ReplaceSolidOpeningsIntoDoors | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to true if you want to replace an opening which is marked as solid into a door. Useful for IES exports. Default false. | - |
33+
| IncludeConstructions | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to true if you want to include construction and material data in the export. Default false. | - |
34+
| FixIncorrectAirTypes | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to true if you want air types with one adjacent space (i.e. external air walls) to have their type fixed based on their tilt. Default false. | - |
35+
| NewFile | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to false if you want to append to a file when pushing XML. If set to true then a file will be created. If a file exists, it will be overwritten. Default true. | - |
36+
| ResultsUnitType | [UnitType](/api/oM/Adapter/Adapters/XML/Enums/UnitType) | Set the unit type for the results to be either SI or Imperial. Default SI. | - |
37+
| ExportDetail | [ExportDetail](/api/oM/Adapter/Adapters/XML/Enums/ExportDetail) | Set the detail of your export to be either full (whole building), shell (exterior walls only), or spaces (each individual space as its own XML file). Default full. | - |
38+
| DistanceTolerance | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Set the tolerance for distance between points to define a 'short' segment which should be removed from export, default is set to BH.oM.Geometry.Tolerance.Distance. | - |
39+
| PlanarTolerance | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Set tolerance for planar surfaces, default is set to BH.oM.Geometry.Tolerance.Distance. | - |
40+
| OffsetDistance | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Set a distance to offset openings that have an area &gt;= the area of the host panel. Value should be negative. Defaults to -0.001. | - |
41+
| AngleTolerance | [double](https://learn.microsoft.com/en-us/dotnet/api/System.Double?view=netstandard-2.0) | Set the tolerance for angle calculations when exporting to XML. Default is set to BH.oM.Geometry.Tolerance.Angle. | - |
42+
| RoundingSettings | [RoundingSettings](/api/oM/Adapter/Adapters/XML/GBXML/RoundingSettings) | Set the rounding options for numerical outputs to be used within gbXML creation. Default is per the Rounding Settings defaults. | - |
43+
| UnitSetUp | [GBXMLUnitSetUp](/api/oM/Adapter/Adapters/XML/GBXML/GBXMLUnitSetUp) | Set the units to be used for the export of a gbXML file. Default units will be in SI using the defaults of the GBXMLSetUp object if none are provided. | - |
4444

4545

4646
### Inherited properties

docs/oM/Adapter/Adapters/XML/Settings/KMLSettings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The following properties are defined on the class
2828

2929
| Name | Type | Description | Quantity |
3030
|------------------|------------------|------------------|------------------|
31-
| NewFile | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to false if you want to append to a file when pushing XML. If set to true then a file will be created. If a file exists, it will be overwritten. Default true | - |
31+
| NewFile | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set to false if you want to append to a file when pushing XML. If set to true then a file will be created. If a file exists, it will be overwritten. Default true. | - |
3232

3333

3434
### Inherited properties

docs/oM/Analytical/Analytical/Results/ICasedResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Interface for results that correspond to a particular case.
3838
- BH.oM.Environment.Results.Mesh.[MeshElementResult](/api/oM/Analytical/Environment/Results/Mesh/MeshElementResult)
3939
- BH.oM.Environment.Results.Mesh.[MeshResult](/api/oM/Analytical/Environment/Results/Mesh/MeshResult)
4040
- BH.oM.Environment.Results.Illuminance.[Lux](/api/oM/Analytical/Environment/Results/Illuminance/Lux)
41-
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
4241
- BH.oM.Adapters.ETABS.Results.[PierForce](/api/oM/Adapter/Adapters/ETABS/Results/PierForce)
42+
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
4343
- BH.oM.Humans.ViewQuality.[Avalue](/api/oM/Physical/Humans/ViewQuality/Results/Avalue)
4444
- BH.oM.Humans.ViewQuality.[Cvalue](/api/oM/Physical/Humans/ViewQuality/Results/Cvalue)
4545
- BH.oM.Humans.ViewQuality.[Evalue](/api/oM/Physical/Humans/ViewQuality/Results/Evalue)

docs/oM/Analytical/Analytical/Results/IElement1DResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Base interface for results, corresponding to a discrete result at a particular p
2323

2424
???+ bhom "The following classes are implementing this interface:"
2525

26-
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
2726
- BH.oM.Adapters.ETABS.Results.[PierForce](/api/oM/Adapter/Adapters/ETABS/Results/PierForce)
27+
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
2828
- BH.oM.Adapters.SAP2000.Results.[AISCSteelUtilisation](/api/oM/Adapter/Adapters/SAP2000/Elements/AISCSteelUtilisation)
2929
- BH.oM.Structure.Results.[BarDeformation](/api/oM/Analytical/Structure/Results/Bar Results/BarDeformation)
3030
- BH.oM.Structure.Results.[BarDisplacement](/api/oM/Analytical/Structure/Results/Bar Results/BarDisplacement)

docs/oM/Analytical/Analytical/Results/IObjectIdResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Interface for Results belonging to a particular object. The owning object is ide
4242
- BH.oM.Environment.Results.Mesh.[MeshElementResult](/api/oM/Analytical/Environment/Results/Mesh/MeshElementResult)
4343
- BH.oM.Environment.Results.Mesh.[MeshResult](/api/oM/Analytical/Environment/Results/Mesh/MeshResult)
4444
- BH.oM.Environment.Results.Illuminance.[Lux](/api/oM/Analytical/Environment/Results/Illuminance/Lux)
45-
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
4645
- BH.oM.Adapters.ETABS.Results.[PierForce](/api/oM/Adapter/Adapters/ETABS/Results/PierForce)
46+
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
4747
- BH.oM.Humans.ViewQuality.[Avalue](/api/oM/Physical/Humans/ViewQuality/Results/Avalue)
4848
- BH.oM.Humans.ViewQuality.[Cvalue](/api/oM/Physical/Humans/ViewQuality/Results/Cvalue)
4949
- BH.oM.Humans.ViewQuality.[Evalue](/api/oM/Physical/Humans/ViewQuality/Results/Evalue)

docs/oM/Analytical/Analytical/Results/IResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ For expanded functionality, a result class should generally either implement the
5050
- BH.oM.Environment.Results.Mesh.[MeshElementResult](/api/oM/Analytical/Environment/Results/Mesh/MeshElementResult)
5151
- BH.oM.Environment.Results.Mesh.[MeshResult](/api/oM/Analytical/Environment/Results/Mesh/MeshResult)
5252
- BH.oM.Environment.Results.Illuminance.[Lux](/api/oM/Analytical/Environment/Results/Illuminance/Lux)
53-
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
5453
- BH.oM.Adapters.ETABS.Results.[PierForce](/api/oM/Adapter/Adapters/ETABS/Results/PierForce)
54+
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
5555
- BH.oM.Humans.ViewQuality.[Avalue](/api/oM/Physical/Humans/ViewQuality/Results/Avalue)
5656
- BH.oM.Humans.ViewQuality.[Cvalue](/api/oM/Physical/Humans/ViewQuality/Results/Cvalue)
5757
- BH.oM.Humans.ViewQuality.[Evalue](/api/oM/Physical/Humans/ViewQuality/Results/Evalue)

docs/oM/Analytical/Analytical/Results/ITimeStepResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Interface for results that correspond to a particular time step, for example a d
3838
- BH.oM.Environment.Results.Mesh.[MeshElementResult](/api/oM/Analytical/Environment/Results/Mesh/MeshElementResult)
3939
- BH.oM.Environment.Results.Mesh.[MeshResult](/api/oM/Analytical/Environment/Results/Mesh/MeshResult)
4040
- BH.oM.Environment.Results.Illuminance.[Lux](/api/oM/Analytical/Environment/Results/Illuminance/Lux)
41-
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
4241
- BH.oM.Adapters.ETABS.Results.[PierForce](/api/oM/Adapter/Adapters/ETABS/Results/PierForce)
42+
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
4343
- BH.oM.Humans.ViewQuality.[Avalue](/api/oM/Physical/Humans/ViewQuality/Results/Avalue)
4444
- BH.oM.Humans.ViewQuality.[Cvalue](/api/oM/Physical/Humans/ViewQuality/Results/Cvalue)
4545
- BH.oM.Humans.ViewQuality.[Evalue](/api/oM/Physical/Humans/ViewQuality/Results/Evalue)

docs/oM/Analytical/Structure/Results/Bar Results/BarResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Base class for all bar result classes. Stores all identifier information and how
2727

2828
???+ bhom "The following classes are inheriting from this class:"
2929

30-
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
3130
- BH.oM.Adapters.ETABS.Results.[PierForce](/api/oM/Adapter/Adapters/ETABS/Results/PierForce)
31+
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
3232
- BH.oM.Adapters.SAP2000.Results.[AISCSteelUtilisation](/api/oM/Adapter/Adapters/SAP2000/Elements/AISCSteelUtilisation)
3333
- BH.oM.Structure.Results.[BarDeformation](/api/oM/Analytical/Structure/Results/Bar Results/BarDeformation)
3434
- BH.oM.Structure.Results.[BarDisplacement](/api/oM/Analytical/Structure/Results/Bar Results/BarDisplacement)

docs/oM/Analytical/Structure/Results/IStructuralResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Base interface for all structural results. Adds ModeNumber as a property in addi
3636

3737
???+ bhom "The following classes are implementing this interface:"
3838

39-
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
4039
- BH.oM.Adapters.ETABS.Results.[PierForce](/api/oM/Adapter/Adapters/ETABS/Results/PierForce)
40+
- BH.oM.Adapters.ETABS.Results.[SpandrelForce](/api/oM/Adapter/Adapters/ETABS/Results/SpandrelForce)
4141
- BH.oM.Adapters.SAP2000.Results.[AISCSteelUtilisation](/api/oM/Adapter/Adapters/SAP2000/Elements/AISCSteelUtilisation)
4242
- BH.oM.Structure.Results.[BarDeformation](/api/oM/Analytical/Structure/Results/Bar Results/BarDeformation)
4343
- BH.oM.Structure.Results.[BarDisplacement](/api/oM/Analytical/Structure/Results/Bar Results/BarDisplacement)

0 commit comments

Comments
 (0)