Class AbstractFunction
- java.lang.Object
-
- jmri.jmrit.logixng.util.parser.functions.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 formatjava.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"
-
-
-
Constructor Detail
-
AbstractFunction
public AbstractFunction(FunctionFactory functionFactory, java.lang.String name, java.lang.String description)
-
-
Method Detail
-
getModule
public java.lang.String getModule()
Description copied from interface:Function
Get the module of the function, for example "Math" or "Conversion".
-
getConstantDescriptions
public java.lang.String getConstantDescriptions()
Description copied from interface:Function
Get the descriptions of the constants in the module.- Specified by:
getConstantDescriptions
in interfaceFunction
- Returns:
- the description of the constants
-
getName
public java.lang.String getName()
Description copied from interface:Function
Get name of the function, for example "sin" or "int"
-
getDescription
public java.lang.String getDescription()
Description copied from interface:Function
Get the description of the function in Markdown format- Specified by:
getDescription
in interfaceFunction
- Returns:
- the description
-
-