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

In This Topic
    MergedFunction Class
    In This Topic
    MergedFunction is a class used to collect all functions of one device (i.e. all functions with the same device tag) that represent one functional part of the device (e.g. all placements of the device's main function). Merged function holds an internal, sorted list of covered functions, as well as a property list built by "merging" properties of the covered functions Note: Setting properties of a merged function 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.MergedFunction
             Eplan.EplApi.DataModel.PLCMergedFunction

    Syntax
    public class MergedFunction : StorableObject 
    public ref class MergedFunction : 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 function.  
    Public PropertyReturns the FunctionDefinition of the merged function.  
    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 StorableObjects covered by this merged function.  
    Public PropertyName of the merged function.  
    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 PropertyList of P8 properties of the MergedFunction object.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Initializes the MergedFunction object to cover the functions passed in the array parameter. If the functions cannot be merged together into one merged function an exception is thrown. Functions, 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 functional part of the device.  
    Public Methodstatic (Shared in Visual Basic)Returns an array of MergedFunction objects created from the functions passed in the array parameter. Functions that belong to the same device and represent one functional part of the device are merged together into one merged function 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 main placement this MergedFunction by parameters.  
    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 function or a connection covered by this merged function.  
    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