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

In This Topic
    DaisyChain Class
    In This Topic
    Represents daisy chain object of a net definition point.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.DaisyChain

    Syntax
    public class DaisyChain : StorableObject 
    public ref class DaisyChain : public StorableObject 
    Example
    The following example shows how to create, modify and remove daisy chains.
    //create new DaisyChain
    DaisyChain newDaisyChain = netDefinitionPoint.AddDaisyChain(
        new[]{
            netDefinitionPoint.NetConnectionPoints[0],
            netDefinitionPoint.NetConnectionPoints[2],
            netDefinitionPoint.NetConnectionPoints[3]
        });
    
    //list connection points of a DaisyChain
    foreach (var connectionPoint in newDaisyChain.NetbasedWiringIds)
        Console.WriteLine(connectionPoint);    // will output IDs of netDefinitionPoint.NetConnectionPoints[0],
                                               // netDefinitionPoint.NetConnectionPoints[2],
                                               // netDefinitionPoint.NetConnectionPoints[3]
    
    //list connections of a DaisyChain
    foreach (var connection in newDaisyChain.Connections)
        Console.WriteLine(connection.Properties.CONNECTION_SOURCE + " <=> " + connection.Properties.CONNECTION_DESTINATION);
    // will output 2 connections :
    // netDefinitionPoint.NetConnectionPoints[0] <=> netDefinitionPoint.NetConnectionPoints[2]
    // netDefinitionPoint.NetConnectionPoints[2] <=> netDefinitionPoint.NetConnectionPoints[3]
    
    newDaisyChain.AddConnectionPoint(netDefinitionPoint.NetConnectionPoints[1], 1);
    
    //list of net based wiring ids of a DaisyChain
    foreach (var connectionPoint in newDaisyChain.NetbasedWiringIds)
        Console.WriteLine(connectionPoint);    // will output IDs of netDefinitionPoint.NetConnectionPoints[0],
                                               // netDefinitionPoint.NetConnectionPoints[1]
                                               // netDefinitionPoint.NetConnectionPoints[2]
                                               // , netDefinitionPoint.NetConnectionPoints[3]
                                               //list connection points of a DaisyChain
    
    foreach (var connectionPoint in newDaisyChain.ConnectionPoints)
        Console.WriteLine(connectionPoint);    // will output connection points netDefinitionPoint.NetConnectionPoints[0],
                                               // netDefinitionPoint.NetConnectionPoints[1]
                                               // netDefinitionPoint.NetConnectionPoints[2]
                                               // , netDefinitionPoint.NetConnectionPoints[3]
    
    
    //list connections of a DaisyChain
    foreach (var connection in newDaisyChain.Connections)
        Console.WriteLine(connection.Properties.CONNECTION_SOURCE + " <=> " + connection.Properties.CONNECTION_DESTINATION);
    // will output 3 connections :
    // netDefinitionPoint.NetConnectionPoints[0] <=> netDefinitionPoint.NetConnectionPoints[1]
    // netDefinitionPoint.NetConnectionPoints[1] <=> netDefinitionPoint.NetConnectionPoints[2]
    // netDefinitionPoint.NetConnectionPoints[2] <=> netDefinitionPoint.NetConnectionPoints[3]
    
    //remove DaisyChain
    netDefinitionPoint.RemoveDaisyChain(newDaisyChain);
    
    
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns connection points belonging to the current daisy chain  
    Public PropertyReturns connections  
    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 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 net-based Ids  
    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 PropertyEPLAN properties of the DaisyChain object.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds a new net connection point and creates connection  
    Public MethodDestructor for deterministic finalization of DaisyChain 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 MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodRemoves a net connection point and connection  
    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