PlaceRapidResistor(RapidResistorDefinition,ISpecialComponentHost,IControlPoint,IControlPoint,TransformProperty<LengthProperty>) Method

In This Topic

Place rapid resistor on cable, wire, bundle etc.

Syntax

public IOccRapidResistor PlaceRapidResistor( 
   RapidResistorDefinition definition,
   ISpecialComponentHost parentOcc,
   IControlPoint firstPoint,
   IControlPoint secondPoint,
   TransformProperty<LengthProperty> position
)

Parameters

definition: Rapid resistor definition.
parentOcc: A part on which the rapid resistor is to be placed.
firstPoint: First edge point among which the rapid resistor is to be placed.
secondPoint: Second edge point among which the rapid resistor is to be placed.
position: Position of the rapid resistor.

Return Value

Placed rapid Resistor.

Exceptions

Exception	Description
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.IncorrectPartTypeException	Thrown when the type of part can not be placed by the method.
EPLAN.Harness.API.Exceptions.PartPlacementFailedException	Thrown when placing this part failed.
EPLAN.Harness.API.Exceptions.NotSamePartOfPathException	Thrown when both edge points do not lie on one part of path.
EPLAN.Harness.API.Exceptions.ControlPointsAreNotNeighboringException	Thrown when edge points do not lie side by side.

Remarks

Controls points have to be neighboring.

Example

This example shows how to place a rapid resistor on a wire.

// Obtain workspace beforehand and open for writing.
Workspace workspace = ...
workspace.Open(false, false);

// Special component definition.
RapidResistorDefinition definition = new RapidResistorDefinition();
definition.Color = Color.Aqua;

// Obtain wire from workspace.
OccWsWire wire = workspace.GetAllOccurrences<OccWsWire>().FirstOrDefault(occ => occ.Name.ToString() == "wire1");

// Obtain controls points from wire.
List<IControlPoint> controlPoints = wire.GetAllControlPoints().ToList();
IControlPoint firstPoint = controlPoints.FirstOrDefault(c => c.Name.ToString() == "occ_1");
IControlPoint secondPoint = t.FirstOrDefault(c => c.Name.ToString() == "occ_2");

// Position of the rapid special component.
TransformProperty<LengthProperty> position = new TransformProperty<LengthProperty>
(
new LengthProperty(-50, Unit.Millimeter),
new LengthProperty(120, Unit.Millimeter),
new LengthProperty(70, Unit.Millimeter)
);

// Place attached part to occurrence.
workspace.PlaceRapidResistor(definition, wire, firstPoint, secondPoint, position);

Reference

Designer Class
Designer Members
Overload List
IRoutable Interface
IControlPoint Interface
TransformProperty<T> Class

Send Feedback