Package de.aristaflow.adept2.model.datamanagement

Interface UserDefinedFunction

  • public interface UserDefinedFunction
    User-defined functions (UDF) represent the only way for the ADEPT2-engine to interpret a user-defined data type (UDT). Every UDF belongs specifically to one UDT and is able to interpret (an instance of) the corresponding type. This resembles methods in an object-oriented way.

    A UDF is characterised by the user-defined data type it belongs to, its name, the language in which the UDF is implemented and the return type.

    Author:
    Ulrich Kreher

    • Method Detail

      • getUserDefinedType

        String getUserDefinedType()
        Gets the name (a string) of the user-defined type to which this user-defined function belongs to.
        Returns:
        The name of the user-defined data type this function belongs to.

      • getName

        String getName()
        Gets the unique (with respect to the corresponding user-defined data type) name of this user-defined function.
        Returns:
        The name of this user-defined function.

      • getLanguage

        String getLanguage()
        Gets the name of the programming language this user-defined function is written in. The language has to be interpretable by ADEPT2.
        Returns:
        The name of the programming language in which this user-defined function is implemented.

      • getReturnType

        ProcessConstants.AdeptDataType getReturnType()
        Gets the return type of this user-defined function as a data element type. There are only data types that are understood by ADEPT2.
        Returns:
        The type of the data (de.aristaflow.adept2.base.globals.ProcessConstants.AdeptDataType) returned by this method.