Merge pull request #11 from BHoM/automatic-api-updates

adecler · web-flow · commit ddef9e86f8ef · 2025-11-30T09:06:58.000Z
API Updates
diff --git a/docs/oM/Adapter/Adapters/GSA/Elements/Joint.md b/docs/oM/Adapter/Adapters/GSA/Elements/Joint.md
@@ -0,0 +1,67 @@
+---
+title: Joint
+---
+
+# <small>BH.oM.Adapters.GSA.Elements.</small>**Joint**
+
+A joint describing linked degrees of freedom between nodes. Relates the displacement or force at the constrained degree of freedom to the primary degree of freedom without considering eccentricities.
+
+## Class structure
+
+### Implemented interfaces and base types
+
+???+ bhom "The Joint is inheriting from the following base type(s) and implements the following interfaces:"
+
+    -  BH.oM.Base.[BHoMObject](/api/oM/Framework/Base/BHoMObject)
+    -  BH.oM.Base.[IBHoMObject](/api/oM/Framework/Base/Interface/IBHoMObject)
+    -  BH.oM.Base.[IObject](/api/oM/Framework/Base/Interface/IObject)
+
+
+## Properties
+
+
+
+### Defining properties
+
+The following properties are defined on the class
+
+| Name             | Type             | Description      | Quantity         |
+|------------------|------------------|------------------|------------------|
+| PrimaryNode | [Node](/api/oM/Analytical/Structure/Elements/Node) | Defines the primary node of the joint. | - |
+| ConstrainedNode | [Node](/api/oM/Analytical/Structure/Elements/Node) | Defines the constrained node of the joint. | - |
+| X | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | True defines a rigid connectivity between primary and constrained node for translations along the X-axis, i.e. true prohibits relative translation along the X-axis between primary and constrained node. | - |
+| Y | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | True defines a rigid connectivity between primary and constrained node for translations along the Y-axis, i.e. true prohibits relative translation along the Y-axis between primary and constrained node. | - |
+| Z | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | True defines a rigid connectivity between primary and constrained node for translations along the Z-axis, i.e. true prohibits relative translation along the Z-axis between primary and constrained node. | - |
+| XX | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | True defines a rigid connectivity between primary and constrained node for rotations about the X-axis, i.e. true prohibits relative rotation about the X-axis between primary and constrained node. | - |
+| YY | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | True defines a rigid connectivity between primary and constrained node for rotations about the Y-axis, i.e. true prohibits relative rotation about the Y-axis between primary and constrained node. | - |
+| ZZ | [bool](https://learn.microsoft.com/en-us/dotnet/api/System.Boolean?view=netstandard-2.0) | True defines a rigid connectivity between primary and constrained node for rotations about the Z-axis, i.e. true prohibits relative rotation about the Z-axis between primary and constrained node. | - |
+| StageList | [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; | List of analysis stages where the joint should be active as a list of integers. If none specified 'all' will be applied. | - |
+
+
+### Inherited properties
+The following properties are inherited from the base class of the object
+
+| Name             | Type             | Description      | Quantity         |
+|------------------|------------------|------------------|------------------|
+| BHoM_Guid | [Guid](https://learn.microsoft.com/en-us/dotnet/api/System.Guid?view=netstandard-2.0) | - | - |
+| Name | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | - | - |
+| Fragments | [FragmentSet](/api/oM/Framework/Base/FragmentSet) | - | - |
+| 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; | - | - |
+| 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; | - | - |
+
+
+## Code and Schema
+
+### C# implementation
+
+``` C# title="C#"
+public class Joint : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject
+```
+
+Assembly: GSA_oM.dll
+
+The C# class definition is available on github:
+
+- [Joint.cs](https://github.com/BHoM/GSA_Toolkit/blob/develop/GSA_oM/Elements\Joint.cs)
+
+All history and changes of the class can be found by inspection the history.
diff --git a/docs/oM/Adapter/Adapters/Revit/Misc/ClonedType.md b/docs/oM/Adapter/Adapters/Revit/Misc/ClonedType.md
@@ -27,7 +27,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| SourceTypeId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the source Revit type to be cloned. | - |
+| SourceTypeId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the source Revit type to be cloned. | - |
 
 
 ### Inherited properties
diff --git a/docs/oM/Adapter/Adapters/Revit/Parameters/RevitIdentifiers.md b/docs/oM/Adapter/Adapters/Revit/Parameters/RevitIdentifiers.md
@@ -29,14 +29,14 @@ The following properties are defined on the class
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
 | PersistentId | [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0) | The PersistentId property stores the UniqueId of the Revit element correspondent to the BHoM object that owns this fragment. The PersistentId can be used for Diffing purposes. | - |
-| ElementId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the Revit element correspondent to the BHoM object that carries this fragment. | - |
+| ElementId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the Revit element correspondent to the BHoM object that carries this fragment. | - |
 | CategoryName | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Category of the Revit element correspondent to the BHoM object that carries this fragment. | - |
 | FamilyName | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Family of the Revit element correspondent to the BHoM object that carries this fragment. | - |
 | FamilyTypeName | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Family type of the Revit element correspondent to the BHoM object that carries this fragment. | - |
-| FamilyTypeId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of family type of the Revit element correspondent to the BHoM object that carries this fragment. | - |
+| FamilyTypeId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of family type of the Revit element correspondent to the BHoM object that carries this fragment. | - |
 | Workset | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Name of the parent workset of the Revit element correspondent to the BHoM object that carries this fragment. Empty if the Revit model is not shared. | - |
-| OwnerViewId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of view that owns the Revit element correspondent to the BHoM object that carries this fragment. -1 if the Revit element is not view-dependent. | - |
-| ParentElementId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the parent element of the Revit element correspondent to the BHoM object that carries this fragment. -1 if the Revit element is not a nested element. | - |
+| OwnerViewId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of view that owns the Revit element correspondent to the BHoM object that carries this fragment. -1 if the Revit element is not view-dependent. | - |
+| ParentElementId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the parent element of the Revit element correspondent to the BHoM object that carries this fragment. -1 if the Revit element is not a nested element. | - |
 | LinkDocument | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Name of the link document containing the Revit element correspondent to the BHoM object that carries this fragment. Empty if the Revit element is not a link element. | - |
 
 
diff --git a/docs/oM/Adapter/Adapters/Revit/Requests/FilterByElementIds.md b/docs/oM/Adapter/Adapters/Revit/Requests/FilterByElementIds.md
@@ -26,7 +26,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| ElementIds | [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; | List of integers representing Revit ElementIds to be used to filter the elements. | - |
+| ElementIds | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0)&gt; | List of integers representing Revit ElementIds to be used to filter the elements. | - |
 
 
 ### Derived properties
diff --git a/docs/oM/Adapter/Adapters/Revit/Requests/FilterByFamilyType.md b/docs/oM/Adapter/Adapters/Revit/Requests/FilterByFamilyType.md
@@ -26,7 +26,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| FamilyTypeId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the Revit family type. | - |
+| FamilyTypeId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the Revit family type. | - |
 
 
 ### Derived properties
diff --git a/docs/oM/Adapter/Adapters/Revit/Requests/FilterByViewSpecific.md b/docs/oM/Adapter/Adapters/Revit/Requests/FilterByViewSpecific.md
@@ -26,7 +26,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| ViewId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the owner view in Revit. | - |
+| ViewId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the owner view in Revit. | - |
 
 
 ### Derived properties
diff --git a/docs/oM/Adapter/Adapters/Revit/Requests/FilterByVisibleInView.md b/docs/oM/Adapter/Adapters/Revit/Requests/FilterByVisibleInView.md
@@ -26,7 +26,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| ViewId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of Revit view to be checked for element visibility. | - |
+| ViewId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of Revit view to be checked for element visibility. | - |
 
 
 ### Derived properties
diff --git a/docs/oM/Adapter/Adapters/Revit/Requests/FilterMemberElements.md b/docs/oM/Adapter/Adapters/Revit/Requests/FilterMemberElements.md
@@ -26,7 +26,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| ParentId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the Revit element that contains member elements. | - |
+| ParentId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the Revit element that contains member elements. | - |
 
 
 ### Derived properties
diff --git a/docs/oM/Adapter/Adapters/Revit/Requests/FilterTypesOfFamily.md b/docs/oM/Adapter/Adapters/Revit/Requests/FilterTypesOfFamily.md
@@ -26,7 +26,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| FamilyId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the Revit family, which types are being queried. | - |
+| FamilyId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the Revit family, which types are being queried. | - |
 
 
 ### Derived properties
diff --git a/docs/oM/Adapter/Adapters/Revit/Requests/FilterViewsByTemplate.md b/docs/oM/Adapter/Adapters/Revit/Requests/FilterViewsByTemplate.md
@@ -26,7 +26,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| TemplateId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the Revit view template. | - |
+| TemplateId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the Revit view template. | - |
 
 
 ### Derived properties
diff --git a/docs/oM/Adapter/Revit/Misc/RevitHostFragment.md b/docs/oM/Adapter/Revit/Misc/RevitHostFragment.md
@@ -27,7 +27,7 @@ The following properties are defined on the class
 
 | Name             | Type             | Description      | Quantity         |
 |------------------|------------------|------------------|------------------|
-| HostId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | ElementId of the Revit element that hosts the Revit element correspondent to the BHoM object that carries this. | - |
+| HostId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | ElementId of the Revit element that hosts the Revit element correspondent to the BHoM object that carries this. | - |
 | LinkDocument | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Name of the link document, if the host Revit element is linked. | - |
 
 
diff --git a/docs/oM/Framework/Base/BHoMObject.md b/docs/oM/Framework/Base/BHoMObject.md
@@ -214,6 +214,7 @@ title: BHoMObject
     - BH.oM.Adapters.GSA.MaterialFragments.[Fabric](/api/oM/Adapter/Adapters/GSA/MaterialFragments/Fabric)
     - BH.oM.Adapters.GSA.FormFindingProperties.[SoapStress1D](/api/oM/Adapter/Adapters/GSA/FormFindingProperties/SoapStress1D)
     - BH.oM.Adapters.GSA.FormFindingProperties.[SoapStress2D](/api/oM/Adapter/Adapters/GSA/FormFindingProperties/SoapStress2D)
+    - BH.oM.Adapters.GSA.Elements.[Joint](/api/oM/Adapter/Adapters/GSA/Elements/Joint)
     - BH.oM.Adapters.GSA.Elements.[RigidConstraint](/api/oM/Adapter/Adapters/GSA/Elements/RigidConstraint)
     - BH.oM.Adapters.GSA.Elements.[Spacer](/api/oM/Adapter/Adapters/GSA/Elements/Spacer)
     - BH.oM.Adapters.GSA.Analysis.[AnalysisStage](/api/oM/Adapter/Adapters/GSA/Analysis/AnalysisStage)
@@ -746,7 +747,7 @@ The following properties are defined as extension methods in one of the BHoM_Eng
 | AdapterIds | [object](https://learn.microsoft.com/en-us/dotnet/api/System.Object?view=netstandard-2.0) | Returns the BHoMObject's Id of the provided FragmentType. If more than one matching IdFragment is found, the method returns a List of all Ids of that type.If none is found, `null` is returned. | - | Adapter_Engine |
 | CategoryName | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Gets Revit category name from BHoMObject. | - | Revit_Engine |
 | DeepClone | T | - | - | BHoM_Engine |
-| ElementId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | Returns integer representation of ElementId of Revit element correspondent to given BHoMObject. This value is stored in RevitIdentifiers fragment. | - | Revit_Engine |
+| ElementId | [long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0) | Returns integer representation of ElementId of Revit element correspondent to given BHoMObject. This value is stored in RevitIdentifiers fragment. | - | Revit_Engine |
 | EnumValues | [IEnumerable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1?view=netstandard-2.0)&lt;T&gt; | - | - | Reflection_Engine |
 | ExplicitBulk | [ExplicitBulk](/api/oM/Physical/Physical/Elements/ExplicitBulk) | Queries the material take off information stored as a fragment on the object and return it as an ExplicitBulk element. This could be data extracted from an external package such as Revit and stored in VolumetricMaterialTakeoff fragment attached to a given BHoMObject when pulled. | - | Matter_Engine |
 | FamilyName | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Gets the name of Revit family correspondent to given BHoMObject. This value is stored in  RevitIdentifiers fragment. | - | Revit_Engine |
@@ -758,7 +759,7 @@ The following properties are defined as extension methods in one of the BHoM_Eng
 | GetRevitParameters | [List](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1?view=netstandard-2.0)&lt;[RevitParameter](/api/oM/Adapter/Adapters/Revit/Parameters/RevitParameter)&gt; | Retrieves parameters that are attached to a BHoM object. If a parameter with given name exists in both collections of pulled parameters and the ones to push, the latter is returned. | - | Revit_Engine |
 | GSAId | [int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0) | - | - | GSA_Engine |
 | Hash | [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0) | Computes a Hash code for the iObject. The hash uniquely represents an object's state, based on its properties and their values. It can be used for comparisons.<br>You can change how the hash is computed by changing the settings in the ComparisonConfig. | - | BHoM_Engine |
-| HostInformation | [Output](/api/oM/Framework/Base/Output)&lt;[int](https://learn.microsoft.com/en-us/dotnet/api/System.Int32?view=netstandard-2.0), [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | Returns integer representation of ElementId of Revit element that hosts the element correspondent to given BHoMObject, along with name of the link document, if the host Revit element is linked. This value is stored in RevitHostFragment fragment. | - | Revit_Engine |
+| HostInformation | [Output](/api/oM/Framework/Base/Output)&lt;[long](https://learn.microsoft.com/en-us/dotnet/api/System.Int64?view=netstandard-2.0), [string](https://learn.microsoft.com/en-us/dotnet/api/System.String?view=netstandard-2.0)&gt; | Returns integer representation of ElementId of Revit element that hosts the element correspondent to given BHoMObject, along with name of the link document, if the host Revit element is linked. This value is stored in RevitHostFragment fragment. | - | Revit_Engine |
 | Identifier | [IComparable](https://learn.microsoft.com/en-us/dotnet/api/System.IComparable?view=netstandard-2.0) | Queries identifier (BHoM_Guid) of IBHoMObject to be used to identify the object when processing verification results. | - | Verification_Engine |
 | IGeometry | [IGeometry](/api/oM/Dimensional/Geometry/Interface/IGeometry) | - | - | BHoM_Engine |
 | IGeometry3D | [IGeometry](/api/oM/Dimensional/Geometry/Interface/IGeometry) | Queries a three-dimensional geometry out of an IObject, if available. This geometry may be used for downstream tasks such as graphical representation, volume determination, or others. | - | BHoM_Engine |
diff --git a/docs/oM/Framework/Base/Interface/IBHoMObject.md b/docs/oM/Framework/Base/Interface/IBHoMObject.md
diff --git a/docs/oM/Framework/Base/Interface/IInitialisationSettings.md b/docs/oM/Framework/Base/Interface/IInitialisationSettings.md
diff --git a/docs/oM/Framework/Base/Interface/IObject.md b/docs/oM/Framework/Base/Interface/IObject.md
