PlaceTwist Method

In This Topic

Place a twist to this designer.

Syntax

public IOccTwist PlaceTwist( 
   List<PlacePosition> positions,
   LengthProperty outsideDiameter,
   LengthProperty bendingRadius
)

Parameters

positions: List of positions in space or occurrences to which the twist will be connected. The order of items matters!
outsideDiameter: Outside diameter of the twist. If not filled, the default value from settings is used.
bendingRadius: Bending radius of the bundle. This property has meaning only for EPLAN.Harness.API.Common.Enums.ApiPathInterpolationAlgorithm.RoundedCorners. If not filled, the default value from settings is used.

Return Value

Placed twist.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ArgumentNullException
EPLAN.Harness.API.Exceptions.ArgumentException
EPLAN.Harness.API.Exceptions.HpdApiNotInitializedException	Api is not in an initialized state. You can get current state from EPLAN.Harness.API.HpdApi.Status property. If API is uninitialized, you can initialize it by calling EPLAN.Harness.API.HpdApi.Init method. If API is in failed state, you can not resurrect it.
EPLAN.Harness.API.Exceptions.ObjectInvalidException	The object is in invalid state. Obtain a new one.
EPLAN.Harness.API.Exceptions.LicensingErrorException	This operation was denied because of your license.
EPLAN.Harness.API.Exceptions.FileClosedException	This file is not opened.

Remarks

Conditions of placing the twist:

Twist must have at least 2 positions (control points).
Twist can only be connected to occurrences which implement EPLAN.Harness.API.Occurrences.Interfaces.IOccConnectableWithBundle interface.
Each occurrence can only be used once.
Cannot connect more points from the same EPLAN.Harness.API.Occurrences.Workspace.OccWsLeadingPath.
First or last occurrence must not be EPLAN.Harness.API.Occurrences.Workspace.OccWsClipPoint.
Middle points of the twist can only be positions in space (EPLAN.Harness.API.ApiProperties.TransformProperty<T>) or EPLAN.Harness.API.Occurrences.Workspace.OccWsClipPoint.

Example

This example shows how to place a new twist to any positions in the space.

Workdesk workdesk = ...

List<PlacePosition> placePositions = new List<PlacePosition>();
placePositions.Add(new PlacePosition(new TransformProperty<LengthProperty>(new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter))));
placePositions.Add(new PlacePosition(new TransformProperty<LengthProperty>(new LengthProperty(100, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter))));

workdesk.PlaceTwist(placePositions);

This example shows how to place a new twist with defined diameter and bending radius.

Designer designer = ...

List<PlacePosition> placePositions = new List<PlacePosition>();
placePositions.Add(new PlacePosition(new TransformProperty<LengthProperty>(new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter))));
placePositions.Add(new PlacePosition(new TransformProperty<LengthProperty>(new LengthProperty(-50, Unit.Millimeter), new LengthProperty(10, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter))));

IOccTwist twist = designer.PlaceTwist(placePositions, new LengthProperty(15, Unit.Millimeter), new LengthProperty(18, Unit.Millimeter));

This example shows how to start the new twist from a control point of another twist.

Workdesk workdesk = ...
OccWdTwist twist = ...

List<PlacePosition> placePositions = new List<PlacePosition>();
placePositions.Add(new PlacePosition(twist.GetAllControlPoints().First()));
placePositions.Add(new PlacePosition(new TransformProperty<LengthProperty>(new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter))));

workdesk.PlaceTwist(placePositions);

This example shows how to connect a twist with any leading parts.

Workdesk workdesk = ...
OccWdLeadingPartEndPoint leadingPartEndPoint = ...
OccWdClipPoint clipPoint = ...
OccWdLeadingPartEndPoint grommetEndPoint = ...

List<PlacePosition> placePositions = new List<PlacePosition>();
placePositions.Add(new PlacePosition(leadingPartEndPoint));
placePositions.Add(new PlacePosition(clipPoint));
placePositions.Add(new PlacePosition(grommetEndPoint));

workdesk.PlaceTwist(placePositions);

Reference

Designer Class
Designer Members
PlacePosition Class
TransformProperty<T> Class
IOccConnectableWithBundle Interface
LengthProperty Class

Send Feedback