Eplan Platform API
Eplan.EplApi.DataModel Namespace / PLCMergedFunction Class
Members

PLCMergedFunction Class
Specialized merged function for a PLC box device Provides access to the CommunicationEntity objects of the PLC box device.
Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.MergedFunction
         Eplan.EplApi.DataModel.PLCMergedFunction

Syntax
public class PLCMergedFunction : MergedFunction 
Public Constructors
 NameDescription
Public ConstructorDefault constructor. Creates the PLCMergedFunction object.  
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. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
Public PropertyReturns the FunctionDefinition of the merged function. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
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. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
Public PropertyName of the merged function. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
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. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
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. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
Public MethodVirtual deterministic destructor. (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. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
Public MethodReturns value of merged property having given property id. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
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. (Inherited from Eplan.EplApi.DataModel.MergedFunction)
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