Skip to content

Commit 2c402e5

Browse files
IsakNaslundBhIsakNaslundBh
authored
Merge pull request #8 from BHoM/automatic-api-updates
API Updates
2 parents bcd229d + ef4a1b8 commit 2c402e5

File tree

235 files changed

+2412
-851
lines changed

Some content is hidden

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

235 files changed

+2412
-851
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The following properties are defined as extension methods in one of the BHoM_Eng
5757
| Bounds | [BoundingBox](/api/oM/Dimensional/Geometry/Misc/BoundingBox) | Queries the IElement1Ds BoundingBox. Acts on the ICurve definition of the IElement1D through the Geometry_Engine. | - | Spatial_Engine |
5858
| Centroid | [Point](/api/oM/Dimensional/Geometry/Vector/Point) | Queries the centre of weight for a IElement1Ds ICurve representation. | - | Spatial_Engine |
5959
| ControlPoints | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[Point](/api/oM/Dimensional/Geometry/Vector/Point)> | Queries the control points of the one dimensional representation of the IElement1D. | - | Spatial_Engine |
60-
| DominantVector | [Vector](/api/oM/Dimensional/Geometry/Vector/Vector) | Gets the the dominant vector (orientation) of an Element1D based on its lines lengths. | - | Spatial_Engine |
60+
| DominantVector | [Vector](/api/oM/Dimensional/Geometry/Vector/Vector) | Gets the dominant vector (orientation) of an Element1D based on its line lengths. | - | Spatial_Engine |
6161
| ElementCurves | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[ICurve](/api/oM/Dimensional/Geometry/Curve/ICurve)> | Queries the defining curves of an IElement1D. | - | Spatial_Engine |
6262
| Elements0D | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[IElement0D](/api/oM/Dimensional/Dimensional/IElement0D)> | Gets the Element0Ds of an ILink, which for the case of a ILink means getting the StartNode and EndNode. Method necessary for IElement pattern. | - | Analytical_Engine |
6363
| ElementVertices | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[Point](/api/oM/Dimensional/Geometry/Vector/Point)> | Returns the discontinuity points from the defining ICurve of the IElement1D. | - | Spatial_Engine |
@@ -66,7 +66,7 @@ The following properties are defined as extension methods in one of the BHoM_Eng
6666
| IBounds | [BoundingBox](/api/oM/Dimensional/Geometry/Misc/BoundingBox) | Queries the IElements BoundingBox. Acts on the elements geometrical definition of the IElement through the Geometry_Engine. | - | Spatial_Engine |
6767
| ICentroid | [Point](/api/oM/Dimensional/Geometry/Vector/Point) | Queries the centre of weight for the homogeneous geometrical representation of an IElement. | - | Spatial_Engine |
6868
| IControlPoints | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[Point](/api/oM/Dimensional/Geometry/Vector/Point)> | Queries the control points of the geometrical representation of an IElement. | - | Spatial_Engine |
69-
| IElementCurves | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[ICurve](/api/oM/Dimensional/Geometry/Curve/ICurve)> | Queries the geometricly defining curves of the IElements geometry. | - | Spatial_Engine |
69+
| IElementCurves | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[ICurve](/api/oM/Dimensional/Geometry/Curve/ICurve)> | Queries the geometrically defining curves of the IElements geometry. | - | Spatial_Engine |
7070
| IElements0D | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[IElement0D](/api/oM/Dimensional/Dimensional/IElement0D)> | Queries the IElement0Ds from a IElement1D. Returns null if no IElement0Ds are defined for the type of IElement1D. | - | Spatial_Engine |
7171
| IElementVertices | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)<[Point](/api/oM/Dimensional/Geometry/Vector/Point)> | Returns the discontinuity points from the defining ICurves of the IElement. | - | Spatial_Engine |
7272
| IGeometry | [ICurve](/api/oM/Dimensional/Geometry/Curve/ICurve) | Queries the defining geometrical object which all spatial operations will act on. | - | Spatial_Engine |

