Harness proD API Help
EPLAN.Harness.API.Occurrences.Workspace Namespace / OccWsCable Class
Members
In This Topic
    OccWsCable Class
    In This Topic
    Represents a cable occurrence from a workspace.
    Object Model
    OccWsCable ClassBooleanProperty ClassIOccCableUnit InterfaceColorProperty ClassBooleanProperty ClassTextProperty ClassBooleanProperty ClassBooleanProperty ClassBooleanProperty ClassBooleanProperty ClassBooleanProperty ClassLengthProperty ClassBooleanProperty ClassBaseLibraryPart ClassLengthProperty ClassLibraryPartNumber ClassVoltageProperty ClassDecimalProperty ClassTextProperty ClassLengthProperty ClassLengthProperty ClassProperty ClassBooleanProperty ClassTextProperty ClassBooleanProperty 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.BaseWsCable
                      EPLAN.Harness.API.Occurrences.Workspace.OccWsCable

    Syntax
    Public Properties
     NameDescription
    Public Property Gets or sets the value of the 'Bending radii check' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Get cable sub-parts in a flattened collection instead of traversing within the tree structure of Children property. Returns occurrences of type: IOccInsulator, IOccShield, IOccCableWire, IOccCablesTwist, IOccLatentWire. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets the cable unit in which this occurrence is included. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public Property Gets the color of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the 'Customized tolerance' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the electrical class of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the electrical options of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    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. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the 'Fixed length' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public Property Gets or sets the value of the 'In bill of material' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    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 Property Gets the length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Specifies annotation visibility of cable/wire length. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public Property Gets the manufactured length of this occurrence. Gets the manufactured length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the manufacturer's part number of this occurrence.  
    Public Property Gets the maximal voltage for this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets the minimum bending radius factor of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the name of the occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public 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.Workspace.BaseWsCable)
    Public Property Gets parent occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public Property Gets or sets the required length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the required length tolerance of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the value of 'Selectable' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the separation code of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets snapping cable/wire length to required length. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the supplier's company name of this occurrence.  
    Public Property Gets or sets a list of user-defined properties of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public Property Gets or sets the wire harness in which this occurrence is included. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public PropertyContains all wires (including conductive shields) of this cable. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    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 MethodGets all control point on this control path. (Inherited from EPLAN.Harness.API.Occurrences.Workspace.BaseWsCable)
    Public MethodServes as the default hash function. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    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