Package com.inductiveautomation.ignition.common

Interface Summary

Interface	Description
Coercable
CopyConstructorClonable	Marker interface that indicates the object (and its subclasses, obviously) can be cloned reflectively through a copy constructor. See CloneUtil for a function to do this.
Dataset	A Dataset represents tabular data.
Diagnosable	Indicates that the object provides some sort of diagnostics information.
ExecutionManagerFactory	Generates private execution engines that can be used to schedule tasks.
IExceptionFacade	Indicates an exception that is really a transparent facade over another interface.
IMessageOnlyException	A tagging interface to mark exceptions that should only display their message - not their entire stack trace.
IValue<T>	An extremely simple interface that simple allows for "late" retrieval/calculation of a value.
IWrappingException	A tagging interface to mark exceptions are purely used to wrap another exception, and should not be shown themselves.
MetricValue
Path
StreamingDatasetWriter
SubIndex	A SubIndex represents a way to get a sub element from a value.
TypeUtilities.ClassInitializer
WebFormattable	An object that knows how to format itself in HTML appropriate for appending into a web page.

Class Summary

Class	Description
AbstractDataset
ArrayDataset	Created by colby.clegg on 7/11/2015.
ArrayIndex	A simple structure that holds an index into a single or double column array.
Base64	Encodes and decodes to and from Base64 notation.
Base64.InputStream	A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream	A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
BasicDataset
BasicMetricValue
BasicObjectPool<T>	An extremely simple thread-safe object pool backed by a LinkedList.
BundleUtil
DiagnosticsSample	DiagnosticSample is a tree of data about a target.
DiagnosticsSample.Diagnostic
DocumentIndex
FormatUtil
GatewaySec
GsonSerializationAdapter<T>
HexUtils	Library of utility methods useful in dealing with converting byte arrays to and from strings of hexadecimal digits.
JsonDataset
JsonPath	A property path represents a location in a JSON document.
JsonUtilities
JsonUtilities.ByteArrayAdapter	Encodes byte[] objects as Base64
LocaleChangeEvent	Filename: LocaleChangeEvent.java Created on Dec 10, 2015 Author: Kathy Applebaum Copyright Inductive Automation 2015 Project: SRCommon
Math2	Contains functions we wish were in java.lang.Math
MetricValue.AbstractMetricValue
MetricValue.MetricsSnapshotMetricValue
MovingAverage
NamedId	A NamedId is an identifier which is primarily a UUID, but can have a "friendly" name associated with it.
NamedThreadFactory	A simple thread factory that uses a custom name prefix.
NamedValue<T>	A wrapper around an Object that attaches a resource bundle key to it.
PathTree<P extends Path,T>
PersistentProperties	A simple extension of properties that is meant to represent a file based property file.
PollingRate	Represents a polling rate, either off, relative, or absolute, with a time value in milliseconds
PyUtilities
QualifiedPath	This class is a path to anything in Ignition, across any system.
QualifiedPath.Builder	A builder to assist in constructing QualifiedPaths.
QualifiedPath.Part
QualifiedPath.QualifiedPathSimpleTypeAdapter
QualifiedPathUtils	This class provides utilities related to QualifiedPaths.
SessionInfo
StatMetric	A StatMetric keeps track of various statistics for one metric.
StreamingDataset	This is an implementation of Dataset that received data in a streaming manner.
StreamingDataset.Column
StreamingDataset.Row
StreamingDatasetJsonWriter
StringPair	A pair of strings.
StringPath	A simple path based on string based path components.
StringPath.CaseSensitiveStringPath	A case-sensitive subclass of StringPath.
TagPathUtils	Created by colby.clegg on 7/14/2015.
TypeUtilities
TypeUtilities.DefaultClassInitializer	Initializes most basic classes.
Value<T>
WellKnownPathTypes	These are path identifiers used by QualifiedPath for the well-known objects in Ignition.
XMLReaderPool	This class maintains a pool of XMLReaders.
XMLUtil

Enum Summary

Enum	Description
ComparisonOperator	An enum listing the possible comparison operations.
DiagnosticsSample.DiagnosticLevel
FormatUtil.DurationFormatStyle
JSType	Represents the types possible in a JSON encoding.
StatMetric.Metric

Exception Summary

Exception	Description
GenericTransferrableException	This is a general exception that can be used to transfer error information across RPC.
LocalizedException	A localized message that takes a bundle key and lazily uses BundleUtil to create its localized message.
LocalizedMessageException	A localized message that takes a bundle key and lazily uses BundleUtil to create its localized message.
NonLocalizedErrorMessage
StreamingDataset.StreamingException