Eplan Platform API
Eplan.EplApi.DataModel Namespace / Pin Class
Members

In This Topic
    Pin Class
    In This Topic
    This class represents a function's connection point.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.PinBase
          Eplan.EplApi.DataModel.Pin

    Syntax
    public sealed class Pin : PinBase 
    public ref class Pin sealed : public PinBase 
    Remarks
    * Function's connection points are sometimes called 'logical' since they have some properties stored in the function's logic, as opposed to 'graphical' connection points of symbols which only carry graphical information (relative location, direction, etc). * A logical connection point may be mapped to the underlying symbol's connection point and return graphical information (location, direction, etc) through properties of the base class or through the Pin::SymbolConnectionPoint property. * Logical connection points may also be returned by a FunctionDefinition object. Such conn. points are not associated with any function so their ParentFunction property, as well as some other properties, are NULL.
    Public Properties
     NameDescription
    Public PropertyDetermines if similar connection point designations are allowed.  
    Public PropertyReturns connections which start or end at this connection point.  
    Public Propertyconsumer source  
    Public PropertyReturns internal designation of this pin.  
    Public PropertyGets the connection point's direction. (Inherited from Eplan.EplApi.DataModel.PinBase)
    Public PropertyA FunctionDefinition object that this connection point belongs to.  
    Public PropertyReturns an index of this connection point. NOTE: This may be an index amongst a function's conn. points (in case this object represents a 'logical' conn. point) or an index amongst a symbol's conn. points (in case this object is just a graphical conn. point of a symbol). (Inherited from Eplan.EplApi.DataModel.PinBase)
    Public PropertyDetermines if intrinsic safety is possible.  
    Public PropertyAssigns whether it is possible to connect a cable to the Pin.  
    Public PropertyQualify the Pin is extern or intern.  
    Public PropertyGets/Sets pin's SourceOrTarget.  
    Public PropertyAssigns the maximum number of JumperBars on the Pin.  
    Public PropertyGets the connection point's position relative to the symbol's insertion point. (Inherited from Eplan.EplApi.DataModel.PinBase)
    Public PropertyThe maximum number of Connections on the Pin.  
    Public PropertyGets the pin's actual designation. This value is equal to FUNC_CONNECTIONDESIGNATION property of the parent function, at the corresponding index.  
    Public PropertyGets/Sets one or more pins from the other side of the parent function, which are 'opposite' to this one.  
    Public PropertyReturns the symbol reference that the logical conn. point represented by this object belongs to. (Inherited from Eplan.EplApi.DataModel.PinBase)
    Public PropertyReturns a function that this connection point belongs to.  
    Public PropertyAssigns a PotentialType to the Pin.  
    Public PropertyAssigns a pin designation or index for PLC tracking.  
    Public PropertyAssigns a SignalType to the Pin.  
    Public PropertyGets/Sets the underlying symbol's connection point assigned to this pin or null.  
    Public PropertyReturns number of connections from this Pin object.  
    Public PropertyReturns Pin objects of other functions connected directly with this conn. point.  
    Public PropertyAssigns a ConnPointType to the Pin.  
    Public PropertyAssigns a PortType to the Pin.  
    Top
    Public Methods
     NameDescription
    Public MethodDestructor for deterministic finalization of Pin object. (Inherited from Eplan.EplApi.DataModel.PinBase)
    Public MethodOverridden. Comparison of two PinBase objects. Comparison is made by comparing each of Pin members instead of internal object id.  
    Public MethodOverridden. Serves as the default hash function.  
    Public MethodReturns a string that represents the current object.  
    Top
    Public Operators
    .NET operator for comparing two Pin objects. Comparison is made by comparing each of Pin members instead of internal object id.
    Top
    See Also