DoReassignWires(Function,Connection[],Boolean,AnyPropertyId[]) Method

In This Topic

All wires in cable are assigned to a matching template of the cable or shielding. User specifies templates to which wires will be assigned. Works only for Eplan.EplApi.DataModel.EObjects.Cable or Eplan.EplApi.DataModel.Function with category Eplan.EplApi.DataModel.Function.Enums.Category.Shielding.

Syntax

C#
C++/CLI

public void DoReassignWires( 
   Function oFunction,
   Connection[] arrWireTemplates,
   bool bChangeExistingProperties,
   AnyPropertyId[] arrListOfExcludedAnyPropertyIds
)

public:
void DoReassignWires( 
   Function^ oFunction,
   array<Connection^>^ arrWireTemplates,
   bool bChangeExistingProperties,
   array<AnyPropertyId^>^ arrListOfExcludedAnyPropertyIds
)

Parameters

Parameter Name	Description
oFunction	Function on which this procedure will be executed.
arrWireTemplates	List of templates which will be assign to wires.
bChangeExistingProperties	If true existing wire properties can be changed.
arrListOfExcludedAnyPropertyIds	List of properties ids. Value of those properties will not be changed. Can be NULL.

Exceptions

Exception	Description
System.ArgumentNullException	If parameter is NULL.
System.ArgumentException	If a parameter is invalid.
System.ApplicationException	The internal interface could not be created.
Eplan.EplApi.Base.BaseException	An error occurred when reassigning wires. Please read the exception message.

Remarks

Every template will be used only once. A wire will be assigned to a template, only if both have the same potential type. If a wire is assigned to a template, the identifying wire properties of the template will be copied to the wire.

Only functions with category Eplan.EplApi.DataModel.Function.Enums.Category.Cable or Eplan.EplApi.DataModel.Function.Enums.Category.Shielding can be passed as oFunction.

Reference

CableService Class
CableService Members
Overload List

Use the Eplan Global Support Portal for feedback and support