Harness proD API Help
EPLAN.Harness.API.Occurrences.Workspace Namespace / OccWsPin Class
Members
In This Topic
    OccWsPin Class
    In This Topic
    Represents a pin occurrence from a workspace.
    Object Model
    OccWsPin ClassBooleanProperty ClassBooleanProperty ClassBooleanProperty ClassLengthProperty ClassTextProperty ClassTextProperty ClassBooleanProperty ClassLengthProperty ClassTextProperty ClassTextProperty ClassBooleanProperty ClassTextProperty ClassBaseLibraryPart ClassBooleanProperty ClassTextProperty ClassTextProperty ClassTextProperty ClassTextProperty ClassTextProperty ClassBooleanProperty ClassLengthProperty ClassTextProperty 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.BaseWsOccurrence
                   EPLAN.Harness.API.Occurrences.Workspace.BaseWsPin
                      EPLAN.Harness.API.Occurrences.Workspace.OccWsPin

    Syntax
    public class OccWsPin : BaseWsPin, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IControlPoint, EPLAN.Harness.API.Occurrences.Interfaces.IElectricalOptionsMember, EPLAN.Harness.API.Occurrences.Interfaces.IGraphicalOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccPin, EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IPinBase, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties
    Public Properties
     NameDescription
    Public PropertyAnchored Switch on or switch off the anchor.  
    Public PropertyCavityPlugRequired Gets or sets the value of the 'Cavity plug required' property of this occurrence.  
    Public PropertyCavitySealRequired Gets or sets the value of the 'Cavity seal required' property of this occurrence.  
    Public PropertyCavitySize Gets the cavity size of this occurrence.  
    Public PropertyChildren Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyConnectionPointDesignations Gets or sets the connection point designations of this occurrence.  
    Public PropertyContactCoilIndex Gets or sets coil index.  
    Public PropertyCustomizedPinRequirements Gets or sets the value of the 'Customized pin requirements' property of this occurrence.  
    Public PropertyElectricalOptions Gets or sets the electrical options of this occurrence.  
    Public PropertyFixedExtraLength Gets the fixed extra length of this occurrence.  
    Public PropertyFullPinName Gets the full pin name of this occurrence.  
    Public PropertyFunctionDefinitionName of the assigned function definition.  
    Public PropertyID ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyIsFlatOverridden.  Specifies if the pin is ribbon connectable.  
    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 PropertyLevel Gets or sets the level of this occurrence.  
    Public PropertyLibraryPart Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyMultipleWireTerminal Gets or sets the value of the 'Multiple wire terminal' property of this occurrence.  
    Public PropertyNameOverridden.  Gets or sets the name of the occurrence.  
    Public PropertyParents Gets parent occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
    Public PropertyPinDesignation Gets or sets the pin designation of this occurrence.  
    Public PropertyPlugDesignation Gets or sets the plug designation of this occurrence.  
    Public PropertyPreferredCoating Gets the preferred coating of this occurrence.  
    Public PropertyRefDes Gets or sets the RefDes of this occurrence.  
    Public PropertySelectable Gets or sets the value of 'Selectable' property of this occurrence.  
    Public PropertyStrippingLength Gets the stripping length of this occurrence.  
    Public PropertyTerminalDesignation Gets or sets the terminal designation of this occurrence.  
    Public PropertyUserDefinedPropertiesOverridden.  Gets or sets a list of user-defined properties of this occurrence.  
    Public PropertyWireTerminalOnPinRequired Gets or sets the value of the 'Wire terminal on pin required' property of this occurrence.  
    Public PropertyWireTerminalRequired Gets or sets the value of the 'Wire terminal required' property of this occurrence.  
    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 MethodGetConnectedWiresOverridden.  Gets all wires that are connected to this pin.  
    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
    See Also

    Reference

    OccWsPin Members
    EPLAN.Harness.API.Occurrences.Workspace Namespace

    Send Feedback