API Help
Eplan.EplApi.DataModel Namespace / FunctionDefinition Class
Fields Properties Methods

In This Topic
    FunctionDefinition Class Members
    In This Topic

    The following tables list the members exposed by FunctionDefinition.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Fields
     NameDescription
    Public Fieldstatic (Shared in Visual Basic)A constant value that indicates an invalid (or undefined) function group.  
    Public Fieldstatic (Shared in Visual Basic)A constant value that indicates an invalid (or undefined) function ID.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets 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  
    Public PropertyCategory of FunctionDefinition as enum value.  
    Public PropertyName of FunctionDefinition's Category.  
    Public PropertyName of FunctionDefinition's region category. It is 'Area' level in function definitions tree.  
    Public PropertyArray of function definition's connection points.  
    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 PropertyGet function definition description  
    Public PropertyGets FunctionDefinitionLibrary.  
    Public PropertyGroup of FunctionDefinition.  
    Public PropertyName of the FunctionDefinition's Group.  
    Public PropertyFunctionDefinition's ID.  
    Public PropertyOverloaded. Get identifier  
    Public PropertyGets/sets all identifiers (i.e. for all available standards)  
    Public PropertyReturns whether the count of connection points is specified as variable.  
    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 PropertyGets flag which identifies a main function.  
    Public PropertyGet flag whether a function is net-connecting  
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGet flag whether a function is a safety function  
    Public PropertyGet flag whether signal is separated  
    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 PropertyName of FunctionDefinition's main group. It is 'Trade' level in function definitions tree.  
    Public PropertyName of the FunctionDefinition.  
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyOverridden. Returns the project the StorableObject belongs to.  
    Public Property.NET Property enabling access to P8 properties of the FunctionDefinition object.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodDestructor. (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 MethodGets 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)  
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    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