Harness proD API Help
EPLAN.Harness.API.Occurrences.Workdesk Namespace / OccWdShieldWire Class
Members
In This Topic
    OccWdShieldWire Class
    In This Topic
    Represents an occurrence of conductive shield representation from a workdesk. The shield wire's behavior is similar to cable wire's. The conductive shield wire can be connected to a pin and a grouped (super) pin as well. One or both ends can be connected.
    Object Model
    OccWdShieldWire ClassBooleanProperty ClassLengthProperty ClassLengthProperty ClassColorProperty ClassIOccConductiveShield InterfaceTextProperty ClassAreaProperty ClassBooleanProperty ClassTextProperty ClassBooleanProperty ClassLengthProperty ClassBaseLibraryPart ClassTextProperty ClassTextProperty ClassLengthProperty ClassLengthProperty ClassBooleanProperty Class
    Inheritance Hierarchy

    System.Object
       EPLAN.Harness.API.ApiObject
          EPLAN.Harness.API.Occurrences.BaseOccurrence
             EPLAN.Harness.API.Occurrences.Base3DOccurrence
                EPLAN.Harness.API.Occurrences.BaseWdOccurrence
                   EPLAN.Harness.API.Occurrences.Workdesk.BaseWdWire
                      EPLAN.Harness.API.Occurrences.Workdesk.OccWdShieldWire

    Syntax
    public class OccWdShieldWire : BaseWdWire, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IControlPath, EPLAN.Harness.API.Occurrences.Interfaces.IControlPathWithEnds, EPLAN.Harness.API.Occurrences.Interfaces.IExportable3D, EPLAN.Harness.API.Occurrences.Interfaces.IGraphicalOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccShieldWire, EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IReconnectable, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties, EPLAN.Harness.API.Occurrences.Interfaces.IWire, EPLAN.Harness.API.Occurrences.Interfaces.IWireCommon
    Remarks
    Please note that values of the shield wire properties are taken from the parent conductive shield. Those values are settable to preserve compatibility with various interfaces, however the setters have no effect! If you want to change conductive shield properties use the conductive shield occurrence itself, not the shield wire. It can be conveniently accessed using the ConductiveShield property.
    Public Properties
     NameDescription
    Public PropertyBendingRadiiCheck Gets or sets the value of the 'Bending radii check' property of this occurrence.  
    Public PropertyBendingRadius Gets the bending radius of this occurrence.  
    Public PropertyCableLength Gets the cable length of this occurrence.  
    Public PropertyChildren Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyColorOverridden.  Gets or sets the color of this occurrence.  
    Public PropertyConductiveShieldParent conductive shield which is visible in the GUI.  
    Public PropertyConnectedPinsOverridden.  Gets the names of pins to which this occurrence is connected.  
    Public PropertyCrossSectionOverridden.  Get or set the cross section of this occurrence.  
    Public PropertyExportable3DDetermines if this part is to be exported or not when using EPLAN.Harness.API.Projects.Documents.Designer.Export3DFile.  
    Public PropertyID ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyImprintOverridden.  Gets or sets the imprint of this occurrence.  
    Public PropertyInterpolation Gets or sets the interpolation algorithm of this occurrence.  
    Public PropertyIsRapid Is the part a rapid prototype? (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyIsValid Tells you whether this object is valid or not. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyLengthOverridden.  Gets the length of this occurrence.  
    Public PropertyLibraryPart Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyMaterialCodeOverridden.  Gets the material code of this occurrence.  
    Public PropertyNameOverridden.  Gets or sets the name of the occurrence.  
    Public PropertyOutsideDiameterOverridden.  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.  
    Public PropertyParents Gets parent occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyRawLength Gets the raw length of this occurrence.  
    Public PropertySelectable Gets or sets the value of 'Selectable' property of this occurrence.  
    Public PropertyUserDefinedPropertiesOverridden.  Gets or sets a list of user-defined properties of this occurrence.  
    Top
    Public Methods
     NameDescription
    Public MethodEqualsOverloaded. Determines whether the specified object is equal to the current object. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public MethodGetConnectedPinsOverridden.  Gets pins to which this wire is connected.  
    Public MethodGetControlPointsOverridden. Gets all control point on this control path.  
    Public MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public MethodReconnectOverridden.  Reconnect this shield from one grouped pin to another.  
    Public MethodToStringReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Top
    See Also

    Reference

    OccWdShieldWire Members
    EPLAN.Harness.API.Occurrences.Workdesk Namespace
    IOccShieldWire Interface
    IOccShield Interface
    IOccConductiveShield Interface

    Send Feedback