Eplan Platform API
Eplan.EplApi.DataModel Namespace / PLCMergedFunction Class
Properties Methods

In This Topic
    PLCMergedFunction Class Members
    In This Topic

    The following tables list the members exposed by PLCMergedFunction.

    Public Constructors
     NameDescription
    Public ConstructorPLCMergedFunction ConstructorDefault constructor. Creates the PLCMergedFunction object.  
    Top
    Public Properties
     NameDescription
    Public PropertyCrossReferencedObjectsAllReturns 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 PropertyDatabaseIdentifierReturns 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 PropertyFirstWinnerReturns the first object covered by this merged function. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public PropertyFunctionDefinitionReturns the FunctionDefinition of the merged function. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public PropertyIsLocked

    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 PropertyIsReadOnlyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsTransient

    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 PropertyIsValidDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyMergedObjectsReturns an array of StorableObjects covered by this merged function. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public PropertyNamePartsName of the merged function. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyProjectReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPropertiesList of P8 properties of the MergedFunction object. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public PropertyTypeIdentifierReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodCreateOverloaded. 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. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public MethodDispose()Virtual deterministic destructor. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodEqualsOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetMainPlacementReturns main placement this MergedFunction by parameters. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public MethodGetMergedPropertyReturns value of merged property having given property id. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public MethodGetTypeNameReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodIsCoveredReturns if the objects is a function or a connection covered by this merged function. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
    Public MethodLockObjectTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodSmartLockTries 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 MethodToStringIdentifierReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also

    Reference

    PLCMergedFunction Class
    Eplan.EplApi.DataModel Namespace

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Send Feedback