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 Constructor Description CaseFunction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Function
copy()
Returns this.QualifiedValue
execute(Expression[] args)
Execute this function, and return the function's qualified value.java.lang.String
getArgDocString()
Returns a string to be used in the auto-generated function documentation.protected java.lang.String
getFunctionDisplayName()
-
Methods inherited from class com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.SwitchFunction
getCaseType, getType, setCaseType, setType, validateNumArgs
-
Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
executeArg, initArgs, log
-
Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
connect, disconnect, executeAll, shutdown, startup
-
-
-
-
Method Detail
-
execute
public QualifiedValue execute(Expression[] args) throws ExpressionException
Description copied from interface:Function
Execute this function, and return the function's qualified value.- Specified by:
execute
in interfaceFunction
- Overrides:
execute
in classDefaultFunctionFactory.SwitchFunction
- Throws:
ExpressionException
-
getFunctionDisplayName
protected java.lang.String getFunctionDisplayName()
- Overrides:
getFunctionDisplayName
in classDefaultFunctionFactory.SwitchFunction
-
getArgDocString
public java.lang.String getArgDocString()
Description copied from interface:Function
Returns 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:
getArgDocString
in interfaceFunction
- Overrides:
getArgDocString
in classDefaultFunctionFactory.SwitchFunction
-
copy
public Function copy()
Description copied from class:BaseFunction
Returns this. Override to create a clone if you need a unique function object per Expression.- Specified by:
copy
in interfaceFunction
- Overrides:
copy
in classDefaultFunctionFactory.SwitchFunction
-
-