Annotation Type MatlabFunction


  • @Retention(RUNTIME)
    @Target(METHOD)
    public @interface MatlabFunction
    Information about a MATLAB function.
    Since:
    4.2.0
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      Either the name of a MATLAB function or a path to a MATLAB function.
    • Element Detail

      • value

        java.lang.String value
        Either the name of a MATLAB function or a path to a MATLAB function. The value provided to this element is resolved in the following order:
        1. Valid MATLAB function name
          The value will be treated as a function on MATLAB's path. Whether a function with the specified name is actually on MATLAB's path will not be confirmed.
        2. Absolute path to an m-file
          The value will be treated as the location of an m-file. The file's existence will be confirmed.
        3. Relative path to an m-file
          The value will be treated as the location of an m-file relative to the root directory of the interface which declared the method being annotated. For example if the interface is com.example.MyInterface located at /projects/code/numera/com/example/MyInterface.java then path will be resolved relative to /projects/code/numera/. This path can be resolved properly when both the interface and m-file are inside of a zip file such as a jar or war file. The file's existence will be confirmed.
        The validity of this element's value will be determined when the interface containing the method being annotated is provided to MatlabFunctionLinker#link(java.lang.Class, matlabcontrol.MatlabProxy).
        Returns: