## On this page

  

 

 # Class CPlacingConnectorAPI

 Last update: 16.07.2025 

Namespace: [VM.API.Pre.Links](VM.API.Pre.Links.md)  
Assembly: VM.API.Pre.Links.dll

This class implements APIs for chained placing connector.

```csharp
public static class CPlacingConnectorAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [CPlacingConnectorAPI](VM.API.Pre.Links.CPlacingConnectorAPI.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<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### CalculatePinStiffness(string, string)

Calculate pin stiffness.

```csharp
[ExistFile(new string[] { "pinFilePath" })]
[NotNullOrEmpty(new string[] { "pinName" })]
public static double CalculatePinStiffness(string pinFilePath, string pinName)

```

#### Parameters

`pinFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The pin file path.

`pinName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The pin name.

#### Returns

[double](https://learn.microsoft.com/dotnet/api/system.double)

The stiffness information that is calculated by this API.

#### Exceptions

[FileNotFoundException](https://learn.microsoft.com/dotnet/api/system.io.filenotfoundexception)

Will be thrown if 'pinFilePath' file path does not exist.

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if type of 'pinName' argument is empty.

### CalculatePulleyStiffness(string, string, string)

Calculate pulley stiffness.

```csharp
[ExistFile(new string[] { "pulleyFilePath", "pinFilePath" })]
[NotNullOrEmpty(new string[] { "pulleyName" })]
public static List<double[]> CalculatePulleyStiffness(string pulleyFilePath, string pulleyName, string pinFilePath)

```

#### Parameters

`pulleyFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The pulley file path.

`pulleyName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The pulley name.

`pinFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The pin file path

#### Returns

[List](https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1)&lt;[double](https://learn.microsoft.com/dotnet/api/system.double)\[\]&gt;

The stiffness information that is calculated by this API.

#### Exceptions

[FileNotFoundException](https://learn.microsoft.com/dotnet/api/system.io.filenotfoundexception)

Will be thrown if 'pulleyFilePath' file path does not exist.

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if type of 'pulleyName' argument is empty.

[FileNotFoundException](https://learn.microsoft.com/dotnet/api/system.io.filenotfoundexception)

Will be thrown if 'pinFilePath' file path does not exist.

### CalculateSegmentStiffness(string)

Calculate segment stiffness.

```csharp
[ExistFile(new string[] { "segmentFilePath" })]
public static Dictionary<string, VectorBase> CalculateSegmentStiffness(string segmentFilePath)

```

#### Parameters

`segmentFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The segment file path.

#### Returns

[Dictionary](https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2)&lt;[string](https://learn.microsoft.com/dotnet/api/system.string), VectorBase&gt;

The stiffness information that is calculated by this API.

#### Exceptions

[FileNotFoundException](https://learn.microsoft.com/dotnet/api/system.io.filenotfoundexception)

Will be thrown if 'segmentFilePath' file path does not exist.

### CreateCPlacingConnector(SubSystemDocument, Obj, string)

Create Chained placing connector .

```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "chainedPlacing" })]
public static Obj CreateCPlacingConnector(this SubSystemDocument document, Obj chainedPlacing, string name = "")

```

#### Parameters

`document` SubSystemDocument

The document to create the Chained placing connector.

`chainedPlacing` Obj

The chained placing.

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the . If empty, default name starts with 'CPlacingConnector\_' 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', 'chainedPlacing' are null.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

Will be thrown if item type of 'chainedPlacing' is not .

### CreatePin(IChainedSegmentInfo, Obj, Vector, Vector, string)

Create pin .

```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "body" })]
[NotZeroMagnitude(new string[] { "direction" })]
public static Obj CreatePin(this IChainedSegmentInfo document, Obj body, Vector position, Vector direction, string name = "")

```

#### Parameters

`document` IChainedSegmentInfo

The document to create the pin.

`body` Obj

The body to create the pin.

`position` Vector

The position to create the pin.

`direction` Vector

The direction to create the pin.

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the . If empty, default name starts with 'Pin\_' 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', 'body' are null.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

Will be thrown if the magnitude of 'direction' is 0.

### CreatePulley(IChainedPathInfo, Obj, Vector, Vector, string)

Create pulley .

```csharp
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "body" })]
[NotZeroMagnitude(new string[] { "axisZ" })]
public static Obj CreatePulley(this IChainedPathInfo document, Obj body, Vector position, Vector axisZ, string name = "")

```

#### Parameters

`document` IChainedPathInfo

The document to create the pulley.

`body` Obj

The body to create the pulley.

`position` Vector

The position to create the pulley.

`axisZ` Vector

The z-axis to create the pulley.

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the . If empty, default name starts with 'Pulley\_' 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', 'body' are null.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

Will be thrown if the magnitude of 'axisZ' is 0.