Harness proD API Help
EPLAN.Harness.API.Occurrences.Workspace Namespace / OccWsShield Class
Members
In This Topic
    OccWsShield Class
    In This Topic
    Represents a cable's (non-conductive) shield occurrence from a workspace.
    Object Model
    OccWsShield ClassBooleanProperty ClassLengthProperty ClassLengthProperty ClassColorProperty ClassTextProperty ClassAreaProperty 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.BaseWsOccurrence
                   EPLAN.Harness.API.Occurrences.Workspace.BaseWsWire
                      EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield
                         EPLAN.Harness.API.Occurrences.Workspace.OccWsShield

    Syntax
    public class OccWsShield : BaseWsShield, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.ICableSublayer, EPLAN.Harness.API.Occurrences.Interfaces.IControlPath, EPLAN.Harness.API.Occurrences.Interfaces.IControlPathWithEnds, EPLAN.Harness.API.Occurrences.Interfaces.IGraphicalOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccShield, 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
    This could be either non-conductive shield or a conductive shield which is not connected to any pins (i.e. both ends are placed freely in space). Once conductive shield gets connected to any pin it is transformed into a OccWsConductiveShield.
    Public Properties
     NameDescription
    Public PropertyBendingRadiiCheck Gets or sets the value of the 'Bending radii check' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyBendingRadius Gets the bending radius of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyCableLength Gets the cable length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyChildren Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyColor Gets or sets the color of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyConnectedPins Gets the names of pins to which this occurrence is connected. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyCrossSection Get or set the cross section of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyID ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyImprint Gets or sets the imprint of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyInterpolation Gets or sets the interpolation algorithm of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyIsRapid Is the part a rapid prototype? (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyIsTopLayerSpecifies if this cable's sublayer is the top layer of the cable. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyIsValid Tells you whether this object is valid or not. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyLength Gets the length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyLibraryPart Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyMaterialCode Gets the material code of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyName Gets or sets the name of the occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyOutsideDiameter 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.Workspace.BaseWsShield)
    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. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertySelectable Gets or sets the value of 'Selectable' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public PropertyUserDefinedProperties Gets or sets a list of user-defined properties of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    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 MethodGetConnectedPins Gets pins to which this wire is connected. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public MethodGetControlPointsGets all control point on this control path. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public MethodReconnect Reconnect this shield from one grouped pin to another. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsShield)
    Public MethodToStringReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Top
    See Also

    Reference

    OccWsShield Members
    EPLAN.Harness.API.Occurrences.Workspace Namespace
    IOccShield Interface
    IOccConductiveShield Interface
    IOccShieldWire Interface

    Send Feedback