API Help
Eplan.EplApi.DataModel Namespace / MergedConnection Class
Members

In This Topic
    MergedConnection Class
    In This Topic
    MergedConnection is a class used to collect all connections between two corresponding functions in different placement types Merged connection holds an internal, sorted list of covered connections, as well as a property list built by "merging" properties of the covered connections Note: Setting properties of a merged connection changes values in the internal property list. The new values are NOT automatically stored in the covered objects.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.MergedConnection

    Syntax
    public class MergedConnection : StorableObject 
    public ref class MergedConnection : public StorableObject 
    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    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 PropertyReturns the first object covered by this merged connection.  
    Public PropertyReturns the FunctionDefinition of the merged connection.  
    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 PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    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 an array of Connections covered by this merged connection.  
    Public PropertyName of the merged connection.  
    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 project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property.NET Property enabling access to P8 properties of the DocumentBase object.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Initializes the MergedConnection object to cover the connections passed in the array parameter. If the connections cannot be merged together into one merged connection an exception is thrown. connections, generally, cannot be merged together if they belong to different devices or they are of different categories. To be merged, they have to represent the same connectional part of the device.  
    Public Methodstatic (Shared in Visual Basic)Returns an array of MergedConnection objects created from the connections passed in the array parameter. connections that belong to representing the same corresponding connections with different placement types are merged together into one merged connection in the output vector.  
    Public MethodDestructor (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 value of merged property having given property id.  
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns if the objects is a connection covered by this merged connection.  
    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 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