com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.GradientFunction

java.lang.Object

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

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.GradientFunction

All Implemented Interfaces:

Function

Enclosing class:

DefaultFunctionFactory

public static class DefaultFunctionFactory.GradientFunction
extends BaseFunction

Constructor Summary

Constructors

Constructor and Description
GradientFunction()

Method Summary

Modifier and Type	Method and Description
static java.awt.Color	blend(java.awt.Color c1, java.awt.Color c2, double percentage)
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.
java.lang.Class<?>	getType() Returns the type of Object that this function will generate with execute
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 Detail

GradientFunction

public GradientFunction()

Method Detail

blend

public static java.awt.Color blend(java.awt.Color c1,
                                   java.awt.Color c2,
                                   double percentage)

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

initArgs

public void initArgs(Expression[] args)

Description copied from interface: Function

Initialize this function with the given arguments.

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