DisconnectShield Method

In This Topic

Disconnects shield wire which starts in provided shield node.

Syntax

public void DisconnectShield( 
   IOccShieldEnd shieldNode
)

Parameters

shieldNode: End node of cable shield.

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.ArgumentNullException	Argument is null.

Remarks

Cable shield has to be conductive, otherwise it cannot be disconnected. Exception will be thrown when shield node is not connected.

Example

This example shows how to disconnect a shield wire.

var api = HpdApi.GetInstance();
api.Init();

var project = api.OpenProject("...");
var wsp = project.GetVariants().FirstOrDefault()?.GetWorkspaces().FirstOrDefault(w => w.Name == "...");
wsp.Open(false, false);

// assume we placed a cable with connected conductive shield to the workspace before
var end1 = wsp.GetAllOccurrences().OfType<OccWsShieldEnd>().FirstOrDefault();
var end2 = wsp.GetAllOccurrences().OfType<OccWsShieldEnd>().LastOrDefault();

wsp.DisconnectShield(end2);
wsp.DisconnectShield(end1);

// conductive shield of the cable is not connected now

wsp.Save();
wsp.Close();

Reference

Designer Class
Designer Members
Workspace Class
Workdesk Class

Send Feedback