Class PropertyFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
com.inductiveautomation.perspective.gateway.expression.PropertyFunction
- All Implemented Interfaces:
Function
-
Method Summary
Modifier and TypeMethodDescriptionvoidconnect(CommonContext context, InteractionListener updateListener) Empty implementation from BaseFunction.voidEmpty implementation from BaseFunction.execute(Expression[] args) Execute this function, and return the function's qualified value.Returns a string to be used in the auto-generated function documentation.protected Stringvoidshutdown()Empty implementation from BaseFunction.protected booleanvalidateNumArgs(int num) Methods inherited from class AbstractFunction
executeArg, initArgs, logMethods inherited from class BaseFunction
copy, executeAll, startupMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Function
getDescription, getType
-
Method Details
-
connect
Description copied from class:BaseFunctionEmpty implementation from BaseFunction. Override if necessary.- Specified by:
connectin interfaceFunction- Overrides:
connectin classBaseFunction- Parameters:
context- theCommonContextused to look up external resourcesupdateListener- theInteractionListenerto notify when the function value changes
-
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
-
disconnect
public void disconnect()Description copied from class:BaseFunctionEmpty implementation from BaseFunction. Override if necessary.- Specified by:
disconnectin interfaceFunction- Overrides:
disconnectin classBaseFunction
-
shutdown
public void shutdown()Description copied from class:BaseFunctionEmpty implementation from BaseFunction. Override if necessary.- Specified by:
shutdownin interfaceFunction- Overrides:
shutdownin classBaseFunction
-
getFunctionDisplayName
- Specified by:
getFunctionDisplayNamein classAbstractFunction
-
validateNumArgs
protected boolean validateNumArgs(int num) - Overrides:
validateNumArgsin classAbstractFunction
-
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
-