PlaceRapidPrototypeWire Method

In This Topic

Place rapid prototype wire.

Syntax

public IOccRapidWire PlaceRapidPrototypeWire( 
   IPinBase pin1,
   IPinBase pin2,
   List<TransformProperty<LengthProperty>> controlPointsPositions,
   RapidWireDefinition definition
)

Parameters

pin1: First pin to connect to.
pin2: Second pin to connect to.
controlPointsPositions: Positions of control points of this wire.
definition: Rapid prototype wire definition. If the definition is null the default values from settings are used.

Return Value

Placed rapid prototype wire.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ConnectionException
EPLAN.Harness.API.Exceptions.ArgumentException
EPLAN.Harness.API.Exceptions.ArgumentNullException
EPLAN.Harness.API.Exceptions.FileClosedException	This file is not opened.
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.OccurrenceMissingInDocumentException	Thrown when the occurrence is not part of this document.

Remarks

Both pins and must not be children of ribbon pin.

Example

This example shows how to place a yellow rapid prototype wire with a cross section of 2 mm2 between selected pins.

// Obtain workspace beforehand.
Workspace workspace = ...

OccWsPin pin1 = ...
OccWsPin pin2 = ...

IWire wire = workspace.PlaceRapidPrototypeWire(pin1, pin2, new List<TransformProperty<LengthProperty>>(), new RapidWireDefinition()
{
	CrossSection = new AreaProperty(2, Unit.SquareMillimeter),
	Color = Color.Yellow
});

This example shows how to place a rapid prototype wire with default values from settings between group pins (the wire will be connected to the selected virtual pins).

// Obtain workspace beforehand.
Workspace workspace = ...

// Virtual pins which are under group pins.
OccWsVirtualPin pin1 = ...
OccWsVirtualPin pin2 = ...

IWire wire = workspace.PlaceRapidPrototypeWire(pin1, pin2, new List<TransformProperty<LengthProperty>>());

This example shows how to place a rapid prototype wire with default values from settings, which has several control points.

// Obtain workdesk beforehand.
Workdesk workdesk = ...

// Virtual pins which are under group pins.
OccWdVirtualPin pin1 = ...
OccWdVirtualPin pin2 = ...

// Control points in defined positions in the space.
TransformProperty<LengthProperty> controlPoint1 = new TransformProperty<LengthProperty>
(
new LengthProperty(62.88, Unit.Millimeter),
new LengthProperty(201.2, Unit.Millimeter),
new LengthProperty(251.8, Unit.Millimeter)
);
TransformProperty<LengthProperty> controlPoint2 = ...
TransformProperty<LengthProperty> controlPoint3 = ...

IWire wire = workdesk.PlaceRapidPrototypeWire(pin1, pin2, new List<TransformProperty<LengthProperty>> { controlPoint1, controlPoint2, controlPoint3 });

Reference

Designer Class
Designer Members
RapidWireDefinition Class
LengthProperty Class
AreaProperty Class

Send Feedback