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 and Description
static java.lang.String	LEFT
static java.lang.String	RIGHT

Constructor Summary

Constructors

Constructor and Description
LeftOrRightFunction() Deprecated.
LeftOrRightFunction(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
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()
java.lang.String	getName()
java.lang.Class<?>	getType() Returns the type of Object that this function will generate with execute
void	setName(java.lang.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 Detail

LEFT

public static final java.lang.String LEFT

See Also:

Constant Field Values

RIGHT

public static final java.lang.String RIGHT

See Also:

Constant Field Values

Constructor Detail

LeftOrRightFunction

@Deprecated
public LeftOrRightFunction()

Deprecated.

Don't call -for serialization

LeftOrRightFunction

public LeftOrRightFunction(java.lang.String name)

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.

Throws:

ExpressionException

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

getFunctionDisplayName

protected java.lang.String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

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.

getType

public java.lang.Class<?> getType()

Description copied from interface: Function

Returns the type of Object that this function will generate with execute

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)