Package com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.LeftOrRightFunction

java.lang.Object

com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.LeftOrRightFunction

All Implemented Interfaces:

Function

Enclosing class:

DefaultFunctionFactory

public static class DefaultFunctionFactory.LeftOrRightFunction
extends AbstractFunction

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LEFT
static final String	RIGHT

Constructor Summary

Constructors

Constructor	Description
LeftOrRightFunction()	Deprecated.
LeftOrRightFunction(String name)

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.
protected String	getFunctionDisplayName()
String	getName()
Class<?>	getType()	Returns the type that this function will return upon execution
void	setName(String name)
protected boolean	validateNumArgs(int num)

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, copy, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LEFT

public static final String LEFT

See Also:

• Constant Field Values

RIGHT

public static final String RIGHT

See Also:

• Constant Field Values

Constructor Details

LeftOrRightFunction

@Deprecated
public LeftOrRightFunction()

Deprecated.

Don't call -for serialization

LeftOrRightFunction

public LeftOrRightFunction(String name)

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

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

getFunctionDisplayName

protected String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

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

getType

public Class<?> getType()

Description copied from interface: Function

Returns the type that this function will return upon execution

getName

public String getName()

setName

public void setName(String name)