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

C#
C++/CLI

public class MergedFunction : StorableObject

public ref class MergedFunction : public StorableObject

Public Constructors

	Name	Description
	MergedFunction Constructor	Overloaded.

Top

Public Properties

	Name	Description
	CrossReferencedObjectsAll	Returns 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)
	DatabaseIdentifier	Returns 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)
	FirstWinner	Returns the first object covered by this merged function.
	FunctionDefinition	Returns the FunctionDefinition of the merged function.
	IsLocked	Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsReadOnly	Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsTransient	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)
	IsValid	Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	MergedObjects	Returns an array of StorableObjects covered by this merged function.
	NameParts	Name of the merged function.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	List of P8 properties of the MergedFunction object.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Public Methods

	Name	Description
	Create	Overloaded. 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.
	CreateMergedFunctions	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.
	Dispose()	Destructor (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetMainPlacement	Returns main placement this MergedFunction by parameters.
	GetMergedProperty	Returns value of merged property having given property id.
	GetTypeName	Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsCovered	Returns if the objects is a function or a connection covered by this merged function.
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	SmartLock	Tries 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)
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

MergedFunction Members
Eplan.EplApi.DataModel Namespace

Send Feedback