PlaceAuxiliaryPlane Method

In This Topic

Place an auxiliary plane to coordinates.

Syntax

public IOccAuxiliaryPlane PlaceAuxiliaryPlane( 
   TransformProperty<LengthProperty> startPosition,
   TransformProperty<LengthProperty> endPosition
)

Parameters

startPosition: Start position of the auxiliary plane.
endPosition: End position of the auxiliary plane.

Return Value

Placed auxiliary plane.

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.PartPlacementFailedException	Thrown when placing this part failed.

Example

This example shows how to place an auxiliary plane into a workspace.

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

// Start position of the auxiliary plane.
TransformProperty<LengthProperty> startPosition = new TransformProperty<LengthProperty>
(
	new LengthProperty(10, Unit.Millimeter),
	new LengthProperty(12, Unit.Millimeter),
	new LengthProperty(-5, Unit.Millimeter)
);

// End position of the auxiliary plane.
TransformProperty<LengthProperty> endPosition = new TransformProperty<LengthProperty>
(
	new LengthProperty(50, Unit.Millimeter),
	new LengthProperty(0, Unit.Millimeter),
	new LengthProperty(-10, Unit.Millimeter)
);

// Place auxiliary plane.
BaseOccurrence auxPlane = workspace.PlaceAuxiliaryPlane(startPosition, endPosition);

Reference

Designer Class
Designer Members
TransformProperty<T> Class

Send Feedback