Class DefaultFunctionFactory.OrdinalFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.OrdinalFunction
- All Implemented Interfaces:
Function
- Enclosing class:
DefaultFunctionFactory
Takes a single character string and returns the integer codepoint of the character. For
example, ordinal("💩") = 0x1F4A9
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexecute(Expression[] args) Execute this function, and return the function's qualified value.Returns a string to be used in the auto-generated function documentation.Class<?> getType()Returns the type that this function will return upon executionvoidinitArgs(Expression[] args) Initialize this function with the given arguments.Methods inherited from class BaseFunction
connect, copy, 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
-
OrdinalFunction
public OrdinalFunction()
-
-
Method Details
-
execute
Description copied from interface:FunctionExecute this function, and return the function's qualified value.- 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
-
initArgs
Description copied from interface:FunctionInitialize this function with the given arguments.- Parameters:
args- the arguments for the function
-
getType
-
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.- Returns:
- the argument documentation string
-