Class DefaultFunctionFactory.CaseFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.SwitchFunction
com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.CaseFunction
- All Implemented Interfaces:
Function
- Enclosing class:
DefaultFunctionFactory
public static class DefaultFunctionFactory.CaseFunction
extends DefaultFunctionFactory.SwitchFunction
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()Returns this.execute(Expression[] args) Execute this function, and return the function's qualified value.Returns a string to be used in the auto-generated function documentation.protected StringMethods inherited from class DefaultFunctionFactory.SwitchFunction
getCaseType, getType, setCaseType, setType, validateNumArgsMethods inherited from class AbstractFunction
executeArg, initArgs, logMethods inherited from class BaseFunction
connect, disconnect, executeAll, shutdown, startupMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Function
getDescription
-
Constructor Details
-
CaseFunction
public CaseFunction()
-
-
Method Details
-
execute
Description copied from interface:FunctionExecute this function, and return the function's qualified value.- Specified by:
executein interfaceFunction- Overrides:
executein classDefaultFunctionFactory.SwitchFunction- Parameters:
args- the arguments for the function- Returns:
- the result of the function evaluation as a
QualifiedValue - Throws:
ExpressionException- if an error occurs during execution
-
getFunctionDisplayName
- Overrides:
getFunctionDisplayNamein classDefaultFunctionFactory.SwitchFunction
-
getArgDocString
Description copied from interface:FunctionReturns a string to be used in the auto-generated function documentation. The string should represent the arguments for the function, such as "string, count" for the "repeat" function.- Specified by:
getArgDocStringin interfaceFunction- Overrides:
getArgDocStringin classDefaultFunctionFactory.SwitchFunction- Returns:
- the argument documentation string
-
copy
Description copied from class:BaseFunctionReturns this. Override to create a clone if you need a unique function object per Expression.- Specified by:
copyin interfaceFunction- Overrides:
copyin classDefaultFunctionFactory.SwitchFunction- Returns:
- a copy of this function
-