Harness proD API Help
EPLAN.Harness.API.Occurrences.Workdesk Namespace / OccWdWire Class
Properties Methods

In This Topic
    OccWdWire Class Members
    In This Topic

    The following tables list the members exposed by OccWdWire.

    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 PropertyCableUnit Gets the cable unit in which this occurrence is included.  
    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 PropertyConnectedPinsOverridden.  Gets the names of pins to which this occurrence is connected.  
    Public PropertyConnectionDescription Gets or sets the connection description of this occurrence.  
    Public PropertyConnectionDesignationOverridden.  Gets or sets the connection designation of this occurrence.  
    Public PropertyCrossSectionOverridden.  Get or set the cross section of this occurrence.  
    Public PropertyCustomizedTolerance Gets or sets the 'Customized tolerance' property of this occurrence.  
    Public PropertyElClass Gets or sets the electrical class of this occurrence.  
    Public PropertyElectricalOptions Gets or sets the electrical options of this occurrence.  
    Public PropertyEplanExport Gets or sets the value of the 'EPLAN export' property of this occurrence.  
    Public PropertyExportable3DDetermines if this part is to be exported or not when using EPLAN.Harness.API.Projects.Documents.Designer.Export3DFile.  
    Public PropertyFixedLength Gets or sets the 'Fixed length' property of this occurrence.  
    Public PropertyID ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyImprintOverridden.  Gets or sets the imprint of this occurrence.  
    Public PropertyInBom Gets or sets the value of the 'In bill of material' property of this occurrence.  
    Public PropertyInsulation Gets the value of the 'Insulation' property 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 PropertyLengthAnnotationVisibility Specifies annotation visibility of cable/wire length.  
    Public PropertyLibraryPart Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyManufacturer Gets or sets the manufacturer's part number of this occurrence.  
    Public PropertyMaterialCodeOverridden.  Gets the material code of this occurrence.  
    Public PropertyMaxCurrent Gets the maximal current for this occurrence.  
    Public PropertyMaxVoltage Gets the maximal voltage for this occurrence.  
    Public PropertyMinBendingRadiusFactor Gets the minimum bending radius factor of this occurrence.  
    Public PropertyName Gets or sets the name of the occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    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 PropertyP8DisplayedDTGets the P8 displayed device tag. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyP8FullDTGets the P8 full device tag. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyP8FunctionTextGets the P8 function text. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    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 PropertyRequiredLength Gets or sets the required length of this occurrence.  
    Public PropertyRequiredLengthTolerance Gets or sets the required length tolerance of this occurrence.  
    Public PropertyResistivity Gets the resistivity of this occurrence.  
    Public PropertySelectable Gets or sets the value of 'Selectable' property of this occurrence.  
    Public PropertySeparationCode Gets or sets the separation code of this occurrence.  
    Public PropertySnapToRequiredLength Gets or sets snapping cable/wire length to required length.  
    Public PropertyStrands Gets the strands of this occurrence.  
    Public PropertyStripeColor Gets the stripe color of this occurrence.  
    Public PropertySupplier Gets or sets the supplier's company name of this occurrence.  
    Public PropertyUserDefinedPropertiesOverridden.  Gets or sets a list of user-defined properties of this occurrence.  
    Public PropertyWireHarness Gets or sets the wire harness in which this occurrence is included.  
    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
    Extension Methods
     NameDescription
    Public Extension MethodAddToCableUnit Add this occurrence to the cable unit.
    Public Extension MethodAddToComplexEntityAdd this occurrence to the complex entity.
    Public Extension MethodAddToWireHarness Add this occurrence to the wire harness.
    Public Extension MethodAutoRoute Automatically route this routable object.
    Public Extension MethodGetAllControlPoints Gets all control points on the routable occurrence.
    Public Extension MethodRemoveFromCableUnit Remove this occurrence from any cable unit.
    Public Extension MethodRemoveFromComplexEntityRemove this occurrence from complex entity.
    Public Extension MethodRemoveFromWireHarness Remove this occurrence from any wire harness.
    Public Extension MethodRoute Route this routable object through the given bundles.
    Public Extension MethodSemiAutoRoute Route this routable object between the given control points.
    Public Extension MethodUnrouteFromBundles Unroute this routable object from bundles.
    Public Extension MethodUnrouteFromCableTrays Unroute this routable object from cable trays.
    Top
    See Also

    Reference

    OccWdWire Class
    EPLAN.Harness.API.Occurrences.Workdesk Namespace

    Send Feedback