‎docs/oM/Adapter/Adapters/Revit/Commands/DirectPush.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: DirectPush
3+
---
4+
5+
# <small>BH.oM.Adapters.Revit.Commands.</small>**DirectPush**
6+
7+
Push action allows quick transfer of selected objects on current UI to External Application.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The DirectPush 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+
| ObjectsToPush | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[IObject](/api/oM/Framework/Base/Interface/IObject)&gt; | Source objects to be pushed | - |
30+
31+
32+
## Code and Schema
33+
34+
### C# implementation
35+
36+
``` C# title="C#"
37+
public class DirectPush : BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
38+
```
39+
40+
Assembly: Revit_oM.dll
41+
42+
The C# class definition is available on github:
43+
44+
- [DirectPush.cs](https://github.com/BHoM/Revit_Toolkit/blob/develop/Revit_oM/Commands\DirectPush.cs)
45+
46+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/Revit/Commands/Isolate.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Isolate
3+
---
4+
5+
# <small>BH.oM.Adapters.Revit.Commands.</small>**Isolate**
6+
7+
Isolate action allows quick isolation of chosen Elements in External Application.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The Isolate 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+
| Targets | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | Elements to be isolated, specified as either IBHoMObjects or integers representing ElementIds. | - |
30+
31+
32+
## Code and Schema
33+
34+
### C# implementation
35+
36+
``` C# title="C#"
37+
public class Isolate : BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
38+
```
39+
40+
Assembly: Revit_oM.dll
41+
42+
The C# class definition is available on github:
43+
44+
- [Isolate.cs](https://github.com/BHoM/Revit_Toolkit/blob/develop/Revit_oM/Commands\Isolate.cs)
45+
46+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/Revit/Commands/PullSelection.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: PullSelection
3+
---
4+
5+
# <small>BH.oM.Adapters.Revit.Commands.</small>**PullSelection**
6+
7+
Pull action allows quick retrieval of selected elements from External Application.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The PullSelection 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+
## Code and Schema
22+
23+
### C# implementation
24+
25+
``` C# title="C#"
26+
public class PullSelection : BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
27+
```
28+
29+
Assembly: Revit_oM.dll
30+
31+
The C# class definition is available on github:
32+
33+
- [PullSelection.cs](https://github.com/BHoM/Revit_Toolkit/blob/develop/Revit_oM/Commands\PullSelection.cs)
34+
35+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/Revit/Commands/Select.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Select
3+
---
4+
5+
# <small>BH.oM.Adapters.Revit.Commands.</small>**Select**
6+
7+
Select action allows direct interaction with External Application.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The Select 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+
| Targets | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0)&gt; | Elements to be selected, specified as either IBHoMObjects or integers representing ElementIds. | - |
30+
| ShowObjects | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | Set True to focus view on selected objects in the External Application UI as a part of this action. | - |
31+
32+
33+
## Code and Schema
34+
35+
### C# implementation
36+
37+
``` C# title="C#"
38+
public class Select : BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject
39+
```
40+
41+
Assembly: Revit_oM.dll
42+
43+
The C# class definition is available on github:
44+
45+
- [Select.cs](https://github.com/BHoM/Revit_Toolkit/blob/develop/Revit_oM/Commands\Select.cs)
46+
47+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/Revit/Config/RevitExecutionConfig.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: RevitExecutionConfig
3+
---
4+
5+
# <small>BH.oM.Adapters.Revit.</small>**RevitExecutionConfig**
6+
7+
Configuration used for adapter interaction with Revit on Execution action.
8+
9+
## Class structure
10+
11+
### Implemented interfaces and base types
12+
13+
???+ bhom "The RevitExecutionConfig is inheriting from the following base type(s) and implements the following interfaces:"
14+
15+
- BH.oM.Adapter.[ActionConfig](/api/oM/Framework/Adapter/Settings-Config/ActionConfig)
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+
| SuppressFailureMessages | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, Revit warnings and failure message popups will be suppressed (not shown to the user). Whilst this option may speed the execution process up in case of multiple warnings, it may lead to important issues. | - |
30+
31+
32+
### Inherited properties
33+
The following properties are inherited from the base class of the object
34+
35+
| Name | Type | Description | Quantity |
36+
|------------------|------------------|------------------|------------------|
37+
| 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. | - |
38+
| 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. | - |
39+
| DiffingConfig | [DiffingConfig](/api/oM/Framework/Diffing/DiffingConfig) | Configurations for the Diffing hashing. Requires `AllowHashForComparing` to be set to true. | - |
40+
41+
42+
## Code and Schema
43+
44+
### C# implementation
45+
46+
``` C# title="C#"
47+
public class RevitExecutionConfig : BH.oM.Adapter.ActionConfig, BH.oM.Base.IObject
48+
```
49+
50+
Assembly: Revit_oM.dll
51+
52+
The C# class definition is available on github:
53+
54+
- [RevitExecutionConfig.cs](https://github.com/BHoM/Revit_Toolkit/blob/develop/Revit_oM/Config\RevitExecutionConfig.cs)
55+
56+
All history and changes of the class can be found by inspection the history.

‎docs/oM/Adapter/Adapters/Revit/Elements/PipeDesignData.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,16 @@ The C# class definition is available on github:
4747
- [PipeDesignData.cs](https://github.com/BHoM/Revit_Toolkit/blob/develop/Revit_oM/Elements\PipeDesignData.cs)
4848

4949
All history and changes of the class can be found by inspection the history.
50+
### JSON Schema implementation
51+
52+
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/).
53+
54+
``` json title="JSON Schema"
55+
{
56+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Revit_oM/Elements/PipeDesignData.json"
57+
}
58+
```
59+
60+
The JSON Schema is available on github here:
61+
62+
- [PipeDesignData.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/Revit_oM/Elements/PipeDesignData.json)

‎docs/oM/Adapter/Adapters/Revit/Elements/PipeSize.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,16 @@ The C# class definition is available on github:
5959
- [PipeSize.cs](https://github.com/BHoM/Revit_Toolkit/blob/develop/Revit_oM/Elements\PipeSize.cs)
6060

6161
All history and changes of the class can be found by inspection the history.
62+
### JSON Schema implementation
63+
64+
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/).
65+
66+
``` json title="JSON Schema"
67+
{
68+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Revit_oM/Elements/PipeSize.json"
69+
}
70+
```
71+
72+
The JSON Schema is available on github here:
73+
74+
- [PipeSize.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/Revit_oM/Elements/PipeSize.json)

‎docs/oM/Adapter/Adapters/Revit/Parameters/ParameterDefinition.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The following properties are defined on the class
3333
| Instance | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, the Revit parameter represented by this object is an instance parameter, otherwise it is a type parameter. | - |
3434
| Categories | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | Categories, to which the Revit parameter represented by this object is bound. On Push, it will get bound to all categories if this value is null. | - |
3535
| Shared | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | If true, the Revit parameter represented by this object is a shared parameter, otherwise it is a project parameter. | - |
36+
| Guid | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Unique identifier of the Revit parameter for a shared parameter. Only relevant on pull, can't be set on Push. | - |
3637

3738

3839
### Inherited properties

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,16 @@ The C# class definition is available on github:
4949
- [FacadeCondensationRiskCommand.cs](https://github.com/BHoM/LadybugTools_Toolkit/blob/develop/LadybugTools_oM/ExecuteCommands\FacadeCondensationRiskCommand.cs)
5050

5151
All history and changes of the class can be found by inspection the history.
52+
### JSON Schema implementation
53+
54+
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/).
55+
56+
``` json title="JSON Schema"
57+
{
58+
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/LadybugTools_oM/FacadeCondensationRiskCommand.json"
59+
}
60+
```
61+
62+
The JSON Schema is available on github here:
63+
64+
- [FacadeCondensationRiskCommand.json](https://github.com/BHoM/BHoM_JSONSchema/blob/develop/LadybugTools_oM/FacadeCondensationRiskCommand.json)

0 commit comments

Comments
 (0)