Package jmri.jmrit.logixng.util.parser.functions

Class AbstractFunction

java.lang.Object

jmri.jmrit.logixng.util.parser.functions.AbstractFunction

All Implemented Interfaces:

Function

public abstract class AbstractFunction
extends Object
implements Function

Abstract class to help writing LogixNG functions easier.

Constructor Summary

Constructors

Constructor	Description
AbstractFunction(FunctionFactory functionFactory, String name, String description)

Method Summary

Modifier and Type	Method	Description
String	getConstantDescriptions()	Get the descriptions of the constants in the module.
String	getDescription()	Get the description of the function in Markdown format
String	getModule()	Get the module of the function, for example "Math" or "Conversion".
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

Methods inherited from interface jmri.jmrit.logixng.util.parser.Function

calculate

Constructor Details

AbstractFunction

public AbstractFunction(FunctionFactory functionFactory,
 String name,
 String description)

Method Details

getModule

public 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

getConstantDescriptions

public String getConstantDescriptions()

Description copied from interface: Function

Get the descriptions of the constants in the module.

Specified by:

getConstantDescriptions in interface Function

Returns:

the description of the constants

getName

public 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 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