org.diirt.datasource.formula.channel

Class ChannelsFormulaFunction

java.lang.Object

org.diirt.datasource.formula.StatefulFormulaFunction

org.diirt.datasource.formula.DynamicFormulaFunction

org.diirt.datasource.formula.channel.ChannelsFormulaFunction

All Implemented Interfaces:

FormulaFunction

Direct Known Subclasses:

PvsFormulaFunction

public class ChannelsFormulaFunction
extends DynamicFormulaFunction

Formula function that accepts a list of strings and returns a table where each row is the value of the channel matching the name.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ChannelsFormulaFunction()

Method Summary

Modifier and Type	Method and Description
Object	calculate(List<Object> args) Calculate the result of the function given the arguments.
void	dispose() Called when this instance of the formula is not needed anymore.
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	isVarArgs() Whether the function takes a variable number of arguments.

Methods inherited from class org.diirt.datasource.formula.DynamicFormulaFunction

channel, getDirector

Methods inherited from class org.diirt.datasource.formula.StatefulFormulaFunction

isPure

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelsFormulaFunction

public ChannelsFormulaFunction()

Method Detail

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.

Returns:

true if the function can accept a variable number of arguments

getName

public String getName()

Description copied from interface: FormulaFunction

Return the name of the function.

Returns:

the function name

getDescription

public String getDescription()

Description copied from interface: FormulaFunction

Return the description of the function.

Returns:

the function description

getArgumentTypes

public List<Class<?>> getArgumentTypes()

Description copied from interface: FormulaFunction

The ordered list of the arguments type.

Returns:

the types of the arguments

getArgumentNames

public List<String> getArgumentNames()

Description copied from interface: FormulaFunction

The ordered list of the argument names.

Returns:

the names of the names

getReturnType

public Class<?> getReturnType()

Description copied from interface: FormulaFunction

The type of the function result.

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.

Parameters:

args - the argument list

Returns:

the result of the function

dispose

public void dispose()

Description copied from class: StatefulFormulaFunction

Called when this instance of the formula is not needed anymore.

Overrides:

dispose in class StatefulFormulaFunction