Harness proD API Help
EPLAN.Harness.API.Occurrences.Workdesk Namespace / OccWdBundle Class
Members
In This Topic
    OccWdBundle Class
    In This Topic
    Represents a bundle occurrence from a workdesk.
    Object Model
    OccWdBundle ClassBooleanProperty ClassLengthProperty ClassDecimalProperty ClassIOccCableUnit InterfacePercentProperty ClassBooleanProperty ClassLengthProperty ClassLengthProperty ClassTextProperty ClassBooleanProperty ClassPercentProperty ClassBooleanProperty ClassBooleanProperty ClassLengthProperty ClassBooleanProperty ClassPercentProperty ClassLengthProperty ClassBooleanProperty ClassBaseLibraryPart ClassTextProperty ClassMaterialInfo ClassLengthProperty ClassTextProperty ClassTextProperty ClassLengthProperty ClassLengthProperty ClassPercentProperty ClassTextProperty ClassTextProperty ClassMultiLanguageTextProperty ClassLengthProperty ClassLengthProperty ClassProperty ClassBooleanProperty ClassBooleanProperty ClassLengthProperty ClassBooleanProperty ClassTextProperty ClassLengthProperty ClassLengthProperty ClassIOccWireHarness Interface
    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.OccWdBundle

    Syntax
    public class OccWdBundle : EPLAN.Harness.API.Occurrences.BaseWdOccurrence, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IBundle, EPLAN.Harness.API.Occurrences.Interfaces.ICableTieHost, EPLAN.Harness.API.Occurrences.Interfaces.ICableUnitAddable, EPLAN.Harness.API.Occurrences.Interfaces.IComplexEntityAddable, EPLAN.Harness.API.Occurrences.Interfaces.IControlPath, EPLAN.Harness.API.Occurrences.Interfaces.IElectricalOptionsMember, EPLAN.Harness.API.Occurrences.Interfaces.IExportable3D, EPLAN.Harness.API.Occurrences.Interfaces.IFixedLengthPath, EPLAN.Harness.API.Occurrences.Interfaces.IGraphicalOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccBundle, EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOrganizer, EPLAN.Harness.API.Occurrences.Interfaces.IOutsideDiameter, EPLAN.Harness.API.Occurrences.Interfaces.IRoutable, EPLAN.Harness.API.Occurrences.Interfaces.IRouteOrganizer, EPLAN.Harness.API.Occurrences.Interfaces.ISegmentRoutable, EPLAN.Harness.API.Occurrences.Interfaces.ISpecialComponentHost, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties, EPLAN.Harness.API.Occurrences.Interfaces.IWireHarnessAddable
    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 PropertyBraidCrossing Gets the braid crossing of this bundle.  
    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 PropertyCurrentlyFilled Gets the currently filled property of this bundle.  
    Public PropertyCustomizedTolerance Gets or sets the 'Customized tolerance' property of this occurrence.  
    Public PropertyDiameter Gets the diameter of this bundle.  
    Public PropertyDiameterRange Gets the diameter range of this bundle.  
    Public PropertyElectricalClass Gets or sets the electrical class of this occurrence.  
    Public PropertyElectricalOptions Gets or sets the electrical options of this occurrence.  
    Public PropertyExportable3DDetermines if this part is to be exported or not when using EPLAN.Harness.API.Projects.Documents.Designer.Export3DFile.  
    Public PropertyFillRatio Gets or sets the fill ratio of this bundle.  
    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 PropertyInBom Gets or sets the value of the 'In bill of material' property of this occurrence.  
    Public PropertyInsideDiameter Gets the inside diameter of this bundle.  
    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 PropertyKnittedDensity Gets the knitted density of this bundle.  
    Public PropertyLength 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 PropertyMaterial Gets or sets the material name of this occurrence.  
    Public PropertyMaxDiameter Gets the maximum diameter of this bundle.  
    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 PropertyOutsideDiameter Gets or sets the outside diameter of this occurrence.  
    Public PropertyOverlappingLength Gets or sets the overlapping length of this bundle.  
    Public PropertyOverlapRatio Gets or sets the overlap ratio of this bundle.  
    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 PropertySelectable Gets or sets the value of 'Selectable' property of this occurrence.  
    Public PropertyShowTrueContent Gets or sets whether the content of the bundle should be visible on a texture. Always returns false when bundle has a surface protection.  
    Public PropertyShrinkDiameter Gets the shrink diameter of this bundle.  
    Public PropertySnapToRequiredLength Gets or sets snapping cable/wire length to required length.  
    Public PropertySupplier Gets or sets the supplier's company name of this occurrence.  
    Public PropertyThickness Gets the thickness of this occurrence.  
    Public PropertyUserDefinedPropertiesOverridden.  Gets or sets a list of user-defined properties of this occurrence.  
    Public PropertyWidth Gets the width 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 MethodGetControlPointsGets all control point on this control path.  
    Public MethodGetEndPoints Gets both end control points of this organizer.  
    Public MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    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 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

    OccWdBundle Members
    EPLAN.Harness.API.Occurrences.Workdesk Namespace

    Send Feedback