org.epics.pvmanager.formula

Class AbstractVIntNumberVIntNumberToVIntNumberFormulaFunction

java.lang.Object

org.epics.pvmanager.formula.AbstractVIntNumberVIntNumberToVIntNumberFormulaFunction

All Implemented Interfaces:

FormulaFunction

public abstract class AbstractVIntNumberVIntNumberToVIntNumberFormulaFunction
extends Object
implements FormulaFunction

Abstract class for formula functions that take two integer VNumber as arguments and return an integer VNumber.

This class takes care of:

• extracting the Number from the VNumbes
• null handling - returns null if one argument is null
• alarm handling - returns highest alarm
• time handling - returns latest time, or now if no time is available
• display handling - returns display none

Author:

shroffk

Constructor Summary

Constructors

Constructor and Description
AbstractVIntNumberVIntNumberToVIntNumberFormulaFunction(String name, String description, String arg1Name, String arg2Name) Creates a new function.

Method Summary

Methods

Modifier and Type	Method and Description
Object	calculate(List<Object> args) Calculate the result of the function given the arguments.
List<String>	getArgumentNames() The ordered list of the argument names.
List<Class<?>>	getArgumentTypes() The ordered list of the arguments type.
String	getDescription() Return the description of the function.
String	getName() Return the name of the function.
Class<?>	getReturnType() The type of the function result.
boolean	isPure() Whether the function is a pure function, given the same arguments always returns the same result.
boolean	isVarArgs() Whether the function takes a variable number of arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractVIntNumberVIntNumberToVIntNumberFormulaFunction

public AbstractVIntNumberVIntNumberToVIntNumberFormulaFunction(String name,
                                                       String description,
                                                       String arg1Name,
                                                       String arg2Name)

Creates a new function.

Parameters:

name - the name of the function

description - a short description

arg1Name - first argument name

arg2Name - second argument name

Method Detail

getName

public String getName()

Description copied from interface: FormulaFunction

Return the name of the function.

Specified by:

getName in interface FormulaFunction

Returns:

the function name

getDescription

public String getDescription()

Description copied from interface: FormulaFunction

Return the description of the function.

Specified by:

getDescription in interface FormulaFunction

Returns:

the function description

isPure

public boolean isPure()

Description copied from interface: FormulaFunction

Whether the function is a pure function, given the same arguments always returns the same result.

Specified by:

isPure in interface FormulaFunction

Returns:

true if it's a pure function

isVarArgs

public boolean isVarArgs()

Description copied from interface: FormulaFunction

Whether the function takes a variable number of arguments.

Variable arguments can only be at the end of the argument list, and have the same type.

Specified by:

isVarArgs in interface FormulaFunction

Returns:

true if the function can accept a variable number of arguments

getArgumentTypes

public List<Class<?>> getArgumentTypes()

Description copied from interface: FormulaFunction

The ordered list of the arguments type.

Specified by:

getArgumentTypes in interface FormulaFunction

Returns:

the types of the arguments

getArgumentNames

public List<String> getArgumentNames()

Description copied from interface: FormulaFunction

The ordered list of the argument names.

Specified by:

getArgumentNames in interface FormulaFunction

Returns:

the names of the names

getReturnType

public Class<?> getReturnType()

Description copied from interface: FormulaFunction

The type of the function result.

Specified by:

getReturnType in interface FormulaFunction

Returns:

the result type

calculate

public Object calculate(List<Object> args)

Description copied from interface: FormulaFunction

Calculate the result of the function given the arguments.

Specified by:

calculate in interface FormulaFunction

Parameters:

args - the argument list

Returns:

the result of the function