FunctionDefinition Class

In This Topic

The function definition is a pre-defined function available to the system. It defines behavior of the function. In this way, the function definition defines how an object type is to be treated in reports (e.g., contacts in the contact image, terminals in the terminal diagram, etc.). (This reflects the symbol type in EPLAN 5 and the device class in EPLAN 21.) Function definitions are managed in a function definitions library. Function definition is allocated to symbols and is automatically entered into the component when the symbol is placed. The user can enter function definitions into parts and therefore enable the subsequent selection of devices.

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.FunctionDefinition

Syntax

C#
C++/CLI

public class FunctionDefinition : StorableObject

public ref class FunctionDefinition : public StorableObject

Public Constructors

	Name	Description
	FunctionDefinition Constructor	Overloaded.

Top

Public Fields

	Name	Description
	InvalidGroup	A constant value that indicates an invalid (or undefined) function group.
	InvalidId	A constant value that indicates an invalid (or undefined) function ID.

Top

Public Properties

	Name	Description
	BaseSymbol	Gets the best fitting SymbolVariant for this FunctionDefinition. This SymbolVariant can be used to insert SymbolReferences with not yet any SymbolVariant assigned onto pages. This is useful e.g. for InsertInteractions in GED
	Category	Category of FunctionDefinition as enum value.
	CategoryName	Name of FunctionDefinition's Category.
	CategoryRegion	Name of FunctionDefinition's region category. It is 'Area' level in function definitions tree.
	ConnectionPoints	Array of function definition's connection points.
	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)
	Description	Get function definition description
	FunctionDefinitionLibrary	Gets FunctionDefinitionLibrary.
	Group	Group of FunctionDefinition.
	GroupName	Name of the FunctionDefinition's Group.
	Id	FunctionDefinition's ID.
	Identifier	Get identifier from object
	IsCPsCountVariable	Returns whether the count of connection points is specified as variable.
	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)
	IsMainFunction	Gets flag which identifies a main function.
	IsNetConnecting	Get flag whether a function is net-connecting
	IsReadOnly	Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsSafetyRelevant	Get flag whether a function is a safety function
	IsSignalSeparated	Get flag whether signal is separated
	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)
	MainGroup	Name of FunctionDefinition's main group. It is 'Trade' level in function definitions tree.
	Name	Name of the FunctionDefinition.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Project	Overridden. Returns the project the StorableObject belongs to.
	Properties	.NET Property enabling access to P8 properties of the FunctionDefinition object.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Public Methods

	Name	Description
	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)
	GetBaseSymbolFromSpecifiedSymbolLibrary	Gets a base symbol for this function definition that may exist in the given symbol library. This method is useful if this function definition object is initialized without any reference to a project (i.e. initialized with a library from system master data)
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	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

FunctionDefinition Members
Eplan.EplApi.DataModel Namespace

Send Feedback