Class AbstractFunction

  • All Implemented Interfaces:
    Function

    public abstract class AbstractFunction
    extends java.lang.Object
    implements Function
    Abstract class to help writing LogixNG functions easier.
    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractFunction​(FunctionFactory functionFactory, java.lang.String name, java.lang.String description)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getConstantDescriptions()
      Get the descriptions of the constants in the module.
      java.lang.String getDescription()
      Get the description of the function in Markdown format
      java.lang.String getModule()
      Get the module of the function, for example "Math" or "Conversion".
      java.lang.String getName()
      Get name of the function, for example "sin" or "int"
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getModule

        public java.lang.String getModule()
        Description copied from interface: Function
        Get the module of the function, for example "Math" or "Conversion".
        Specified by:
        getModule in interface Function
        Returns:
        the module name
      • getName

        public java.lang.String getName()
        Description copied from interface: Function
        Get name of the function, for example "sin" or "int"
        Specified by:
        getName in interface Function
        Returns:
        the name
      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Function
        Get the description of the function in Markdown format
        Specified by:
        getDescription in interface Function
        Returns:
        the description