Class CPlacingConnectorAPI
Last update: 16.07.2025Namespace: VM.API.Pre.Links
Assembly: VM.API.Pre.Links.dll
This class implements APIs for chained placing connector.
public static class CPlacingConnectorAPI
Inheritance
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType),
LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType),
LinkPropertyItemCache.GetLinkedObjects
Methods
CalculatePinStiffness(string, string)
Calculate pin stiffness.
[ExistFile(new string[] { "pinFilePath" })]
[NotNullOrEmpty(new string[] { "pinName" })]
public static double CalculatePinStiffness(string pinFilePath, string pinName)
Parameters
pinFilePath string
The pin file path.
pinName string
The pin name.
Returns
The stiffness information that is calculated by this API.
Exceptions
Will be thrown if 'pinFilePath' file path does not exist.
Will be thrown if type of 'pinName' argument is empty.
CalculatePulleyStiffness(string, string, string)
Calculate pulley stiffness.
[ExistFile(new string[] { "pulleyFilePath", "pinFilePath" })]
[NotNullOrEmpty(new string[] { "pulleyName" })]
public static List<double> CalculatePulleyStiffness(string pulleyFilePath, string pulleyName, string pinFilePath)
Parameters
pulleyFilePath string
The pulley file path.
pulleyName string
The pulley name.
pinFilePath string
The pin file path
Returns
The stiffness information that is calculated by this API.
Exceptions
Will be thrown if 'pulleyFilePath' file path does not exist.
Will be thrown if type of 'pulleyName' argument is empty.
Will be thrown if 'pinFilePath' file path does not exist.
CalculateSegmentStiffness(string)
Calculate segment stiffness.
[ExistFile(new string[] { "segmentFilePath" })]
public static Dictionary<string vectorbase> CalculateSegmentStiffness(string segmentFilePath)
Parameters
segmentFilePath string
The segment file path.
Returns
Dictionarystring, VectorBase>
The stiffness information that is calculated by this API.
Exceptions
Will be thrown if 'segmentFilePath' file path does not exist.
CreateCPlacingConnector(SubSystemDocument, Obj, string)
Create Chained placing connector
[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
The name of the
Returns
Obj
The new
Exceptions
Will be thrown if 'document', 'chainedPlacing' are null.
Will be thrown if item type of 'chainedPlacing' is not
CreatePin(IChainedSegmentInfo, Obj, Vector, Vector, string)
Create pin
[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
The name of the
Returns
Obj
The new
Exceptions
Will be thrown if 'document', 'body' are null.
Will be thrown if the magnitude of 'direction' is 0.
CreatePulley(IChainedPathInfo, Obj, Vector, Vector, string)
Create pulley
[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
The name of the
Returns
Obj
The new
Exceptions
Will be thrown if 'document', 'body' are null.
Will be thrown if the magnitude of 'axisZ' is 0.
