## On this page
# Class ShaftSetAPI
Last update: 16.07.2025
Namespace: [VM.API.Pre.GearTrain](VM.API.Pre.GearTrain.md)
Assembly: VM.API.Pre.GearTrain.dll
This class implements APIs for , and class.
```csharp
public static class ShaftSetAPI
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ← [ShaftSetAPI](VM.API.Pre.GearTrain.ShaftSetAPI.md)
#### Extension Methods
[LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)
## Methods
### AddBearingToRBEInEFEntity(HiddenDocumentMeshFreeBase, string, string, Vector, Obj, ClearanceParameters?)
Add bearing to rbe in EF entity.
```csharp
[MatchTypeObj(new object[] { "connectable", typeof(IConnectable) })]
public static void AddBearingToRBEInEFEntity(this HiddenDocumentMeshFreeBase document, string bearingName, string racewayName, Vector direction, Obj connectable, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to add bearing.
`bearingName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The bearing name.
`racewayName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The raceway name.
`direction` Vector
The z-axis.
`connectable` Obj
The start rbe. The type is
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'bearingName' or 'racewayName' or 'connectable' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddBearingToRBEInEFEntity(HiddenDocumentMeshFreeBase, Obj, RacewayType, Vector, Obj, ClearanceParameters?)
Add bearing to rbe in EF entity.
```csharp
[NotNullObj(new string[] { "bearing", "connectable" })]
[MatchTypeObj(new object[] { "bearing", typeof(Bearing), "connectable", typeof(IConnectable) })]
public static void AddBearingToRBEInEFEntity(this HiddenDocumentMeshFreeBase document, Obj bearing, RacewayGeometryInfo.RacewayType racewayType, Vector direction, Obj connectable, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to add bearing.
`bearing` Obj
The bearing. The type is .
`racewayType` RacewayGeometryInfo.RacewayType
The raceway type.
`direction` Vector
The z-axis.
`connectable` Obj
The start rbe. The type is .
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'bearing' or 'connectable' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'bearing' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddBearingToRBEInFEEntity(HiddenDocumentFEBase, string, string, Vector, Obj, ClearanceParameters?)
Add bearing to rbe in FE entity.
```csharp
[MatchTypeObj(new object[] { "connectable", typeof(IConnectable) })]
public static void AddBearingToRBEInFEEntity(this HiddenDocumentFEBase document, string bearingName, string racewayName, Vector direction, Obj connectable, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenDocumentFEBase
The document to add bearing.
`bearingName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The bearing name.
`racewayName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The raceway name.
`direction` Vector
The z-axis.
`connectable` Obj
The start rbe. The type is
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'bearingName' or 'racewayName' or 'connectable' arguments are empty.
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if type of 'connectable' is not .
### AddBearingToRBEInFEEntity(HiddenDocumentFEBase, Obj, RacewayType, Vector, Obj, ClearanceParameters?)
Add bearing to rbe in FE entity.
```csharp
[NotNullObj(new string[] { "bearing", "connectable" })]
[MatchTypeObj(new object[] { "bearing", typeof(Bearing), "connectable", typeof(IConnectable) })]
public static void AddBearingToRBEInFEEntity(this HiddenDocumentFEBase document, Obj bearing, RacewayGeometryInfo.RacewayType racewayType, Vector direction, Obj connectable, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenDocumentFEBase
The document to add bearing.
`bearing` Obj
The bearing. The type is .
`racewayType` RacewayGeometryInfo.RacewayType
The raceway type.
`direction` Vector
The z-axis.
`connectable` Obj
The start rbe. The type is
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'bearing' or 'connectable' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'bearing' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddBearingToShaftset(HiddenShaftSetDocument, string, string, ExpressionValueVariable?, AttachLocationType, DirectionType, ClearanceParameters?)
Add bearing to shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "bearingName", "racewayName" })]
public static void AddBearingToShaftset(this HiddenShaftSetDocument document, string bearingName, string racewayName, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, DirectionType direction = DirectionType.Forward, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add bearing.
`bearingName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The bearing name.
`racewayName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The raceway name.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft. The default value is Left
`direction` [DirectionType](VM.API.Pre.GearTrain.DirectionType.md)
The direction type. The default value is Forward
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'bearingName' or 'racewayName' arguments are empty.
### AddBearingToShaftset(HiddenShaftSetDocument, Obj, RacewayType, ExpressionValueVariable?, AttachLocationType, DirectionType, ClearanceParameters?)
Add bearing to shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "bearing" })]
[MatchTypeObj(new object[] { "bearing", typeof(Bearing) })]
public static void AddBearingToShaftset(this HiddenShaftSetDocument document, Obj bearing, RacewayGeometryInfo.RacewayType racewayType, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, DirectionType direction = DirectionType.Forward, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add bearing.
`bearing` Obj
The bearing. The type is .
`racewayType` RacewayGeometryInfo.RacewayType
The raceway type.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft. The default value is Left
`direction` [DirectionType](VM.API.Pre.GearTrain.DirectionType.md)
The direction type. The default value is Forward
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'bearing' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'bearing' is not .
### AddGearToRBEInEFEntity(HiddenDocumentMeshFreeBase, string, string, Vector, Obj, ShaftAttachType, ExpressionValueVariable?, AttachLocationType, Obj?, RacewayType, ExpressionValueVariable?, AttachLocationType, ClearanceParameters?)
Add gear to rbe in EF entity.
```csharp
public static void AddGearToRBEInEFEntity(this HiddenDocumentMeshFreeBase document, string gearSetName, string gearName, Vector direction, Obj connectable, ShaftAttachType shaftAttach = ShaftAttachType.Shaft, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, Obj? bearing = null, RacewayGeometryInfo.RacewayType racewayType = RacewayType.Inner, ExpressionValueVariable? bearingOffset = null, AttachLocationType bearingLocation = AttachLocationType.Left, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to add gear.
`gearSetName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear set name.
`gearName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear name.
`direction` Vector
The z-axis.
`connectable` Obj
The rbe. The type is
`shaftAttach` [ShaftAttachType](VM.API.Pre.GearTrain.ShaftAttachType.md)
The attach type. The default value is Shaft.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft. The default value is Left.
`bearing` Obj?
The bearing.
`racewayType` RacewayGeometryInfo.RacewayType
The bearing raceway type.
`bearingOffset` ExpressionValueVariable?
The offset when attached to bearing. The default value is 0.0.
`bearingLocation` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to bearing. The default value is Left.
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetName' or 'gearName' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddGearToRBEInEFEntity(HiddenDocumentMeshFreeBase, Obj, int, Vector, Obj, ShaftAttachType, ExpressionValueVariable?, AttachLocationType, Obj?, RacewayType, ExpressionValueVariable?, AttachLocationType, ClearanceParameters?)
Add gear to rbe in EF entity.
```csharp
[NotNullObj(new string[] { "gearset" })]
[GreaterThanOrEqualToZero(new string[] { "gearIndex" })]
public static void AddGearToRBEInEFEntity(this HiddenDocumentMeshFreeBase document, Obj gearset, int gearIndex, Vector direction, Obj connectable, ShaftAttachType shaftAttach = ShaftAttachType.Shaft, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, Obj? bearing = null, RacewayGeometryInfo.RacewayType racewayType = RacewayType.Inner, ExpressionValueVariable? bearingOffset = null, AttachLocationType bearingLocation = AttachLocationType.Left, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to add gear.
`gearset` Obj
The gear set. The type is .
`gearIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The gear index. The value is zero base.
`direction` Vector
The z-axis.
`connectable` Obj
The rbe. The type is
`shaftAttach` [ShaftAttachType](VM.API.Pre.GearTrain.ShaftAttachType.md)
The attach type. The default value is Shaft.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft. The default value is Left.
`bearing` Obj?
The bearing.
`racewayType` RacewayGeometryInfo.RacewayType
The bearing raceway type.
`bearingOffset` ExpressionValueVariable?
The offset when attached to bearing. The default value is 0.0.
`bearingLocation` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to bearing. The default value is Left.
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearset' arguments are empty.
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Will be thrown if 'gearIndex' is less than zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'gearIndex' is greater than or equal to gear's count.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'gearset' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddGearToRBEInFEEntity(HiddenDocumentFEBase, string, string, Vector, Obj, ShaftAttachType, ExpressionValueVariable?, AttachLocationType, Obj?, RacewayType, ExpressionValueVariable?, AttachLocationType, ClearanceParameters?)
Add gear to rbe in FE entity.
```csharp
public static void AddGearToRBEInFEEntity(this HiddenDocumentFEBase document, string gearSetName, string gearName, Vector direction, Obj connectable, ShaftAttachType shaftAttach = ShaftAttachType.Shaft, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, Obj? bearing = null, RacewayGeometryInfo.RacewayType racewayType = RacewayType.Inner, ExpressionValueVariable? bearingOffset = null, AttachLocationType bearingLocation = AttachLocationType.Left, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenDocumentFEBase
The document to add gear.
`gearSetName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear set name.
`gearName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear name.
`direction` Vector
The z-axis.
`connectable` Obj
The rbe. The type is
`shaftAttach` [ShaftAttachType](VM.API.Pre.GearTrain.ShaftAttachType.md)
The attach type. The default value is Shaft.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft.The default value is Left.
`bearing` Obj?
The bearing.
`racewayType` RacewayGeometryInfo.RacewayType
The bearing raceway type.
`bearingOffset` ExpressionValueVariable?
The offset when attached to bearing. The default value is 0.0.
`bearingLocation` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to bearing. The default value is Left.
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetName' or 'gearName' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddGearToRBEInFEEntity(HiddenDocumentFEBase, Obj, int, Vector, Obj, ShaftAttachType, ExpressionValueVariable?, AttachLocationType, Obj?, RacewayType, ExpressionValueVariable?, AttachLocationType, ClearanceParameters?)
Add gear to rbe in FE entity.
```csharp
[NotNullObj(new string[] { "gearset" })]
[GreaterThanOrEqualToZero(new string[] { "gearIndex" })]
public static void AddGearToRBEInFEEntity(this HiddenDocumentFEBase document, Obj gearset, int gearIndex, Vector direction, Obj connectable, ShaftAttachType shaftAttach = ShaftAttachType.Shaft, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, Obj? bearing = null, RacewayGeometryInfo.RacewayType racewayType = RacewayType.Inner, ExpressionValueVariable? bearingOffset = null, AttachLocationType bearingLocation = AttachLocationType.Left, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenDocumentFEBase
The document to add gear.
`gearset` Obj
The gear set. The type is .
`gearIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The gear index. The value is zero base.
`direction` Vector
The z-axis.
`connectable` Obj
The rbe. The type is
`shaftAttach` [ShaftAttachType](VM.API.Pre.GearTrain.ShaftAttachType.md)
The attach type. The default value is Shaft.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft.The default value is Left.
`bearing` Obj?
The bearing.
`racewayType` RacewayGeometryInfo.RacewayType
The bearing raceway type.
`bearingOffset` ExpressionValueVariable?
The offset when attached to bearing. The default value is 0.0.
`bearingLocation` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to bearing. The default value is Left.
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearset' arguments are empty.
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Will be thrown if 'gearIndex' is less than zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'gearIndex' is greater than or equal to gear's count.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'gearset' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddGearToShaftset(HiddenShaftSetDocument, string, string, ShaftAttachType, ExpressionValueVariable?, AttachLocationType, Obj?, RacewayType, ExpressionValueVariable?, AttachLocationType, ClearanceParameters?)
Add gear to shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "gearSetName", "gearName" })]
public static void AddGearToShaftset(this HiddenShaftSetDocument document, string gearSetName, string gearName, ShaftAttachType shaftAttach = ShaftAttachType.Shaft, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, Obj? bearing = null, RacewayGeometryInfo.RacewayType racewayType = RacewayType.Inner, ExpressionValueVariable? bearingOffset = null, AttachLocationType bearingLocation = AttachLocationType.Left, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add gear.
`gearSetName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear set name.
`gearName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear name.
`shaftAttach` [ShaftAttachType](VM.API.Pre.GearTrain.ShaftAttachType.md)
The attach type. The default value is Shaft.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft. The default value is Left
`bearing` Obj?
The bearing.
`racewayType` RacewayGeometryInfo.RacewayType
The bearing raceway type.
`bearingOffset` ExpressionValueVariable?
The offset when attached to bearing. The default value is 0.0
`bearingLocation` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to bearing. The default value is Left
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetName' or 'gearName' arguments are empty.
### AddGearToShaftset(HiddenShaftSetDocument, Obj, int, ShaftAttachType, ExpressionValueVariable?, AttachLocationType, Obj?, RacewayType, ExpressionValueVariable?, AttachLocationType, ClearanceParameters?)
Add gear to shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearSet" })]
[GreaterThanOrEqualToZero(new string[] { "gearIndex" })]
[MatchTypeObj(new object[] { "gearSet", typeof(IGearSet) })]
public static void AddGearToShaftset(this HiddenShaftSetDocument document, Obj gearSet, int gearIndex, ShaftAttachType shaftAttach = ShaftAttachType.Shaft, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, Obj? bearing = null, RacewayGeometryInfo.RacewayType racewayType = RacewayType.Inner, ExpressionValueVariable? bearingOffset = null, AttachLocationType bearingLocation = AttachLocationType.Left, ClearanceParameters? clearanceParameters = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add gear.
`gearSet` Obj
The gear set. The type is .
`gearIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The gear index. The value is zero base.
`shaftAttach` [ShaftAttachType](VM.API.Pre.GearTrain.ShaftAttachType.md)
The attach type. The default value is Shaft.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft. The default value is Left
`bearing` Obj?
The bearing.
`racewayType` RacewayGeometryInfo.RacewayType
The bearing raceway type.
`bearingOffset` ExpressionValueVariable?
The offset when attached to bearing. The default value is 0.0
`bearingLocation` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to bearing. The default value is Left
`clearanceParameters` [ClearanceParameters](VM.API.Pre.GearTrain.ClearanceParameters.md)?
The clearance parameter. If it is not given, default values will be used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSet' arguments are empty.
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Will be thrown if 'gearIndex' is less than zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'gearIndex' is greater than or equal to gear's count.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'gearset' is not .
### AddRackToRBEInEFEntity(HiddenDocumentMeshFreeBase, string, string, Vector, Obj, Obj, bool, bool, ExpressionValueVariable?)
Add rack to rbe in EF entity.
```csharp
public static void AddRackToRBEInEFEntity(this HiddenDocumentMeshFreeBase document, string gearSetName, string gearName, Vector direction, Obj connectableStart, Obj connectableEnd, bool useStart = true, bool useEnd = true, ExpressionValueVariable? initialAngle = null)
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to add gear.
`gearSetName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear set name.
`gearName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear name.
`direction` Vector
The z-axis.
`connectableStart` Obj
The start rbe. The type is
`connectableEnd` Obj
The end rbe. The type is
`useStart` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether using start rbe.
`useEnd` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether using end rbe.
`initialAngle` ExpressionValueVariable?
The initial angle. The default value is 0.0.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetName' or 'gearName' or 'connectableStart' or 'connectableEnd' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectableStart' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectableEnd' is not .
### AddRackToRBEInEFEntity(HiddenDocumentMeshFreeBase, Obj, int, Vector, Obj, Obj, bool, bool, ExpressionValueVariable?)
Add rack to rbe in EF entity.
```csharp
[NotNullObj(new string[] { "gearSetRackAndPinion", "connectableStart", "connectableEnd" })]
[GreaterThanOrEqualToZero(new string[] { "gearIndex" })]
public static void AddRackToRBEInEFEntity(this HiddenDocumentMeshFreeBase document, Obj gearSetRackAndPinion, int gearIndex, Vector direction, Obj connectableStart, Obj connectableEnd, bool useStart = true, bool useEnd = true, ExpressionValueVariable? initialAngle = null)
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to add gear.
`gearSetRackAndPinion` Obj
The gear set name. The type is .
`gearIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The gear name.
`direction` Vector
The z-axis.
`connectableStart` Obj
The start rbe. The type is
`connectableEnd` Obj
The end rbe. The type is
`useStart` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether using start rbe.
`useEnd` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether using end rbe.
`initialAngle` ExpressionValueVariable?
The initial angle. The default value is 0.0.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetName' or 'gearName' or 'connectableStart' or 'connectableEnd' arguments are empty.
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Will be thrown if 'gearIndex' is less than zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'gearIndex' is greater than or equal to gear's count.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'gearSetRackAndPinion' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectableStart' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectableEnd' is not .
### AddRackToRBEInFEEntity(HiddenDocumentFEBase, string, string, Vector, Obj, Obj, bool, bool, ExpressionValueVariable?)
Add gear to rack in FE entity.
```csharp
public static void AddRackToRBEInFEEntity(this HiddenDocumentFEBase document, string gearSetName, string gearName, Vector direction, Obj connectableStart, Obj connectableEnd, bool useStart = true, bool useEnd = true, ExpressionValueVariable? initialAngle = null)
```
#### Parameters
`document` HiddenDocumentFEBase
The document to add gear.
`gearSetName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear set name.
`gearName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear name.
`direction` Vector
The z-axis.
`connectableStart` Obj
The start rbe. The type is
`connectableEnd` Obj
The end rbe. The type is
`useStart` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether using start rbe.
`useEnd` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether using end rbe.
`initialAngle` ExpressionValueVariable?
The initial angle. The default value is 0.0.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetName' or 'gearName' or 'connectableStart' or 'connectableEnd' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectableStart' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectableEnd' is not .
### AddRackToRBEInFEEntity(HiddenDocumentFEBase, Obj, int, Vector, Obj, Obj, bool, bool, ExpressionValueVariable?)
Add gear to rack in FE entity.
```csharp
[NotNullObj(new string[] { "gearSetRackAndPinion", "connectableStart", "connectableEnd" })]
[GreaterThanOrEqualToZero(new string[] { "gearIndex" })]
public static void AddRackToRBEInFEEntity(this HiddenDocumentFEBase document, Obj gearSetRackAndPinion, int gearIndex, Vector direction, Obj connectableStart, Obj connectableEnd, bool useStart = true, bool useEnd = true, ExpressionValueVariable? initialAngle = null)
```
#### Parameters
`document` HiddenDocumentFEBase
The document to add gear.
`gearSetRackAndPinion` Obj
The gear set name. The type is .
`gearIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The gear name.
`direction` Vector
The z-axis.
`connectableStart` Obj
The start rbe. The type is
`connectableEnd` Obj
The end rbe. The type is
`useStart` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether using start rbe.
`useEnd` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether using end rbe.
`initialAngle` ExpressionValueVariable?
The initial angle. The default value is 0.0.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetRackAndPinion' or 'connectableStart' or 'connectableEnd' arguments are empty.
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Will be thrown if 'gearIndex' is less than zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'gearIndex' is greater than or equal to gear's count.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'gearSetRackAndPinion' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectableStart' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectableEnd' is not .
### AddRackToShaftset(HiddenShaftSetDocument, string, string, ExpressionValueVariable?)
Add rack to shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "gearSetName", "gearName" })]
public static void AddRackToShaftset(this HiddenShaftSetDocument document, string gearSetName, string gearName, ExpressionValueVariable? initialAngle = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add rack.
`gearSetName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The gear set name.
`gearName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The rack name.
`initialAngle` ExpressionValueVariable?
The initial angle. The default value is 0.0.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetName' or 'gearName' arguments are empty.
### AddRackToShaftset(HiddenShaftSetDocument, Obj, int, ExpressionValueVariable?)
Add rack to shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearSetRackAndPinion" })]
[GreaterThanOrEqualToZero(new string[] { "gearIndex" })]
[MatchTypeObj(new object[] { "gearSetRackAndPinion", typeof(GearSetRackAndPinion) })]
public static void AddRackToShaftset(this HiddenShaftSetDocument document, Obj gearSetRackAndPinion, int gearIndex, ExpressionValueVariable? initialAngle = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add rack.
`gearSetRackAndPinion` Obj
The rack and pinion gear set. The type is .
`gearIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The gear index. The value is zero base.
`initialAngle` ExpressionValueVariable?
The initial angle. The default value is 0.0.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSetRackAndPinion' arguments are empty.
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Will be thrown if 'gearIndex' is less than zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'gearIndex' is greater than or equal to gear's count.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'gearSetRackAndPinion' is not .
### AddSectionInSimpleShaftset(HiddenShaftSetDocument, ExpressionValueVariable?, CrossSectionType, IEnumerable, string)
Add section in simple shaftset.
```csharp
[NotNull(new string[] { "document" })]
public static void AddSectionInSimpleShaftset(this HiddenShaftSetDocument document, ExpressionValueVariable? length = null, CrossSectionType crossSection = CrossSectionType.CIRCULAR, IEnumerable diameters = null, string sectionName = "")
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add section.
`length` ExpressionValueVariable?
The added section length. The default value is 1.0.
`crossSection` [CrossSectionType](VM.API.Pre.GearTrain.CrossSectionType.md)
The cross section type. The default value is CIRCULAR
`diameters` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1)
The width when add to shaft. If it is null, default values based on cross section will be used.
`sectionName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the section. If empty, default name starts with 'Section\_' will be generated and used.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'crossSection' and 'diameters' argument do not match.
### AddSlidingBearingToRBEInEFEntity(HiddenDocumentMeshFreeBase, string, Obj, enSBContactType)
Add sliding bearing to rbe in EF entity.
```csharp
[MatchTypeObj(new object[] { "connectable", typeof(IConnectable) })]
public static void AddSlidingBearingToRBEInEFEntity(this HiddenDocumentMeshFreeBase document, string slidingBearingName, Obj connectable, enSBContactType contact = enSBContactType.OUTER_FIX)
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to add sliding bearing.
`slidingBearingName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The sliding bearing name.
`connectable` Obj
The rbe. The type is .
`contact` enSBContactType
The contact type. The default value is outer fix.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'slidingBearingName' or 'connectable' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddSlidingBearingToRBEInEFEntity(HiddenDocumentMeshFreeBase, Obj, Obj, enSBContactType)
Add sliding bearing to rbe in EF entity.
```csharp
[NotNullObj(new string[] { "slidingBearing", "connectable" })]
[MatchTypeObj(new object[] { "slidingBearing", typeof(SlidingBearing), "connectable", typeof(IConnectable) })]
public static void AddSlidingBearingToRBEInEFEntity(this HiddenDocumentMeshFreeBase document, Obj slidingBearing, Obj connectable, enSBContactType contact = enSBContactType.OUTER_FIX)
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to add sliding bearing.
`slidingBearing` Obj
The sliding bearing. The type is
`connectable` Obj
The rbe. The type is .
`contact` enSBContactType
The contact type. The default value is outer fix.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'slidingBearing' or 'connectable' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'slidingBearing' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddSlidingBearingToRBEInFEEntity(HiddenDocumentFEBase, string, Obj, enSBContactType)
Add sliding bearing to rbe in FE entity.
```csharp
[MatchTypeObj(new object[] { "connectable", typeof(IConnectable) })]
public static void AddSlidingBearingToRBEInFEEntity(this HiddenDocumentFEBase document, string slidingBearingName, Obj connectable, enSBContactType contact = enSBContactType.OUTER_FIX)
```
#### Parameters
`document` HiddenDocumentFEBase
The document to add sliding bearing.
`slidingBearingName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The sliding bearing name.
`connectable` Obj
The rbe. The type is .
`contact` enSBContactType
The contact type. The default value is outer fix.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'slidingBearingName' or 'connectable' arguments are empty.
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if type of 'connectable' is not .
### AddSlidingBearingToRBEInFEEntity(HiddenDocumentFEBase, Obj, Obj, enSBContactType)
Add sliding bearing to rbe in FE entity.
```csharp
[NotNullObj(new string[] { "slidingBearing", "connectable" })]
[MatchTypeObj(new object[] { "slidingBearing", typeof(SlidingBearing), "connectable", typeof(IConnectable) })]
public static void AddSlidingBearingToRBEInFEEntity(this HiddenDocumentFEBase document, Obj slidingBearing, Obj connectable, enSBContactType contact = enSBContactType.OUTER_FIX)
```
#### Parameters
`document` HiddenDocumentFEBase
The document to add sliding bearing.
`slidingBearing` Obj
The sliding bearing. The type is
`connectable` Obj
The rbe. The type is .
`contact` enSBContactType
The contact type. The default value is outer fix.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'slidingBearing' or 'connectable' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'slidingBearing' is not .
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### AddSlidingBearingToShaftset(HiddenShaftSetDocument, string, enSBContactType, ExpressionValueVariable?, AttachLocationType, ExpressionValueVariable?)
Add sliding bearing to shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "slidingBearingName" })]
public static void AddSlidingBearingToShaftset(this HiddenShaftSetDocument document, string slidingBearingName, enSBContactType contact = enSBContactType.INNER_CONTACT, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, ExpressionValueVariable? startAngle = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add sliding bearing.
`slidingBearingName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The sliding bearing name.
`contact` enSBContactType
The contact type. The default value is inner contact.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft. The default value is Left
`startAngle` ExpressionValueVariable?
The start angle. The default value is 0.0.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'slidingBearingName' arguments are empty.
### AddSlidingBearingToShaftset(HiddenShaftSetDocument, Obj, enSBContactType, ExpressionValueVariable?, AttachLocationType, ExpressionValueVariable?)
Add sliding bearing to shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "slidingBearing" })]
[MatchTypeObj(new object[] { "slidingBearing", typeof(SlidingBearing) })]
public static void AddSlidingBearingToShaftset(this HiddenShaftSetDocument document, Obj slidingBearing, enSBContactType contact = enSBContactType.INNER_CONTACT, ExpressionValueVariable? offset = null, AttachLocationType location = AttachLocationType.Left, ExpressionValueVariable? startAngle = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add sliding bearing.
`slidingBearing` Obj
The sliding bearing. The type is
`contact` enSBContactType
The contact type. The default value is inner contact.
`offset` ExpressionValueVariable?
The offset when attached to shaft. The default value is 0.0.
`location` [AttachLocationType](VM.API.Pre.GearTrain.AttachLocationType.md)
The location when attached to shaft. The default value is Left
`startAngle` ExpressionValueVariable?
The start angle. The default value is 0.0.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'slidingBearing' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'slidingBearing' is not .
### ComponentAnalysisInShaftSet(HiddenShaftSetDocument, bool)
Component analysis In simple shaftset designer.
```csharp
[NotNull(new string[] { "document" })]
public static void ComponentAnalysisInShaftSet(this HiddenShaftSetDocument document, bool openPost = false)
```
#### Parameters
`document` HiddenShaftSetDocument
The for simulate. If null, the active document will be used.
`openPost` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether opening post processor. The default value is false.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### ComponentAnalysisInShaftSet(HiddenDocumentMeshBase, bool)
Component analysis In simple shaftset designer.
```csharp
[NotNull(new string[] { "document" })]
public static void ComponentAnalysisInShaftSet(this HiddenDocumentMeshBase document, bool openPost = false)
```
#### Parameters
`document` HiddenDocumentMeshBase
The for simulate. If null, the active document will be used.
`openPost` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The flag for whether opening post processor. The default value is false.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### CreateConceptCarrier(GearTrainDocument, Obj, Vector?, Vector?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, PinionInstallMethodType, Obj?, Color?)
Create concept carrier.
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "gearSet" })]
[MatchTypeObj(new object[] { "gearSet", typeof(IGearSet) })]
public static void CreateConceptCarrier(this GearTrainDocument document, Obj gearSet, Vector? position = null, Vector? rotateAxis = null, ExpressionValueVariable? pinionShaftLength = null, ExpressionValueVariable? pinionShaftDiameter = null, ExpressionValueVariable? carrierThickness = null, PinionInstallMethodType pinionInstallMethodType = PinionInstallMethodType.Constraint, Obj? bearing = null, Color? color = null)
```
#### Parameters
`document` GearTrainDocument
The document to add concept carrier.
`gearSet` Obj
The planetary gearset. The type is .
`position` Vector?
The position. The default value is 0,0,0.
`rotateAxis` Vector?
The rotate axis. The default value is 0,1,0.
`pinionShaftLength` ExpressionValueVariable?
The pinion shaft length. The default value is 100.
`pinionShaftDiameter` ExpressionValueVariable?
The pinion shaft diameter. The default value is 20.
`carrierThickness` ExpressionValueVariable?
The carrier thickness. The default value is 3.
`pinionInstallMethodType` [PinionInstallMethodType](VM.API.Pre.GearTrain.PinionInstallMethodType.md)
The pinion install method type. The default value is Constraint.
`bearing` Obj?
The bearing when 'pinionInstallMethodType' is selected as bearing. The default value is null. The type is .
`color` [Color](https://learn.microsoft.com/dotnet/api/system.drawing.color)?
The color of the concept carrier.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'gearSet' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'rotateAxis' is not null and the magnitude of 'rotateAxis' is 0.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'pinionInstallMethodType' is Bearing and the 'bearing' is null.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'gearSet' is not planetary.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'gearSet' is not IGearSet gearSet.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'bearing' is not .
### CreateEFShaftset(GearTrainDocument, string)
Create .
```csharp
[NotNull(new string[] { "document" })]
public static Obj CreateEFShaftset(this GearTrainDocument document, string shaftName = "")
```
#### Parameters
`document` GearTrainDocument
The document to create the EF shaft set.
`shaftName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the EF shaft set. If empty, default name starts with 'ShaftSet\_' will be generated and used.
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### CreateFEShaftset(GearTrainDocument, string)
Create .
```csharp
[NotNull(new string[] { "document" })]
public static Obj CreateFEShaftset(this GearTrainDocument document, string shaftName = "")
```
#### Parameters
`document` GearTrainDocument
The document to create the FE shaft set.
`shaftName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the FE shaft set. If empty, default name starts with 'ShaftSet\_' will be generated and used.
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### CreateMeasurePointToShaftset(HiddenShaftSetDocument, string, ExpressionValueVariable?, ReferenceType)
Create measure point in simple shaftset .
```csharp
[NotNull(new string[] { "document" })]
public static Obj CreateMeasurePointToShaftset(this HiddenShaftSetDocument document, string measurePointName = "", ExpressionValueVariable? offset = null, PointEntityOnShaftSet.ReferenceType reference = ReferenceType.Start)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to create measure point.
`measurePointName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the measure point. If empty, default name starts with 'MeasurePt\_' will be generated and used.
`offset` ExpressionValueVariable?
The offset when add to shaft. The default value is 0.0.
`reference` PointEntityOnShaftSet.ReferenceType
The reference type. The default value is Start
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### CreatePointLoadToRBE(HiddenDocumentMeshBase, Obj, Vector, string, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?)
Create point load in FE/EF shaftset .
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "connectable" })]
[NotZeroMagnitude(new string[] { "direction" })]
[MatchTypeObj(new object[] { "connectable", typeof(IConnectable) })]
public static Obj CreatePointLoadToRBE(this HiddenDocumentMeshBase document, Obj connectable, Vector direction, string pointLoadName = "", ExpressionValueVariable? forceX = null, ExpressionValueVariable? forceY = null, ExpressionValueVariable? forceZ = null, ExpressionValueVariable? torqueX = null, ExpressionValueVariable? torqueY = null)
```
#### Parameters
`document` HiddenDocumentMeshBase
The document to create point load.
`connectable` Obj
The rbe. The type is .
`direction` Vector
The z-axis.
`pointLoadName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the point load. If empty, default name starts with 'PointLoad\_' will be generated and used.
`forceX` ExpressionValueVariable?
The x-axis force. The default value is 10.0
`forceY` ExpressionValueVariable?
The y-axis force. The default value is 10.0
`forceZ` ExpressionValueVariable?
The z-axis force. The default value is 10.0
`torqueX` ExpressionValueVariable?
The x-axis torque. The default value is 10.0
`torqueY` ExpressionValueVariable?
The y-axis torque. The default value is 10.0
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'connectable' argumenta are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### CreatePointLoadToShaftset(HiddenShaftSetDocument, string, ExpressionValueVariable?, ReferenceType, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?)
Create point load in simple shaftset .
```csharp
[NotNull(new string[] { "document" })]
public static Obj CreatePointLoadToShaftset(this HiddenShaftSetDocument document, string pointLoadName = "", ExpressionValueVariable? offset = null, PointEntityOnShaftSet.ReferenceType reference = ReferenceType.Start, ExpressionValueVariable? width = null, ExpressionValueVariable? forceX = null, ExpressionValueVariable? forceY = null, ExpressionValueVariable? forceZ = null, ExpressionValueVariable? torqueX = null, ExpressionValueVariable? torqueY = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to create point load.
`pointLoadName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the point load. If empty, default name starts with 'PointLoad\_' will be generated and used.
`offset` ExpressionValueVariable?
The offset when add to shaft. The default value is 0.0.
`reference` PointEntityOnShaftSet.ReferenceType
The reference type. The default value is Start
`width` ExpressionValueVariable?
The width when add to shaft. The default value is 1.0
`forceX` ExpressionValueVariable?
The x-axis force. The default value is 10.0
`forceY` ExpressionValueVariable?
The y-axis force. The default value is 10.0
`forceZ` ExpressionValueVariable?
The z-axis force. The default value is 10.0
`torqueX` ExpressionValueVariable?
The x-axis torque. The default value is 10.0
`torqueY` ExpressionValueVariable?
The y-axis torque. The default value is 10.0
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### CreatePowerLoadToRBE(HiddenDocumentMeshBase, Obj, Vector, string, PowerLoadType)
Create power load in FE/EF shaftset .
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "connectable" })]
[NotZeroMagnitude(new string[] { "direction" })]
[MatchTypeObj(new object[] { "connectable", typeof(IConnectable) })]
public static Obj CreatePowerLoadToRBE(this HiddenDocumentMeshBase document, Obj connectable, Vector direction, string powerLoadName = "", PowerLoad.PowerLoadType role = PowerLoadType.Input)
```
#### Parameters
`document` HiddenDocumentMeshBase
The document to create power load.
`connectable` Obj
The rbe. The type is .
`direction` Vector
The z-axis.
`powerLoadName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the power load. If empty, default name starts with 'PowerLoad\_' will be generated and used.
`role` PowerLoad.PowerLoadType
The role type. The default value is Input.
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if 'document' is FE/EF housing.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### CreatePowerloadToShaftset(HiddenShaftSetDocument, string, ExpressionValueVariable?, ReferenceType, ExpressionValueVariable?, PowerLoadType)
Create power load in simple shaftset .
```csharp
[NotNull(new string[] { "document" })]
public static Obj CreatePowerloadToShaftset(this HiddenShaftSetDocument document, string powerLoadName = "", ExpressionValueVariable? offset = null, PointEntityOnShaftSet.ReferenceType reference = ReferenceType.Start, ExpressionValueVariable? width = null, PowerLoad.PowerLoadType role = PowerLoadType.Input)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to create power load.
`powerLoadName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the power load. If empty, default name starts with 'PowerLoad\_' will be generated and used.
`offset` ExpressionValueVariable?
The offset when add to shaft. The default value is 0.0.
`reference` PointEntityOnShaftSet.ReferenceType
The reference type. The default value is Start
`width` ExpressionValueVariable?
The width when add to shaft. The default value is 1.0
`role` PowerLoad.PowerLoadType
The role type. The default value is Input.
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### CreateSimpleShaftset(GearTrainDocument, Vector, Vector, ExpressionValueVariable, ExpressionValueVariable, string, int, Color?)
Create .
```csharp
[NotNull(new string[] { "document" })]
[NotZeroMagnitude(new string[] { "rotateAxis" })]
[GreaterThanZero(new string[] { "length", "diameter", "numSection" })]
public static Obj CreateSimpleShaftset(this GearTrainDocument document, Vector position, Vector rotateAxis, ExpressionValueVariable length, ExpressionValueVariable diameter, string shaftName = "", int numSection = 3, Color? color = null)
```
#### Parameters
`document` GearTrainDocument
The document to create the simple shaft set.
`position` Vector
The position
`rotateAxis` Vector
The rotate axis.
`length` ExpressionValueVariable
The length of the simple shaft set
`diameter` ExpressionValueVariable
The diameter of the simple shaft set
`shaftName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the simple shaft set. If empty, default name starts with 'ShaftSet\_' will be generated and used.
`numSection` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The number of section of the simple shaft set. The default value is 3.
`color` [Color](https://learn.microsoft.com/dotnet/api/system.drawing.color)?
The color of the simple shaft set.
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'rotateAxis' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if the magnitude of 'rotateAxis' is 0.
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Will be thrown if 'length' or 'diameter' or 'numSection' value equal to or less than 0.
### CreateSimpleShaftset(GearTrainDocument, Vector)
Create .
```csharp
public static Obj CreateSimpleShaftset(this GearTrainDocument document, Vector position)
```
#### Parameters
`document` GearTrainDocument
The document to create the simple shaft set.
`position` Vector
The position
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### CreateSimpleShaftset(GearTrainDocument)
Create .
```csharp
public static Obj CreateSimpleShaftset(this GearTrainDocument document)
```
#### Parameters
`document` GearTrainDocument
The document to create the simple shaft set.
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### CreateUnbalanceMassToRBE(HiddenDocumentMeshBase, Obj, Vector, string, ExpressionValueVariable?, ExpressionValueVariable?)
Create unbalance mass in FE/EF shaftset .
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "connectable" })]
[NotZeroMagnitude(new string[] { "direction" })]
[MatchTypeObj(new object[] { "connectable", typeof(IConnectable) })]
public static Obj CreateUnbalanceMassToRBE(this HiddenDocumentMeshBase document, Obj connectable, Vector direction, string unbalanceMassName = "", ExpressionValueVariable? mass = null, ExpressionValueVariable? momentArm = null)
```
#### Parameters
`document` HiddenDocumentMeshBase
The document to create unbalance mass.
`connectable` Obj
The rbe. The type is .
`direction` Vector
The z-axis.
`unbalanceMassName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the unbalance mass. If empty, default name starts with 'UnbalanceMass\_' will be generated and used.
`mass` ExpressionValueVariable?
The mass. The default value is 1.0
`momentArm` ExpressionValueVariable?
The moment arm. The default value is 0.0
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'connectable' argumenta are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if magnitude of 'direction' is zero.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'connectable' is not .
### CreateUnbalanceMassToShaftset(HiddenShaftSetDocument, string, ExpressionValueVariable?, ReferenceType, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?)
Create unbalance mass in simple shaftset .
```csharp
[NotNull(new string[] { "document" })]
public static Obj CreateUnbalanceMassToShaftset(this HiddenShaftSetDocument document, string unbalanceMassName = "", ExpressionValueVariable? offset = null, PointEntityOnShaftSet.ReferenceType reference = ReferenceType.Start, ExpressionValueVariable? width = null, ExpressionValueVariable? mass = null, ExpressionValueVariable? momentArm = null)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to create unbalance mass.
`unbalanceMassName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the unbalance mass. If empty, default name starts with 'UnbalanceMass\_' will be generated and used.
`offset` ExpressionValueVariable?
The offset when add to shaft. The default value is 0.0.
`reference` PointEntityOnShaftSet.ReferenceType
The reference type. The default value is Start
`width` ExpressionValueVariable?
The width when add to shaft. The default value is 1.0
`mass` ExpressionValueVariable?
The mass. The default value is 1.0
`momentArm` ExpressionValueVariable?
The moment arm. The default value is 0.0
#### Returns
Obj
The new object that is created by this API.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.
### ImportMeshIntoFEEntity(HiddenDocumentFEBase, TMatrix, string, Color?, string, bool, LengthUnitType, MassUnitType, TimeUnitType, string)
Import mesh into FE Entity.
```csharp
[NotNull(new string[] { "document" })]
[ExistFile(new string[] { "feDataFilePath" })]
public static void ImportMeshIntoFEEntity(this HiddenDocumentFEBase document, TMatrix transform, string feDataFilePath, Color? color = null, string modalDataFilePath = "", bool useUnit = false, LengthUnitType lengthUnit = LengthUnitType.MM, MassUnitType massUnit = MassUnitType.KG, TimeUnitType timeUnit = TimeUnitType.SEC, string meshName = "")
```
#### Parameters
`document` HiddenDocumentFEBase
The document to import mesh file.
`transform` TMatrix
The transformation matrix for a nodal body.
`feDataFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)
The fe data file path.
`color` [Color](https://learn.microsoft.com/dotnet/api/system.drawing.color)?
The color of the nodal body.
`modalDataFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)
The modal data file path.
`useUnit` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The unit flag. The default value is false
`lengthUnit` LengthUnitType
The length unit. The default value is mm.
`massUnit` MassUnitType
The mass unit. The default value is kg.
`timeUnit` TimeUnitType
The time unit. The default value is sec.
`meshName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The mesh file name.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' arguments are empty.
[FileNotFoundException](https://learn.microsoft.com/dotnet/api/system.io.filenotfoundexception)
Will be thrown if 'feDataFilePath' does not exist.
### ImportPartIntoEFEntity(HiddenDocumentMeshFreeBase, TMatrix, string, CADImportResultType, CadImportUnitType, bool, CadImportColorType, Color?, string)
Import part into EF Entity.
```csharp
[NotNull(new string[] { "document", "transform" })]
[ExistFile(new string[] { "cadFilePath" })]
public static void ImportPartIntoEFEntity(this HiddenDocumentMeshFreeBase document, TMatrix transform, string cadFilePath, CADImportResultType cadImportResult = CADImportResultType.Default, Document3D.CadImportUnitType cadImportUnit = CadImportUnitType.Auto, bool healing = true, Document3D.CadImportColorType cadImportColor = CadImportColorType.Default, Color? color = null, string partName = "")
```
#### Parameters
`document` HiddenDocumentMeshFreeBase
The document to import part file.
`transform` TMatrix
The transformation matrix for a assembled body.
`cadFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)
The cad data file path.
`cadImportResult` CADImportResultType
The cad import result type. The default value is Default.
`cadImportUnit` Document3D.CadImportUnitType
The cad import unit type. The default value is Auto.
`healing` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
The healing flag. The default value is true.
`cadImportColor` Document3D.CadImportColorType
The cad import color. The default value is Default.
`color` [Color](https://learn.microsoft.com/dotnet/api/system.drawing.color)?
The color of the assembled body.
`partName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The part file name.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' arguments are empty.
[FileNotFoundException](https://learn.microsoft.com/dotnet/api/system.io.filenotfoundexception)
Will be thrown if 'cadFilePath' does not exist.
### SplitSectionInSimpleShaftset(HiddenShaftSetDocument, Obj)
Split section in simple shaftset.
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "section" })]
[MatchTypeObj(new object[] { "section", typeof(Section) })]
public static void SplitSectionInSimpleShaftset(this HiddenShaftSetDocument document, Obj section)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add section.
`section` Obj
The section to be splitted. The type is CAD.Section.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'section' arguments are empty.
### SplitSectionInSimpleShaftset(HiddenShaftSetDocument, int)
Split section in simple shaftset.
```csharp
[NotNull(new string[] { "document" })]
[GreaterThanOrEqualToZero(new string[] { "sectionIndex" })]
public static void SplitSectionInSimpleShaftset(this HiddenShaftSetDocument document, int sectionIndex)
```
#### Parameters
`document` HiddenShaftSetDocument
The document to add section.
`sectionIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The section index. The value is zero base.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' or 'section' arguments are empty.
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Will be thrown if 'sectionIndex' is less than zero or greater than length of section -1.
### UpdatePointEntity(HiddenShaftSetDocument, Obj)
Update point entity in shaftset designer.
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "pointEntityOnShaftSet" })]
[MatchTypeObj(new object[] { "pointEntityOnShaftSet", typeof(PointEntityOnShaftSet) })]
public static void UpdatePointEntity(this HiddenShaftSetDocument document, Obj pointEntityOnShaftSet)
```
#### Parameters
`document` HiddenShaftSetDocument
The to exist point entity.
`pointEntityOnShaftSet` Obj
The point entity to exist on simple shaftset. The type is .
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' 'pointEntityOnShaftSet' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'pointEntityOnShaftSet' is not .
### UpdatePointEntityOnRBE(HiddenDocumentMeshBase, Obj)
Update point entity in FE/EF shaftset/housing designer.
```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "pointEntityOnRBE" })]
[MatchTypeObj(new object[] { "pointEntityOnRBE", typeof(PointEntityOnRBE) })]
public static void UpdatePointEntityOnRBE(this HiddenDocumentMeshBase document, Obj pointEntityOnRBE)
```
#### Parameters
`document` HiddenDocumentMeshBase
The to exist point entity.
`pointEntityOnRBE` Obj
The point entity to exist on RBE. The type is .
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' 'pointEntityOnRBE' arguments are empty.
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Will be thrown if type of 'pointEntityOnRBE' is not .
### UpdateShaftSet(HiddenShaftSetDocument)
Update simple shaftset in shaftset designer.
```csharp
[NotNull(new string[] { "document" })]
public static void UpdateShaftSet(this HiddenShaftSetDocument document)
```
#### Parameters
`document` HiddenShaftSetDocument
The to exist EF shaftset.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Will be thrown if 'document' argument is empty.