Package com.inductiveautomation.ignition.common.expressions.legacy

Class DBFunctions.IsDBConnectionAvailableFunction

java.lang.Object

com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

com.inductiveautomation.ignition.common.expressions.legacy.DBFunctions.DBFunction

com.inductiveautomation.ignition.common.expressions.legacy.DBFunctions.IsDBConnectionAvailableFunction

All Implemented Interfaces:

Function

Enclosing class:

DBFunctions

public class DBFunctions.IsDBConnectionAvailableFunction
extends DBFunctions.DBFunction

Constructor Summary

Constructors

Constructor	Description
IsDBConnectionAvailableFunction()

Method Summary

Modifier and Type	Method	Description
QualifiedValue	execute(Expression[] args)	Execute this function, and return the function's qualified value.
String	getArgDocString()	Returns a string to be used in the auto-generated function documentation.
String	getFunctionDisplayName()
Class<?>	getType()	Returns the type that this function will return upon execution
protected boolean	validateNumArgs(int num)

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

executeArg, initArgs, log

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

connect, copy, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object

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

Constructor Details

IsDBConnectionAvailableFunction

public IsDBConnectionAvailableFunction()

Method Details

execute

public QualifiedValue execute(Expression[] args)
                       throws ExpressionException

Description copied from interface: Function

Execute this function, and return the function's qualified value.

Throws:

ExpressionException

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

getType

public Class<?> getType()

Description copied from interface: Function

Returns the type that this function will return upon execution

getArgDocString

public String getArgDocString()

Description copied from interface: Function

Returns 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.

getFunctionDisplayName

public String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class DBFunctions.DBFunction