Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Designer Class / ConnectShield Method
End node of cable shield.
Pin to connect shield to.
Example
In This Topic
    ConnectShield Method
    In This Topic
    Connects cable shield node to a pin with shield wire.
    Syntax
    public void ConnectShield( 
       IOccShieldEnd shieldNode,
       IPinBase endPoint
    )

    Parameters

    shieldNode
    End node of cable shield.
    endPoint
    Pin to connect shield to.
    Exceptions
    ExceptionDescription
    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.
    The object is in invalid state. Obtain a new one.
    Argument is null.
    Remarks
    Cable shield has to be conductive, otherwise it cannot be connected. Exception will be thrown when either pin or shield node are already connected.
    Example
    This example shows how to connect 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 conductive shield to the workspace before
    var end1 = wsp.GetAllOccurrences().OfType<OccWsShieldEnd>().FirstOrDefault();
    var end2 = wsp.GetAllOccurrences().OfType<OccWsShieldEnd>().LastOrDefault();
    
    var cn3 = wsp.GetAllOccurrences().FirstOrDefault(o => o.Name == "...");
    
    var pin1 = cn3.Children.OfType<IPinBase>().First();
    var specComponent = wsp.GetAllOccurrences().FirstOrDefault(o => o.Name == "...") as IPinBase;
    
    wsp.ConnectShield(end2, specComponent);
    wsp.ConnectShield(end1, pin1);
    
    // conductive shield is now connected to a pin and special component
    wsp.Save();
    wsp.Close();
    See Also