Connection Class

In This Topic

This class represents a connection between two Functions (two devices in the project). The following example shows how to use class Connection.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.Connection
         Eplan.EplApi.DataModel.E3D.Connection3D
         Eplan.EplApi.DataModel.Topology.RoutedConnection

Syntax

C#
C++/CLI

public class Connection : StorableObject, IArticleUser, IWriteProtection

public ref class Connection : public StorableObject, IArticleUser, IWriteProtection

Remarks

Some properties of Data model classes are not linked with their owners even if from the syntax it may seem otherwise. Like in this line: oRectangle.Pen.ColorId = 5, the ColorId of the Pen is changed but oRectangle object doesn't know about it since the Pen property is a stand alone value not aware of oRectangle object existence. This remark applies to the following Connection properties: Articles, Shieldings, SubConnections, SymbolReferences, Pins.

Example

The following example shows how to use class Connection.

Function oFunction = null;
foreach (Page oP in m_oTestProject.Pages)
{
    if (oP.PageType == DocumentTypeManager.DocumentType.Circuit)
    {
        foreach (Function oF in oP.Functions)
        {
            if (oF.Connections.Length > 0)
            {
                oFunction = oF;
                break;
            }
        }
    }
}

Function oStartFunc = null;
Function oEndFunc = null;

foreach (Connection oC in oFunction.Connections)
{
    oStartFunc = ((Function)oC.StartSymbolReference);
    oEndFunc = ((Function)oC.EndSymbolReference);

    Console.Out.WriteLine("StartSymbolReference: " + oStartFunc.Name);
    Console.Out.WriteLine("EndSymbolReference: " + oEndFunc.Name);
}

Public Constructors

	Name	Description
	Connection Constructor	Overloaded.

Top

Public Properties

	Name	Description
	ArticleReferences	Returns ArticleReferences that are referenced by Connection.
	Articles	Returns Articles that are referenced by Connection, and only those that are stored in project database.
	CableDefinitionLine	Returns Eplan.EplApi.DataModel.EObjects.Cable from a ConnectionDefinitionPoint assigned to this Connection. If there are more then one ConnectionDefinitionPoint assigned to this Connection, an exception is thrown. Such situation has to be handled by calling ConnectionDefPoints and analyze of the result.
	CableNameParts	Gets/Sets a cable's name to the connection.
	CanHaveArticleData	Check if the Connection can have Articles.
	Connection3D	Returns the Eplan.EplApi.DataModel.E3D.Connection3D which is a 3d representation of this connection.
	ConnectionDefPointProperties	Allows to access properties of a ConnectionDefinitionPoint assigned to this Connection. If there are more then one ConnectionDefinitionPoint assigned to this Connection, an exception is thrown. Such situation has to be handled by calling ConnectionDefPoints and analyze of the result.
	ConnectionDefPoints	Returns the ConnectionDefinitionPoint related to this connection.
	CrossReferencedObjectsAll	Returns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
	DatabaseIdentifier	Returns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	EndIndex	Index of the end function's connection point (0,1,2,...) that the connection is connected to.
	EndPin	Returns the end Pin of this connection, if such exists (i.e. if the connection is connected on the target side). Otherwise, NULL is returned.
	EndSymbolConnPoint	Returns the PinBase which this connection is connected to on the target side. If this connection is not connected on the target side, NULL is returned.
	EndSymbolReference	Returns the second of two SymbolReferences connected by this connection.
	EndTargetNumber	Target number of end function (1,2,3...)
	FunctionDefinition	Returns the FunctionDefinition of the Connection.
	IsCoveredTemplate	Returns true if this is a Connection object that covers a wire's template in the cable where it belongs.
	IsFixedDevice	Checks if device to which connection is assign is fixed or not.
	IsLocked	Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsPlaced	Returns true if the placement is placed
	IsReadOnly	Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsRemovable	Returns true if the Connection can be removed
	IsTemplate	Returns true if this is a transient Connection object representing a cable wire's template.
	IsTransient	Determines if the the StorableObject is transient. The StorableObject is transient when it was created by default constructor and: it is a Page and it was not assigned a Project, it is a Placement or any class derived from it and was not assigned a Page. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsValid	Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	KindOfWire	Returns kind of wire.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Page	Returns the Page where the connection is placed on.
	PotentialDefinitions	Returns the PotentialDefinition related to this connection.
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	.NET Property enabling access to P8 properties of the Connection object.
	RepresentationType	Gets/Sets connection's representation type.
	Shieldings	Returns the Shielding objects the connection is composed of. It does not return Shielding objects the connection is shielded by.
	StartIndex	Index of the start function's connection point (0,1,2,...) that the connection is connected to.
	StartPin	Returns the start Pin of this connection, if such exists (i.e. if the connection is connected on the source side). Otherwise, NULL is returned.
	StartSymbolConnPoint	Returns the PinBase which this connection is connected to on the source side. If this connection is not connected on the source side, NULL is returned.
	StartSymbolReference	Returns the first of two SymbolReferences connected by this connection.
	StartTargetNumber	Target number of start function (1,2,3...)
	SubConnections	If connection contains interruption points, this method returns an array of partial connections which current connection consists of For a "net connection" this method will return an empty array.
	SymbolReferences	This method returns an array of SymbolReferences objects that belong to a connection . This may for example be T-pieces or corners. Also beginning and end are returned.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	WriteProtected	Check if object is currently write protected or sets Manual write protection

Top

Public Methods

	Name	Description
	AddArticleReference	Overloaded. Adds a new ArticleReference to the Connection. Returns the added ArticleReference.
	Assign	Assigns this connection to another, which means that values of this connection's properties are copied to the target connection and the source connection itself is removed from the project.
	Dispose()	Destructor for deterministic finalization of Connection object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetTypeName	Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetWriteProtectionFlagSet	Checks if a specific write protection kind was set.
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	MakePersistent	Allows to create non-placed connection from a connection template. In effect connection template becomes covered template.
	PauseWriteProtection	Temporarily disables write protection. Note that current write protection
	PlaceAsConnectionDefinitionPoint	Places this connection as a connection def. point on the given schematic page and in the given location. If this is an uncovered connection template and the location points to a connection line on schematic page, the template automatically becomes covered (i.e. connection is created in the project) Note: When uncovered connection template becomes covered, connections on the page are updated which may affect performance. If this method needs to be called repeatedly, use the DisableConnectionUpdateStep object to make the performance better.
	Remove	Removes the connection from the Project.
	RemoveArticleReference	Removes the ArticleReference from the Connecttion
	SmartLock	Tries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

Connection Members
Eplan.EplApi.DataModel Namespace

Send Feedback