Harness proD API Help
EPLAN.Harness.API.Occurrences.Interfaces Namespace / IOccConductiveShield Interface
Members Example
In This Topic
    IOccConductiveShield Interface
    In This Topic
    Conductive shield occurrence. The conductive shield can be connected to a grouped (super) pin only. Both or one end only can be connected. If connecting to a normal pin is required use the shield wire instead. It is recommended to use it in case of a grouped pin as well. Using of the shield wire is the new way from the HpD 2.9. The conductive shield occurrence was preserved for backwards compatibility. See HpD Studio help for more details.
    Object Model
    IOccConductiveShield InterfaceBooleanProperty ClassLengthProperty ClassLengthProperty ClassColorProperty ClassTextProperty ClassAreaProperty ClassTextProperty ClassBooleanProperty ClassBooleanProperty ClassLengthProperty ClassTextProperty ClassTextProperty ClassLengthProperty ClassLengthProperty ClassBooleanProperty ClassIOccShieldWire Interface
    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_00013");
    // Select its conductive shield.
    IOccConductiveShield shield = cable.CableSubParts.OfType<IOccConductiveShield>().FirstOrDefault(s => s.Name == "Shield 1");
    // Select connector 1.
    IOccConnector connector1 = designer.GetAllOccurrences().OfType<IOccConnector>().FirstOrDefault(c => c.Name == "cn_00009");
    // Find matching connected pin.
    IPinBase pin1 = connector1.Children.OfType<IOccGroupedPin>().FirstOrDefault(tempPin1 => shield.GetConnectedPins().Any(tempPin2 => tempPin1.ID == tempPin2.ID));
    // Select connector 2.
    IOccConnector connector2 = designer.GetAllOccurrences().OfType<IOccConnector>().FirstOrDefault(c => c.Name == "cn_00007");
    // Select second pin.
    IPinBase pin2 = connector2.Children.OfType<IOccGroupedPin>().FirstOrDefault();
    // Reconnect shield.
    shield.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. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
     Property Gets the bending radius of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
     Property Gets the cable length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
     Property Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
     Property Gets the color of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccShield)
     Property Gets the names of pins to which this conductive shield is connected. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccShield)
     Property Get or set the cross section of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccShield)
     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.IOccShield)
     Property Gets or sets the interpolation algorithm of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
     PropertyReturns false if both ends of the shield are not connected to a pin.  
     Property Is the part a rapid prototype? (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence)
     PropertySpecifies if this cable's sublayer is the top layer of the cable. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
     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.IOccShield)
     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.IControlPathWithEnds)
     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. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
     Property Gets or sets the value of 'Selectable' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer)
     PropertyReturns an occurrence of the shield wire representing this conductive shield.  
     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