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

C#
C++/CLI

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

	Name	Description
	AreSameConnectionPointDesignationsAllowed	Determines if similar connection point designations are allowed.
	Connections	Returns connections which start or end at this connection point.
	ConsumerSources	consumer source
	Designation	Returns internal designation of this pin.
	Direction	Gets the connection point's direction. (Inherited from Eplan.EplApi.DataModel.PinBase)
	FunctionDefinition	A FunctionDefinition object that this connection point belongs to.
	Index	Returns 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)
	IntrinsicSafetyPossible	Determines if intrinsic safety is possible.
	isCableConnectionPoint	Assigns whether it is possible to connect a cable to the Pin.
	IsExtern	Qualify the Pin is extern or intern.
	IsSourceOrTarget	Gets/Sets pin's SourceOrTarget.
	JumperBarCount	Assigns the maximum number of JumperBars on the Pin.
	Location	Gets the connection point's position relative to the symbol's insertion point. (Inherited from Eplan.EplApi.DataModel.PinBase)
	MaxConnectionCount	The maximum number of Connections on the Pin.
	Name	Gets the pin's actual designation. This value is equal to FUNC_CONNECTIONDESIGNATION property of the parent function, at the corresponding index.
	OppositePin	Gets/Sets one or more pins from the other side of the parent function, which are 'opposite' to this one.
	Parent	Returns the symbol reference that the logical conn. point represented by this object belongs to. (Inherited from Eplan.EplApi.DataModel.PinBase)
	ParentFunction	Returns a function that this connection point belongs to.
	PinPotential	Assigns a PotentialType to the Pin.
	PlcTracking	Assigns a pin designation or index for PLC tracking.
	Signal	Assigns a SignalType to the Pin.
	SymbolConnPoint	Gets/Sets the underlying symbol's connection point assigned to this pin or `null`.
	TargetCount	Returns number of connections from this Pin object.
	TargetPins	Returns Pin objects of other functions connected directly with this conn. point.
	Type	Assigns a ConnPointType to the Pin.
	TypeOfPort	Assigns a PortType to the Pin.

Top

Public Methods

	Name	Description
	Dispose()	Destructor for deterministic finalization of Pin object. (Inherited from Eplan.EplApi.DataModel.PinBase)
	Equals	Overridden. Comparison of two PinBase objects. Comparison is made by comparing each of Pin members instead of internal object id.
	GetHashCode	Overridden. Serves as the default hash function.
	ToString	Returns a string that represents the current object.

Top

Public Operators

Equality

.NET operator for comparing two Pin objects. Comparison is made by comparing each of Pin members instead of internal object id.

Top

Reference

Pin Members
Eplan.EplApi.DataModel Namespace

Send Feedback