Package com.inductiveautomation.ignition.common.expressions

Class ArithmeticExpression

java.lang.Object

com.inductiveautomation.ignition.common.expressions.AbstractExpression

com.inductiveautomation.ignition.common.expressions.ArithmeticExpression

All Implemented Interfaces:

Expression

public class ArithmeticExpression
extends AbstractExpression

An expression implementation that performs arithmetic operations (addition, subtraction, multiplication, division, power, and modulo) between two sub-expressions.

This class also handles string concatenation if the operation type is addition and one of the operands is a string.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ArithmeticExpression.StringTypeAffinity	Determines how the operation should behave when strings are involved.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DIVIDE
static final int	MINUS
static final int	MOD
static final int	MULT
static final int	PLUS
static final int	POW

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

children, context, updateListener

Constructor Summary

Constructors

Constructor	Description
ArithmeticExpression()
ArithmeticExpression(Expression e1, Expression e2, int opType)
ArithmeticExpression(Expression e1, Expression e2, int opType, boolean forceNumeric)
ArithmeticExpression(Expression e1, Expression e2, int opType, ArithmeticExpression.StringTypeAffinity affinity)

Method Summary

Modifier and Type	Method	Description
protected boolean	eitherString(QualifiedValue v1, QualifiedValue v2)
@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.
int	getOpType()
Class<?>	getType()	Return the type that this expression will return.
boolean	isConcat()
void	setConcat(boolean isConcat)
void	setOpType(int i)

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

Field Details

PLUS

public static final int PLUS

See Also:

• Constant Field Values

MINUS

public static final int MINUS

See Also:

• Constant Field Values

MULT

public static final int MULT

See Also:

• Constant Field Values

DIVIDE

public static final int DIVIDE

See Also:

• Constant Field Values

MOD

public static final int MOD

See Also:

• Constant Field Values

POW

public static final int POW

See Also:

• Constant Field Values

Constructor Details

ArithmeticExpression

public ArithmeticExpression(Expression e1,
 Expression e2,
 int opType)

ArithmeticExpression

public ArithmeticExpression(Expression e1,
 Expression e2,
 int opType,
 boolean forceNumeric)

ArithmeticExpression

public ArithmeticExpression(Expression e1,
 Expression e2,
 int opType,
 ArithmeticExpression.StringTypeAffinity affinity)

ArithmeticExpression

public ArithmeticExpression()

Method Details

eitherString

protected boolean eitherString(QualifiedValue v1,
 QualifiedValue v2)

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

getType

public Class<?> getType()

Description copied from interface: Expression

Return the type that this expression will return.

Returns:

the Class of the value returned by Expression.execute()

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

getOpType

public int getOpType()

setOpType

public void setOpType(int i)

isConcat

public boolean isConcat()

setConcat

public void setConcat(boolean isConcat)