API Help
Eplan.EplApi.DataModel.Topology Namespace / RoutedConnection Class
Members

In This Topic
    RoutedConnection Class
    In This Topic
    Class represents connection between topology devices or functions.
    Inheritance Hierarchy

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

    Syntax
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns Eplan.EplApi.DataModel.ArticleReferences that are referenced by Connection. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns Eplan.EplApi.DataModel.Articles that are referenced by Connection, and only those that are stored in project database. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns Eplan.EplApi.DataModel.EObjects.Cable from a Eplan.EplApi.DataModel.ConnectionDefinitionPoint assigned to this Connection. If there are more then one Eplan.EplApi.DataModel.ConnectionDefinitionPoint assigned to this Connection, an exception is thrown. Such situation has to be handled by calling Eplan.EplApi.DataModel.Connection.ConnectionDefPoints and analyze of the result. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyGets/Sets a cable's name to the connection. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyCheck if the Connection can have Eplan.EplApi.DataModel.Articles. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the Eplan.EplApi.DataModel.E3D.Connection3D which is a 3d representation of this connection. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyAllows to access properties of a Eplan.EplApi.DataModel.ConnectionDefinitionPoint assigned to this Connection. If there are more then one Eplan.EplApi.DataModel.ConnectionDefinitionPoint assigned to this Connection, an exception is thrown. Such situation has to be handled by calling Eplan.EplApi.DataModel.Connection.ConnectionDefPoints and analyze of the result. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the Eplan.EplApi.DataModel.ConnectionDefinitionPoint related to this connection. (Inherited from Eplan.EplApi.DataModel.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 PropertyEplan.EplApi.DataModel.ConnectionPointPosition by which this connection is connected to Eplan.EplApi.DataModel.Connection.EndSymbolReference.  
    Public PropertyIndex of the end function's connection point (0,1,2,...) that the connection is connected to. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the end Eplan.EplApi.DataModel.Pin of this connection, if such exists (i.e. if the connection is connected on the target side). Otherwise, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the Eplan.EplApi.DataModel.PinBase which this connection is connected to on the target side. If this connection is not connected on the target side, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the second of two Eplan.EplApi.DataModel.SymbolReferences connected by this connection. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyTarget number of end function (1,2,3...) (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the Eplan.EplApi.DataModel.FunctionDefinition of the Connection. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns true if this is a Connection object that covers a wire's template in the cable where it belongs. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyChecks if device to which connection is assign is fixed or not. (Inherited from Eplan.EplApi.DataModel.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 PropertyReturns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns true if the Connection can be removed (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns true if this is a transient Connection object representing a cable wire's template. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public Property

    Determines if the the StorableObject is transient.

    The StorableObject is transient when it was created by default constructor and:

    it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project,

    it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.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. (Inherited from Eplan.EplApi.DataModel.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 Eplan.EplApi.DataModel.Page where the connection is placed on. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyArray of Segment by which this connection is passing through.  
    Public PropertyReturns the Eplan.EplApi.DataModel.PotentialDefinition related to this connection. (Inherited from Eplan.EplApi.DataModel.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 RoutedConnection object.  
    Public PropertyGets/Sets connection's representation type. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyArray of Segment by which this connection will be routed by routing algorithms.  
    Public PropertyReturns the Shielding objects the connection is composed of. It does not return Shielding objects the connection is shielded by. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyEplan.EplApi.DataModel.ConnectionPointPosition by which this connection is connected to Eplan.EplApi.DataModel.Connection.StartSymbolReference.  
    Public PropertyIndex of the start function's connection point (0,1,2,...) that the connection is connected to. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the start Eplan.EplApi.DataModel.Pin of this connection, if such exists (i.e. if the connection is connected on the source side). Otherwise, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the Eplan.EplApi.DataModel.PinBase which this connection is connected to on the source side. If this connection is not connected on the source side, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyReturns the first of two Eplan.EplApi.DataModel.SymbolReferences connected by this connection. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public PropertyTarget number of start function (1,2,3...) (Inherited from Eplan.EplApi.DataModel.Connection)
    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. (Inherited from Eplan.EplApi.DataModel.Connection)
    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. (Inherited from Eplan.EplApi.DataModel.Connection)
    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 (Inherited from Eplan.EplApi.DataModel.Connection)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds a new Eplan.EplApi.DataModel.ArticleReference to the Connection. Returns the added Eplan.EplApi.DataModel.ArticleReference. (Inherited from Eplan.EplApi.DataModel.Connection)
    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. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public MethodClears all segments from routing path.  
    Public MethodDestructor for deterministic finalization of RoutedConnection 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 MethodChecks if a specific write protection kind was set. (Inherited from Eplan.EplApi.DataModel.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 MethodAllows to create non-placed connection from a connection template. In effect connection template becomes covered template. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public MethodTemporarily disables write protection. Note that current write protection (Inherited from Eplan.EplApi.DataModel.Connection)
    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 Eplan.EplApi.DataModel.DisableConnectionUpdateStep object to make the performance better. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public MethodRemoves the connection from the Eplan.EplApi.DataModel.Project. (Inherited from Eplan.EplApi.DataModel.Connection)
    Public MethodRemoves the ArticleReference from the Connecttion (Inherited from Eplan.EplApi.DataModel.Connection)
    Public MethodTries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.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