Harness proD API Help
EPLAN.Harness.API.Occurrences.Workdesk Namespace / OccWdRapidConnectableObject Class
Members
In This Topic
    OccWdRapidConnectableObject Class
    In This Topic
    A rapid prototype connectable object in workdesk.
    Object Model
    OccWdRapidConnectableObject ClassBooleanProperty ClassIOccCableUnit InterfaceBooleanProperty ClassBooleanProperty ClassLengthProperty ClassCurrencyProperty ClassBooleanProperty ClassLengthProperty ClassTextProperty ClassIPinBase InterfaceBooleanProperty ClassBooleanProperty ClassTimeProperty ClassBaseLibraryPart ClassBooleanProperty ClassTextProperty ClassTextProperty ClassTextProperty ClassDecimalProperty ClassTextProperty ClassBooleanProperty ClassLengthProperty ClassTemperatureProperty ClassTerminalDesignation ClassTextProperty ClassMassProperty ClassIOccWireHarness InterfaceBooleanProperty ClassBooleanProperty ClassBooleanProperty Class
    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.BaseWdConnectableObject
                      EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject
                         EPLAN.Harness.API.Occurrences.Workdesk.OccWdRapidConnectableObject

    Syntax
    public class OccWdRapidConnectableObject : BaseWdRapidConnectableObject, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.ICableUnitAddable, EPLAN.Harness.API.Occurrences.Interfaces.IComplexEntityAddable, EPLAN.Harness.API.Occurrences.Interfaces.IConnectableObjectBase, EPLAN.Harness.API.Occurrences.Interfaces.IElectricalOptionsMember, EPLAN.Harness.API.Occurrences.Interfaces.IExportable3D, EPLAN.Harness.API.Occurrences.Interfaces.IGraphicalOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccRapidConnectableObject, EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IPatternable, EPLAN.Harness.API.Occurrences.Interfaces.IPinHost, EPLAN.Harness.API.Occurrences.Interfaces.IRapidConnectableObjectBase, EPLAN.Harness.API.Occurrences.Interfaces.IReplaceable<BaseLibConnectableObject>, EPLAN.Harness.API.Occurrences.Interfaces.IReplaceable<LibWireTerminal>, EPLAN.Harness.API.Occurrences.Interfaces.IRotateable, EPLAN.Harness.API.Occurrences.Interfaces.IRPAddPin, EPLAN.Harness.API.Occurrences.Interfaces.ITransformable, EPLAN.Harness.API.Occurrences.Interfaces.ITranslatable, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties, EPLAN.Harness.API.Occurrences.Interfaces.IWireHarnessAddable
    Public Properties
     NameDescription
    Public PropertyAnchored Switch on or switch off the anchor. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyCableUnit Gets the cable unit in which this occurrence is included.  
    Public PropertyCavityPlugRequired Gets or sets the value of the 'Cavity plug required' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyCavitySealRequired Gets or sets the value of the 'Cavity seal required' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyCavitySize Gets the cavity size of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyChildren Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyConnectableObjectType Gets the connectable object type. The value is type of ConnectableObjectType enum. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyCostPerItem Gets the cost per one item of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyElectricalOptions Gets or sets the electrical options of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyExportable3DDetermines if this part is to be exported or not when using EPLAN.Harness.API.Projects.Documents.Designer.Export3DFile. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyFixedExtraLength Gets the fixed extra length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyGender Gets the gender of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyGroupedPinGets grouped pin of this connectable object, if exists. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    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. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    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 PropertyLeadTime Gets the lead time of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyLibraryPart Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyMultipleSealRequired Gets or sets the value of the 'Multiple seal' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyName Gets or sets the name of the occurrence. (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 PropertyPinsGet all pins (graphical and virtual), but without grouped pin. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyPosition Gets (or sets) the position of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyPreferredCoating Gets the preferred coating of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyProductColor Gets the name of the product color of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyQuantityPerPack Gets the quantity per packaging of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyRefDes Gets or sets the RefDes of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyRotation Gets (or sets) the rotation of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertySelectable Gets or sets the value of 'Selectable' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyStrippingLength Gets or sets the stripping length of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyTemperature Gets the 'Temperature' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyTerminalDesignation Gets terminal designation of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyTerminalDevicePosition Gets or sets the terminal device position of this terminal. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyUserDefinedProperties Gets or sets a list of user-defined properties of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyWeightPerItem Gets the weight per item of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    Public PropertyWireHarness Gets or sets the wire harness in which this occurrence is included. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyWireHarnessSeparator Gets or sets the value of the 'Wire harness separator' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyWireTerminalOnPinRequired Gets or sets the value of the 'Wire terminal on pin required' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    Public PropertyWireTerminalRequired Gets or sets the value of the 'Wire terminal required' property of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdConnectableObject)
    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 MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public MethodRapidPartAddPin Add a pin to the rapid part. (Inherited from EPLAN.Harness.API.Occurrences.Workdesk.BaseWdRapidConnectableObject)
    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 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.
    Top
    See Also

    Reference

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

    Send Feedback