Package com.inductiveautomation.ignition.gateway.history

Interface ScanclassHistorySet

All Superinterfaces:

java.util.Collection<HistoricalTagValue>, HistoricalData, HistoricalDataList, java.lang.Iterable<HistoricalTagValue>, java.util.List<HistoricalTagValue>, RetryHistoricalData, java.io.Serializable

All Known Implementing Classes:

BasicScanclassHistorySet

public interface ScanclassHistorySet
extends HistoricalDataList, RetryHistoricalData, java.io.Serializable

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.history.RetryHistoricalData

RetryHistoricalData.RetryState

Method Summary

Modifier and Type	Method	Description
int	getExecRate()	The rate that the scan class is executing at.
java.util.Date	getExecutionTime()
java.lang.String	getGatewayName()	Returns the name of the source gateway.
java.lang.String	getProviderName()	Returns the name of the tag provider that generated this set.
java.lang.String	getSetName()	The name of the scan class

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface com.inductiveautomation.ignition.gateway.history.HistoricalData

getDataCount, getFlavor, getLoggerName, getSignature

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface com.inductiveautomation.ignition.gateway.history.RetryHistoricalData

badData, clearBadData, failureReason, markAllAsBad, markAsBad, retryEnabled, retryState, setFailureReason, setRetry

Method Detail

getSetName

java.lang.String getSetName()

The name of the scan class

getExecRate

int getExecRate()

The rate that the scan class is executing at. Returns 0 to indicate a non-direct scan class (one that doesn't execute regularly)

getExecutionTime

java.util.Date getExecutionTime()

getGatewayName

java.lang.String getGatewayName()

Returns the name of the source gateway. If null, it is the local gateway.

getProviderName

java.lang.String getProviderName()

Returns the name of the tag provider that generated this set.