Package com.inductiveautomation.perspective.common.config.binding

Class PollingConfig

java.lang.Object

com.inductiveautomation.perspective.common.config.binding.PollingConfig

public class PollingConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	enabled
final String	expression

Constructor Summary

Constructors

Constructor	Description
PollingConfig(boolean enabled, String expression)

Method Summary

Modifier and Type	Method	Description
static PollingConfig	fromJson(com.inductiveautomation.ignition.common.gson.JsonObject jsonObject)	Parses a json object expected to have "enabled" and "rate" in it.
String	getRateExpression()

Methods inherited from class java.lang.Object

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

Field Details

enabled

public final boolean enabled

expression

public final String expression

Constructor Details

PollingConfig

public PollingConfig(boolean enabled,
 String expression)

Method Details

fromJson

public static PollingConfig fromJson(@Nullable
 com.inductiveautomation.ignition.common.gson.JsonObject jsonObject)
                              throws ConfigurationException

Parses a json object expected to have "enabled" and "rate" in it. If the jsonobject is null, a polling config of enabled=false, rate="30" will be used as a default.

Throws:

ConfigurationException

getRateExpression

@Nullable
public String getRateExpression()

Returns:

The polling rate expression, or null if polling is disabled