Name | Description | |
---|---|---|
FunctionDefinition Constructor | Overloaded. |
The following tables list the members exposed by FunctionDefinition.
Name | Description | |
---|---|---|
FunctionDefinition Constructor | Overloaded. |
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. |
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 | |
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 | |
FunctionCategory | ||
FunctionDefinitionLibrary | Gets FunctionDefinitionLibrary. | |
Group | Group of FunctionDefinition. | |
GroupName | Name of the FunctionDefinition's Group. | |
Id | FunctionDefinition's ID. | |
Identifier | Overloaded. Get identifier | |
Identifiers | Gets/sets all identifiers (i.e. for all available standards) | |
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) |
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) | |
GetTypeName | Returns object type name. (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) |