Harness proD API Help
EPLAN.Harness.API.Occurrences.Interfaces Namespace / IOccShieldWire Interface
Members Example
In This Topic
    IOccShieldWire Interface
    In This Topic
    Common interface for occurrences representing conductive shield in a cable. The shield wire's behaviour is similar to cable wire's. The conductive shield wire can be connected to a pin and a grouped (super) pin as well. Both or one end only can be connected. The occurrence of the shield wire is created while the conductive shield is being connected. The properties of the conductive wire are not accessible in the GUI of HpD. They are shared with properties of the parent conductive shield.
    Object Model
    IOccShieldWire InterfaceBooleanProperty ClassLengthProperty ClassLengthProperty ClassColorProperty ClassIOccConductiveShield InterfaceTextProperty ClassAreaProperty ClassBooleanProperty ClassTextProperty ClassBooleanProperty ClassLengthProperty ClassTextProperty ClassTextProperty ClassLengthProperty ClassLengthProperty ClassBooleanProperty Class
    Syntax
    Example
    // Init API at first.
    HpdApi api = HpdApi.GetInstance();
    					
    // Open document.
    Project project = api.OpenProject(@"d:\MyProject.hxproj");
    					
    Variant variant = project.GetVariants()[0];
    Designer designer = variant.GetWorkdesks().FirstOrDefault(d => d.Name == "Workdesk_1");
    designer.Open(false, false);
    
    // Select cable.
    IOccCable cable = designer.GetAllOccurrences().OfType<IOccCable>().FirstOrDefault(c => c.Name == "ca_00002");
    // Select its conductive shield.
    IOccConductiveShield shield = cable.CableSubParts.OfType<IOccConductiveShield>().FirstOrDefault(s => s.Name == "Shield 1");
    // Get shield wire.
    IOccShieldWire shieldWire = shield.ShieldWire;
    // Select connector.
    IOccConnector connector = designer.GetAllOccurrences().OfType<IOccConnector>().FirstOrDefault(c => c.Name == "cn_00001");
    // Find matching connected pin.
    IPinBase pin1 = connector.Pins.FirstOrDefault(tempPin1 => shieldWire.GetConnectedPins().Any(tempPin2 => tempPin1.ID == tempPin2.ID));
    // Select second pin.
    IPinBase pin2 = connector.Pins.FirstOrDefault(p => p.Name == "2");
    // Reconnect shield wire.
    shieldWire.Reconnect(pin1, pin2);
    
    // Save changes and close documents.
    designer.Save();
    designer.Close();
    project.Close();
    Public Properties
     NameDescription
     Property Gets or sets the value of the 'Bending radii check' property of this occurrence.  
     Property Gets the bending radius of this occurrence.  
     Property Gets the cable length of this occurrence.  
     Property Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
     Property Gets or sets the color of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IWireCommon)
     PropertyParent conductive shield which is visible in the GUI.  
     Property Gets the names of pins to which this occurrence is connected. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IWire)
     Property Get or set the cross section of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IWireCommon)
     PropertyDetermines if this part is to be exported or not when using EPLAN.Harness.API.Projects.Documents.Designer.Export3DFile. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IExportable3D)
     Property Identifier of the API object. (Inherited from EPLAN.Harness.API.Interfaces.IApiObject)
     Property Gets or sets the imprint of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IWireCommon)
     Property Gets or sets the interpolation algorithm of this occurrence.  
     Property Is the part a rapid prototype? (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
     Property Is occurrence valid? (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
     Property Gets the length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IControlPath)
     Property Gets the material code of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IWireCommon)
     Property Gets or sets the name of the occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence)
     Property Get or set the outside diameter of this occurrence. Note: In the case of the rapid prototype cables, the outside diameter should be set on the top-level insulator. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IWireCommon)
     Property Gets parent occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
     Property Gets the raw length of this occurrence.  
     Property Gets or sets the value of 'Selectable' property of this occurrence.  
     Property Gets or sets a list of user-defined properties of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties)
    Top
    Public Methods
     NameDescription
     Method (Inherited from System.IEquatable<IOccurrence>)
     Method Gets pins to which this wire is connected. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IReconnectable)
     MethodGets all control point on this control path. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IControlPath)
     Method Reconnect this shield from one grouped pin to another. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IReconnectable)
    Top
    See Also