Harness proD API Help
EPLAN.Harness.API.Occurrences.Workspace Namespace / OccWsWire Class
Members
In This Topic
    OccWsWire Class
    In This Topic
    Represents a wire occurrence from a workspace.
    Object Model
    OccWsWire ClassBooleanProperty ClassLengthProperty ClassIOccCableUnit InterfaceColorProperty ClassTextProperty ClassAreaProperty ClassBooleanProperty ClassTextProperty ClassBooleanProperty ClassBooleanProperty ClassBooleanProperty ClassTextProperty ClassBooleanProperty ClassBooleanProperty ClassBooleanProperty ClassLengthProperty ClassBooleanProperty ClassBaseLibraryPart ClassLibraryPartNumber ClassTextProperty ClassCurrentProperty ClassVoltageProperty ClassDecimalProperty ClassTextProperty ClassLengthProperty ClassLengthProperty ClassLengthProperty ClassProperty ClassResistivityProperty ClassBooleanProperty ClassTextProperty ClassBooleanProperty ClassTextProperty ClassColorProperty ClassLibraryPartNumber ClassIOccWireHarness Interface
    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.OccWsWire

    Syntax
    public class OccWsWire : BaseWsWire, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IAutoRoutable, EPLAN.Harness.API.Occurrences.Interfaces.ICableUnitAddable, EPLAN.Harness.API.Occurrences.Interfaces.IComplexEntityAddable, EPLAN.Harness.API.Occurrences.Interfaces.IControlPath, EPLAN.Harness.API.Occurrences.Interfaces.IControlPathWithBendingRadiusFactor, EPLAN.Harness.API.Occurrences.Interfaces.IControlPathWithEnds, EPLAN.Harness.API.Occurrences.Interfaces.IElectricalOptionsMember, EPLAN.Harness.API.Occurrences.Interfaces.IEplanExportable, EPLAN.Harness.API.Occurrences.Interfaces.IExportable3D, EPLAN.Harness.API.Occurrences.Interfaces.IFixedLengthPath, EPLAN.Harness.API.Occurrences.Interfaces.IGraphicalOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.ILibraryOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccWire, EPLAN.Harness.API.Occurrences.Interfaces.IReconnectable, EPLAN.Harness.API.Occurrences.Interfaces.IReplaceable<LibWire>, EPLAN.Harness.API.Occurrences.Interfaces.IRoutable, EPLAN.Harness.API.Occurrences.Interfaces.ISegmentRoutable, EPLAN.Harness.API.Occurrences.Interfaces.ISpecialComponentHost, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties, EPLAN.Harness.API.Occurrences.Interfaces.IWire, EPLAN.Harness.API.Occurrences.Interfaces.IWireCommon, EPLAN.Harness.API.Occurrences.Interfaces.IWireElectricalOptions, EPLAN.Harness.API.Occurrences.Interfaces.IWireHarnessAddable  
    Public Properties
     NameDescription
    Public Property Gets or sets the value of the 'Bending radii check' property of this occurrence.  
    Public Property Gets the bending radius of this occurrence.  
    Public Property Gets the cable unit in which this occurrence is included.  
    Public Property Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyOverridden.  Gets or sets the color of this occurrence.  
    Public PropertyOverridden.  Gets the names of pins to which this occurrence is connected.  
    Public PropertyOverridden.  Get or set the cross section of this occurrence.  
    Public Property Gets or sets the 'Customized tolerance' property of this occurrence.  
    Public Property Gets or sets the electrical class of this occurrence.  
    Public Property Gets or sets the electrical options of this occurrence.  
    Public Property Gets or sets the value of the 'EPLAN export' property of this occurrence.  
    Public PropertyDetermines if this part is to be exported or not when using EPLAN.Harness.API.Projects.Documents.Designer.Export3DFile.  
    Public Property Gets or sets the 'Fixed length' property of this occurrence.  
    Public Property ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyOverridden.  Gets or sets the imprint of this occurrence.  
    Public Property Gets or sets the value of the 'In bill of material' property of this occurrence.  
    Public Property Gets the value of the 'Insulation' property of this occurrence.  
    Public Property Gets or sets the interpolation algorithm of this occurrence.  
    Public Property Is the part a rapid prototype? (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public Property Tells you whether this object is valid or not. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyOverridden.  Gets the length of this occurrence.  
    Public Property Specifies annotation visibility of cable/wire length.  
    Public Property Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public Property Gets or sets the manufacturer's part number of this occurrence.  
    Public PropertyOverridden.  Gets the material code of this occurrence.  
    Public Property Gets the maximal current for this occurrence.  
    Public Property Gets the maximal voltage for this occurrence.  
    Public Property Gets the minimum bending radius factor of this occurrence.  
    Public Property Gets or sets the name of the occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyOverridden.  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 Property Gets parent occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public Property Gets the raw length of this occurrence.  
    Public Property Gets or sets the required length of this occurrence.  
    Public Property Gets or sets the required length tolerance of this occurrence.  
    Public Property Gets the resistivity of this occurrence.  
    Public Property Gets or sets the value of 'Selectable' property of this occurrence.  
    Public Property Gets or sets the separation code of this occurrence.  
    Public Property Gets or sets snapping cable/wire length to required length.  
    Public Property Gets the strands of this occurrence.  
    Public Property Gets the stripe color of this occurrence.  
    Public Property Gets or sets the supplier's company name of this occurrence.  
    Public PropertyOverridden.  Gets or sets a list of user-defined properties of this occurrence.  
    Public Property Gets or sets the wire harness in which this occurrence is included.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Determines whether the specified object is equal to the current object. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public MethodOverridden.  Gets pins to which this wire is connected.  
    Public MethodOverridden. Gets all control point on this control path.  
    Public MethodServes as the default hash function. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public MethodOverridden.  Reconnect this shield from one grouped pin to another.  
    Public MethodReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Top
    Extension Methods
     NameDescription
    Public Extension Method Add this occurrence to the cable unit.
    Public Extension MethodAdd this occurrence to the complex entity.
    Public Extension Method Add this occurrence to the wire harness.
    Public Extension Method Automatically route this routable object.
    Public Extension Method Gets all control points on the routable occurrence.
    Public Extension Method Remove this occurrence from any cable unit.
    Public Extension MethodRemove this occurrence from complex entity.
    Public Extension Method Remove this occurrence from any wire harness.
    Public Extension Method Route this routable object through the given bundles.
    Public Extension Method Route this routable object between the given control points.
    Public Extension Method Unroute this routable object.
    Top
    See Also