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

public static class DefaultFunctionFactory.OrdinalFunction extends BaseFunction

Takes a single character string and returns the integer codepoint of the character. For example, ordinal("💩") = 0x1F4A9

Constructor Summary

Constructors

Constructor

Description

OrdinalFunction()
Method Summary

Modifier and Type

Method

Description

QualifiedValue

execute(Expression[] args)

Execute this function, and return the function's qualified value.

String

getArgDocString()

Returns a string to be used in the auto-generated function documentation.

Class<?>

getType()

Returns the type that this function will return upon execution

void

initArgs(Expression[] args)

Initialize this function with the given arguments.

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
connect, copy, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- OrdinalFunction
  
  public OrdinalFunction()
Method Details
- execute
  
  public QualifiedValue execute(Expression[] args) throws ExpressionException
  
  Description copied from interface: Function
  
  Execute 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
  
  public void initArgs(Expression[] args)
  
  Description copied from interface: Function
  
  Initialize this function with the given arguments.
  
  Parameters:
  
  args - the arguments for the function
- getType
  
  public Class<?> getType()
  
  Description copied from interface: Function
  
  Returns the type that this function will return upon execution
- getArgDocString
  
  public 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.
  
  Returns:
  
  the argument documentation string