Package com.inductiveautomation.ignition.gateway.model

Class TelemetryContributorBuilder

java.lang.Object

com.inductiveautomation.ignition.gateway.model.TelemetryContributorBuilder

public class TelemetryContributorBuilder
extends Object

Convenience builder to create telemetry contributors that contribute some part of a json document. For example, if you wanted to add a "ignition.config.gizmoCount: 50" into the telemetry document, you could do it like this:

     telemetryManager.addTelemetryContributor(
         TelemetryManager.newBuilder()
             .path("ignition.config")
             .add("gizmoCount", () -> gizmoManager.getCurrentCount())
             .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TelemetryContributorBuilder.StringSupplier

Constructor Summary

Constructors

Constructor	Description
TelemetryContributorBuilder()

Method Summary

Modifier and Type	Method	Description
TelemetryContributorBuilder	add(String key, TelemetryContributorBuilder.StringSupplier supplier)
TelemetryContributorBuilder	add(String key, DoubleSupplier supplier)
TelemetryContributorBuilder	add(String key, IntSupplier supplier)
TelemetryContributorBuilder	add(String key, LongSupplier supplier)
TelemetryContributorBuilder	add(String key, Supplier<com.inductiveautomation.ignition.common.gson.JsonElement> supplier)
TelemetryContributorBuilder	addConditional(String key, Supplier<Boolean> condition, TelemetryContributorBuilder.StringSupplier supplier)
TelemetryContributorBuilder	addConditional(String key, Supplier<Boolean> condition, DoubleSupplier supplier)
TelemetryContributorBuilder	addConditional(String key, Supplier<Boolean> condition, IntSupplier supplier)
TelemetryContributorBuilder	addConditional(String key, Supplier<Boolean> condition, LongSupplier supplier)
TelemetryContributorBuilder	addConditional(String key, Supplier<Boolean> condition, Supplier<com.inductiveautomation.ignition.common.gson.JsonElement> supplier)
TelemetryManager.TelemetryContributor	build()
TelemetryContributorBuilder	path(String... path)

Methods inherited from class java.lang.Object

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

Constructor Details

TelemetryContributorBuilder

public TelemetryContributorBuilder()

Method Details

path

public TelemetryContributorBuilder path(String... path)

add

public TelemetryContributorBuilder add(String key,
 Supplier<com.inductiveautomation.ignition.common.gson.JsonElement> supplier)

add

public TelemetryContributorBuilder add(String key,
 IntSupplier supplier)

add

public TelemetryContributorBuilder add(String key,
 LongSupplier supplier)

add

public TelemetryContributorBuilder add(String key,
 DoubleSupplier supplier)

add

public TelemetryContributorBuilder add(String key,
 TelemetryContributorBuilder.StringSupplier supplier)

addConditional

public TelemetryContributorBuilder addConditional(String key,
 Supplier<Boolean> condition,
 Supplier<com.inductiveautomation.ignition.common.gson.JsonElement> supplier)

addConditional

public TelemetryContributorBuilder addConditional(String key,
 Supplier<Boolean> condition,
 IntSupplier supplier)

addConditional

public TelemetryContributorBuilder addConditional(String key,
 Supplier<Boolean> condition,
 LongSupplier supplier)

addConditional

public TelemetryContributorBuilder addConditional(String key,
 Supplier<Boolean> condition,
 DoubleSupplier supplier)

addConditional

public TelemetryContributorBuilder addConditional(String key,
 Supplier<Boolean> condition,
 TelemetryContributorBuilder.StringSupplier supplier)

build

public TelemetryManager.TelemetryContributor build()