PlaceBundle Method

In This Topic

Place bundle to this designer.

Syntax

public IOccBundle PlaceBundle( 
   List<PlacePosition> positions,
   LengthProperty outsideDiameter,
   LengthProperty bendingRadius
)

Parameters

positions: List of positions in space or occurrences to which the bundle will be connected. The order of positions matters!
outsideDiameter: Outside diameter of the bundle. 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 bundle.

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 bundle:

Bundle must have at least 2 positions (control points).
Bundle 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 bundle 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 bundle to any positions in the space.

// Get the workdesk where bundle will be placed.
Workdesk workdesk = ...

// Create the list of bundle positions and add at least two positions to it.
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))));

// Place the bundle with specified positions, default diameter and bending radius.
workdesk.PlaceBundle(placePositions);

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

// Get the workspace where bundle will be placed.
Workspace workspace = ...

// Create the list of bundle positions and add at least two positions to it.
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))));

// Place the bundle with specified positions, diameter and bending radius.
workspace.PlaceBundle(placePositions, new LengthProperty(15, Unit.Millimeter), new LengthProperty(18, Unit.Millimeter));

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

// Get the designer where bundle will be placed.
Designer designer = ...

// Get the bundle which will share the starting point with our new bundle.
IOccBundle bundle = ...

// Create the list of bundle positions. Add the first point of bundle above and a second point.
List<PlacePosition> placePositions = new List<PlacePosition>();
placePositions.Add(new PlacePosition(bundle.GetAllControlPoints().First()));
placePositions.Add(new PlacePosition(new TransformProperty<LengthProperty>(new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter), new LengthProperty(0, Unit.Millimeter))));

// Place the bundle with specified positions, default diameter and bending radius.
designer.PlaceBundle(placePositions);

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

// Get the workdesk where bundle will be placed.
Workdesk workdesk = ...

// Get leading parts where the bundle will path.
OccWdLeadingPartEndPoint leadingPartEndPoint = ...
OccWdClipPoint clipPoint = ...
OccWdLeadingPartEndPoint grommetEndPoint = ...

// Create the list of bundle positions and add positions of leading parts.
List<PlacePosition> placePositions = new List<PlacePosition>();
placePositions.Add(new PlacePosition(leadingPartEndPoint));
placePositions.Add(new PlacePosition(clipPoint));
placePositions.Add(new PlacePosition(grommetEndPoint));

// Place the bundle with specified positions, default diameter and bending radius.
workdesk.PlaceBundle(placePositions);

Reference

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

Send Feedback