Eplan Platform API
Eplan.EplApi.DataModel Namespace / Connection Class
Members Example

In This Topic
    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
    Syntax
    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
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyReturns ArticleReferences that are referenced by Connection.  
    Public PropertyReturns Articles that are referenced by Connection, and only those that are stored in project database.  
    Public PropertyReturns 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.  
    Public PropertyGets/Sets a cable's name to the connection.  
    Public PropertyCheck if the Connection can have Articles.  
    Public PropertyReturns the Eplan.EplApi.DataModel.E3D.Connection3D which is a 3d representation of this connection.  
    Public PropertyAllows 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.  
    Public PropertyReturns the ConnectionDefinitionPoint related to this connection.  
    Public PropertyReturns 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)
    Public PropertyReturns 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)
    Public PropertyIndex of the end function's connection point (0,1,2,...) that the connection is connected to.  
    Public PropertyReturns the end Pin of this connection, if such exists (i.e. if the connection is connected on the target side). Otherwise, NULL is returned.  
    Public PropertyReturns 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.  
    Public PropertyReturns the second of two SymbolReferences connected by this connection.  
    Public PropertyTarget number of end function (1,2,3...)  
    Public PropertyReturns the FunctionDefinition of the Connection.  
    Public PropertyReturns true if this is a Connection object that covers a wire's template in the cable where it belongs.  
    Public PropertyChecks if device to which connection is assign is fixed or not.  
    Public Property

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns true if the placement is placed  
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns true if the Connection can be removed  
    Public PropertyReturns true if this is a transient Connection object representing a cable wire's template.  
    Public Property

    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)
    Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns kind of wire.  
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns the Page where the connection is placed on.  
    Public PropertyReturns the PotentialDefinition related to this connection.  
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property.NET Property enabling access to P8 properties of the Connection object.  
    Public PropertyGets/Sets connection's representation type.  
    Public PropertyReturns the Shielding objects the connection is composed of. It does not return Shielding objects the connection is shielded by.  
    Public PropertyIndex of the start function's connection point (0,1,2,...) that the connection is connected to.  
    Public PropertyReturns the start Pin of this connection, if such exists (i.e. if the connection is connected on the source side). Otherwise, NULL is returned.  
    Public PropertyReturns 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.  
    Public PropertyReturns the first of two SymbolReferences connected by this connection.  
    Public PropertyTarget number of start function (1,2,3...)  
    Public PropertyIf 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.  
    Public PropertyThis 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.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyCheck if object is currently write protected or sets Manual write protection  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds a new ArticleReference to the Connection. Returns the added ArticleReference.  
    Public MethodAssigns 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.  
    Public MethodDestructor for deterministic finalization of Connection object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodChecks if a specific write protection kind was set.  
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodAllows to create non-placed connection from a connection template. In effect connection template becomes covered template.  
    Public MethodTemporarily disables write protection. Note that current write protection  
    Public MethodPlaces 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.  
    Public MethodRemoves the connection from the Project.  
    Public MethodRemoves the ArticleReference from the Connecttion  
    Public MethodTries 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)
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also