Package jmri.jmrit.logixng.util.parser

Interface Function

All Known Implementing Classes:
AbstractFunction
public interface Function
Definition of a function used in expressions.

  • Method Details

    • getModule

      String getModule()
      Get the module of the function, for example "Math" or "Conversion".
      Returns:
      the module name

    • getConstantDescriptions

      String getConstantDescriptions()
      Get the descriptions of the constants in the module.
      Returns:
      the description of the constants

    • getName

      String getName()
      Get name of the function, for example "sin" or "int"
      Returns:
      the name

    • calculate

      Object calculate(SymbolTable symbolTable, List<ExpressionNode> parameterList) throws JmriException
      Calculate the function
      Parameters:
      symbolTable - the symbol table
      parameterList - a list of parameters for the function
      Returns:
      the result
      Throws:
      JmriException - in case of an error

    • getDescription

      String getDescription()
      Get the description of the function in Markdown format
      Returns:
      the description