Package com.inductiveautomation.ignition.common.expressions

Class SubscriptExpression

java.lang.Object

com.inductiveautomation.ignition.common.expressions.AbstractExpression

com.inductiveautomation.ignition.common.expressions.SubscriptExpression

All Implemented Interfaces:

Expression

public class SubscriptExpression
extends AbstractExpression

This expression takes a reference to an array, dataset, collection, or map and subscripts inside it to pull out a value, like: {dataset}[0,5]

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.expressions.AbstractExpression

children, context, updateListener

Constructor Summary

Constructors

Constructor	Description
SubscriptExpression()
SubscriptExpression(Expression e, Expression sub1)
SubscriptExpression(Expression e, Expression sub1, Expression sub2)

Method Summary

Modifier and Type	Method	Description
@NonNull QualifiedValue	execute()	Compute and return the value of this expression.
String	getOpName()	Return a human-readable name for the operation that this expression performs.

Methods inherited from class com.inductiveautomation.ignition.common.expressions.AbstractExpression

connect, disconnect, getChildren, setChildren, shutdown, startup

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.expressions.Expression

getType

Constructor Details

SubscriptExpression

public SubscriptExpression(Expression e,
 Expression sub1)

SubscriptExpression

public SubscriptExpression(Expression e,
 Expression sub1,
 Expression sub2)

SubscriptExpression

public SubscriptExpression()

Method Details

execute

public @NonNull QualifiedValue execute()
                                throws ExpressionException

Description copied from interface: Expression

Compute and return the value of this expression.

Returns:

the result of the expression evaluation as a QualifiedValue

Throws:

ExpressionException - if an error occurs during execution

getOpName

public String getOpName()

Description copied from interface: Expression

Return a human-readable name for the operation that this expression performs.

Returns:

the operation name