BH.oM.Adapters.GSA.Elements.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¶
The Joint is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| PrimaryNode | Node | Defines the primary node of the joint. | - |
| ConstrainedNode | Node | Defines the constrained node of the joint. | - |
| X | bool | 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 | 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 | 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 | 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 | 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 | 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<int> | 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 | - | - |
| Name | string | - | - |
| Fragments | FragmentSet | - | - |
| Tags | HashSet<string> | - | - |
| CustomData | Dictionary<string, object> | - | - |
Code and Schema¶
C# implementation¶
Assembly: GSA_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.