All Classes and Interfaces
Class
Description
About box with information and a listing of System properties
Filename: AbstractActionPanel.java Created on Feb 05, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Basic scaffolding for a table with any of [add, edit, delet, up and down] buttons
Base class for alarm display components in Vision.
If your component that you use as a popup implements this, it will be notified when it is shown
and hidden.
Provides the plumbing to keep track of the overlay's components if the overlay is animated.
Created by Colby.Clegg on 12/14/2015.
Base class for painters.
Base class for
AuditProfile implementations that supplies the AbstractAuditProfile.getStatus()
contract so implementors get health reporting without boilerplate.Base class for any
Binding which should derive from AbstractLifecycleWraps up the logic of creating bindings and transform chains, and linking up the values as they
get created, eventually making their way back onto the target property.
Abstract implementation takes care of the bookkeeping required for event handling.
Base class for most block prototype implementations.
This workspace is a specialization of AbstractDesignableWorkspace for workspaces that want to use
a block-and-connector style of design.
Drives a
BrowsePublisher from a HistoricalNodeTree.Simple wrapper containing a BrowseTreeNode and the index at which the node occurs in this node.
JComponentHpr subclass for AbstractButtons.
This class is a simple JButton subclass to support Ribs archival and to support Ribs unified
accessor model.
A JComponentShape for AbstractButton.
A tool class for AbstractButtons.
A panel that provides a border that reflects change state.
Convenience base-class for any object that wants to manage change listeners
Base class for all of the easy chart query objects that run through the QueryManager.
Deprecated.
Base class for all client module hook implementations.
Contains some common logic for a popup frame who is intended to be an editor for some aspect of a
component, such as bindings, property change scripts, and event configuration.
Must implement hashcode and equals
A Configurator is the ill-conceived name for the GUI that handles the configuration of a given
data binding type
Like the AbstractPaletteItemGroupView, except that adds support for the capture button, add adds
plumbing for capturing
Created by carl.gould on 3/4/2015.
An abstract base class for sinks that use a data source to store data.
Created by colby.clegg on 11/17/2015.
Base implementation for database functions (system.db.*).
Simple cursor implementation defers initialization until it begins being iterated through
Base class for a storage engine's definition resolver.
A normalized path and its staging-cache key.
This abstract workspace provides the "guts" of workspaces that use a drag-and-drop style
interface.
Base class for all designer module hook implementations.
A partial implementation of
GatewayModuleHook for modules that provide DeviceExtensionPoints.A simple framework for an action that runs some checks and displays the results in a little
popup.
This subclass edits only one tag prop, and with that knowledge can handle some of the
hasChanged/isOverridden stuff for all sub classes.
This edge router takes care of taking the anchor lead points into account and adjusting all
points to be relative to the diagram.
Path maker that uses rounded corners
Basic path maker that just uses straight line segments
Superclass of any perspective popup editor frame.
Created by carl.gould on 3/31/2015.
Deprecated.
A base implementation of
Expression that handles child management and lifecycle
propagation.The base implementation of a filter.
The base implementation of a filter.
Abstracts the style for the various "final" panels - expiration, restart, deleted
AbstractFunction simply implements some code to make the checking of arguments and generating of
type mismatch errors more abstracted.
Base class for all calculated pen datasources that are functions of another pen
An access control strategy that understands how to map the
PermissionType enum to the
gateways' configured required permissions far that type.Base class for all gateway module hook implementations.
Class contains properties and methods not particular to ReportMill.
Base class for historian implementations.
Author: Perry Arellano-Jones Year: 12May2015
This is the base class for all of our reporting components that prefer to render themselves using
Java2D.
Base class to pretend to be a Python map, AKA a dictionary.
Base class to pretend to be a Jython "sequence", aka a Pythonic list.
This tool defines and installs a number of visual layout related actions.
Tree Node implementation which only populates its children upon demand.
An AbstractDialogPage that has additional information that is used to help render the list of
pages in a JIDE multi page dialog pane.
Deprecated.
Skeleton of a periodic maintenance scheduler for a historian backend.
Base class for Store & Forward sinks that write to a backend they manage themselves (their
own connection pool or client) rather than a gateway
Datasource.Base class for a Map Transform.
Abstract base class for all menu merges that represent a collection, for example a menu or a
toolbar, as opposed to a single item.
Base class for
Runnable implementations that execute a message handler script.Abstract base class for mode panels (Direct and Expression modes).
The foundation for an expression parse context that tries to create a reference, but then
delegates if the reference isn't the type expected.
Base class to pretend to be a Jython "sequence", aka a Pythonic list.
Base TreeNode for the Designer's Project Browser tree.
Semantically, the "delete" operation gets used for a variety of different reasons.
A BaseAction that gets set up with the node selection prior to being shown
A simple extension that holds the last changed value.
Subclasses can add modifications to property descriptions through the property manager.
This abstract editor is the basis for the numeric editors.
Shared
PersistentSerializer plumbing for the temporal-point batch carriers (
PersistentAtomicPoint, PersistentComplexPoint, PersistentChangePoint).Abstract base class which takes care of executing bindings which have a polling option in a
thread-safe manner.
Slightly specialized version of AbstractComponentEditorFrame that deals with frames that are
working with component properties
Base class for all property editing pages.
A class used to model a resource as an immutable map of property keys to values.
A
JideMenu.PopupMenuCustomizer that builds menus off of a set of Property, provided by the
subclass.Handles accepting drops onto a Jide property table
An abstract push notification listener that supports running on the EDT or the invoking thread.
Created by carl.gould on 3/4/2015.
Base class for query engines.
Base class for query options: query keys, time range, return size and extended properties.
Base builder for
AbstractQueryOptions.Abstract base class for query path panels.
A base class for components that represent a value within a range (like a progress bar or gauge).
This is a specialization of AbstractDeserializationHandler built for handlers that return false
from
DeserializationHandler.supportsNestedElements() and are designed to be re-entrant (do not store any
state).Filename: AbstractReportAction.java Created on Feb 06, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: AbstractReportActionConfig.java Created on Feb 05, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
Simple subclass of AbstractNavTreeNode that has some functions for dealing with project resources
represented by the node
Deprecated.
To create RM vector images, we add
RMShape nodes to a root node.A DockableFrame that tracks the reporting workspace's selection, activating a UI only when a
report's design tab is visible.
Base
PromptAssist that browses the schema of a single datasource — first a table list,
then a column list for a chosen table.Abstract base class for search objects that provide functionality for locating and managing event
scripts saved as resources within the designer context.
This provider can be instantiated and added multiple times for different script scopes.
Base class for perspective applications, whether that is a project running as a client, or a
project being designed in the designer.
Base class for
SessionKernel implementations.This class is a useful base class for most handle implementations.
Created by carl.gould on 7/17/2015.
The abstract base class for all data sinks.
Created by carl.gould on 7/21/2015.
Holds the query (a String), and a list of parameters and their types.
An AbstractStaticDrivenValue is a
DrivenValue which never changes.Provides UI components for editing the name of a step.
Base class for storage engines.
A simple base definition for SynchronizedStateProvider.
An
Transform which takes care of wrapping a blocking transform operation in a CompletableFuture.This class is the base for a "page" of properties for a tag.
Created by colby.clegg on 12/24/2014.
This implementation simply takes care of the toString functions of TagPath.
This implementation simply takes care of the toString functions of TagPath.
Implements some common functions used by different tag query sources.
Base implementation for tag-related scripting functions (system.tag.*).
This class extends Jide Menu in order to listen to the tag tree, to set enabled state, and
potentially re-configure selections.
A class that can acts as a 1.4 TransferHandler, and a 1.3 DropTargetListener all at once.
This class is a subclass of AbstractFPMIComponent that provides the basic bookeeping required for
creating a cached, buffered component.
An abstract subclass of PMIChartPanel that provides boiler plate code for some common FactoryPMI
things such as:
Proper vetoable name change
Implementation of MutablyDynamicPropertyProvider
Implementation of StyleProvider
This is used for 'componentized' charts, such as the Meter and Thermometer, but not for the
'real' charts.
An abstract subclass of JComponent that provides boiler plate code for some common Vision things
such as:
Proper vetoable name change
Implementation of MutablyDynamicPropertyProvider
Implementation of StyleProvider
Implementation of QualityMonitor
An abstract subclass of JPanel that provides boiler plate code for some common FactoryPMI things
such as:
Proper vetoable name change
Implementation of MutablyDynamicPropertyProvider
Implementation of StyleProvider
Implementation of QualityMonitor
An abstract subclass of JScrollPane that provides boiler plate code for some common FactoryPMI
things such as:
Proper vetoable name change
Implementation of MutablyDynamicPropertyProvider
Implementation of StyleProvider
Implementation of QualityMonitor
The superclass for all "shape" components used in the Ignition Vision module.
Action delegate used to configure accelerometer related actions and data collection from mobile
devices
An exception that indicates that data source doesn't have permission to access data.
An action is something the user configures to respond in some way to an event being fired.
A component binding that will call a method when an action occurs.
Inner utility class used to wire
Action bindings.ActionConfig holds the configuration of a single action.
Special gson adapter to avoid extra fields when enabled is true or when the permissions are at
their defaults.
Handle returned by
ActionContext.enter(ActionContext).Keeps the thread-local itself off the public surface; mutate it only through
ActionContext.enter(ActionContext).Factory to create instances of Actions based on saved configuration
This registry holds the implementations of all known
Action types, keyed by action
type-id (a string).The SFC Chart Element Editor for Action Steps
Factory for making new ActionScriptEditor Uis
Only care about doing something when the
ActivityLevel transitions from:
!Active => Active
Active =>!Active
but none of the other permutations? ActiveInactiveFilter is your man.A class that describes an active query
Tag actors are registered and organized according to their Classification.
Builder class for AdaptedQualifiedPath.
An adapter is essentially a rider on a component that affects or augments the component's normal
behavior in some way.
Configuration properties for an Active Directory user source.
A single contribution to an
Agent's additional context.Algorithm for adding and removing items from lists and tables.
Defines an aggregation function that is defined in python.
Configuration for the Active Directory/Internal Hybrid user source.
LDAP settings for the AD/Internal Hybrid user source.
Auth challenge that contains a username and AD domain to attempt an SSO login
This class is used to define the configuration properties for the AD to DB Hybrid user source.
UserSourceExtensionPoint implementation for the AD to DB Hybrid user source.Database settings for the AD to DB Hybrid user source.
LDAP settings for the AD to DB Hybrid user source.
Configures an AI agent: its system prompt, the tools it can call, and any supplemental context
that shape its behavior.
Constructs
Agent instances.One conversation with a model: a system prompt, a tool set, and the accumulated message history
that
AgenticHarness.send(String) appends to.Describes how the age of something (such as a historical tag value) is handled.
Deprecated.
use
AggregateId.Gateway-level catalog that answers which aggregates apply to a source by routing to the right
QueryEngine, and holds the gateway's own folds.A data point holding an aggregate value, with its aggregation type and an optional
WindowExtent.Builder for
AggregatedDataPoint.Wire descriptor of one aggregate on one source; one per aggregate id per source.
Protobuf binary adapter for
AggregateDescriptor, using the AggregateDescriptorProto.AggregateDescriptorPB
schema.Protobuf type
common.protobuf.AggregateDescriptorPBProtobuf type
common.protobuf.AggregateDescriptorPBProtobuf type
common.protobuf.FillModesPBProtobuf type
common.protobuf.FillModesPBA
DataPoint holding an aggregate of a window; AggregatedDataPoint is the only
implementation.Processes
AggregatedPoints read by AggregatedQueryKeys.Query key for an aggregated query: a source path, an
AggregateSpec, a fill mode, an
interpolation and a constant.Protobuf binary adapter for
AggregatedQueryKey.Options for an aggregated query: the base data point query settings plus the time window each
aggregate is computed over.
Builder for
AggregatedQueryOptions; adds the time window and aggregation settings to
the common query settings.Protobuf binary adapter for
AggregatedQueryOptions.Incremental fold over one window.
One value of a finished window.
boolean-input convenience: coerces the sample and calls AggregateFunction.OfBoolean.addBoolean(ACC, boolean).double-input convenience: coerces the sample and calls AggregateFunction.OfDouble.addDouble(ACC, double).long-input convenience: coerces the sample (a floating one rounded half-even) and calls
AggregateFunction.OfLong.addLong(ACC, long).A sample outside a window that bounds it: the latest sample strictly before the window start (a
bounding seed before the query range or the last sample of an earlier window), or the first
sample at or after its end.
How a fold treats sample quality.
What the pipeline needs to know about a fold: how it treats quality, whether
AggregateFunction.open(AggregateFunction.Window)
reads its window (so the pipeline seeds the key and opens a window that has a prior but no
samples), whether time after a window's last sample counts only once AggregateFunction.close(ACC, AggregateFunction.PriorSample) supplies
the sample after the window, and whether it reads the stored samples at its window's edges.The window a fold opens: its bounds in epoch milliseconds (
[startMs, endMs), the end
clipped to the query range), the sample in effect at its start when one is known, the levels
the query's quality filter admits, and whether the signal ramps linearly between samples
(sloped) or holds each value until the next.Aggregate id: lower snake case,
[a-z][a-z0-9_]*.The fixed-origin, fixed-width cell grid an engine serves aggregates from; widths ascending, at
least one, each a whole multiple of the one before it so a grid on any width is cell-aligned on
every finer one.
Marker for the typed parameter records carried by an
AggregateSpec; each parameterized
aggregate declares its own record.An aggregate's type and typed parameters.
This is a ComponentTermFinder that simply delegates to a number of other term finders.
Backend-agnostic shape decisions for historian aggregate queries: a string or boolean column is
always stepped; the shape between samples comes from the query, else the tag, else the data type.
Deprecated.
use
AggregateFunction.Deprecated.
use the aggregate catalog.
Deprecated.
use the aggregate catalog.
Deprecated.
use
AggregateId with the StandardAggregates catalog.An aggregate: its identity, name, description, result type and the rules the query pipeline uses
to choose inputs, interpolations and fills.
The window bound whose signal value an empty window answers.
Who the user is that triggered an AI run.
Read-only access to the gateway's configuration system, shaped for AI agents running in the
designer.
Platform-visible builder returned by
AiContext.newAgenticHarness(String, String, Agent.AgentFactory).A specific model from a specific provider.
Standalone Designer dialog shell for AI-assisted multi-instance creation.
Seed context captured from the Tag Browser before the AI Multi-instance Wizard opens.
Extends
PropertyBasedFunctionFactory to include various alarm related functions, such as
isActive, isClear, etc.A Condition implementation with the smarts to be able to search alarms in an AlarmConfiguration
for a certain value
An alarm configuration is simply a set of AlarmDefinitions (that is, the definitions for various
alarms) for a specific object.
Keeps track of added, modified and removed alarm definitions.
com.inductiveautomation.ignition.common.alarming.config.AlarmConfigurationConfig
com.inductiveautomation.ignition.common.alarming.config.AlarmConfigurationConfig
com.inductiveautomation.ignition.common.alarming.config.AlarmConfigurationDiff
com.inductiveautomation.ignition.common.alarming.config.AlarmConfigurationDiff
com.inductiveautomation.ignition.common.alarming.config.AlarmConfiguration
com.inductiveautomation.ignition.common.alarming.config.AlarmConfiguration
com.inductiveautomation.ignition.common.alarming.config.AlarmDefinitionDiff
com.inductiveautomation.ignition.common.alarming.config.AlarmDefinitionDiff
An entry in the diff - either a full new definition or a diff of an existing one
An entry in the diff - either a full new definition or a diff of an existing one
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmDefinition
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmDefinition
A single property entry in an alarm definition, either a regular value or a bound alarm property
A single property entry in an alarm definition, either a regular value or a bound alarm property
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmConfiguration
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmConfiguration
com.inductiveautomation.ignition.common.alarming.config.BoundAlarmProperty
com.inductiveautomation.ignition.common.alarming.config.BoundAlarmProperty
com.inductiveautomation.ignition.common.alarming.config.ExtendedAlarmConfiguration
com.inductiveautomation.ignition.common.alarming.config.ExtendedAlarmConfiguration
com.inductiveautomation.ignition.common.alarming.config.IntersectedAlarmConfiguration
com.inductiveautomation.ignition.common.alarming.config.IntersectedAlarmConfiguration
An AlarmDefinition is the configuration of an alarm.
Protobuf type
common.protobuf.AlarmEnumPBProtobuf type
common.protobuf.AlarmEnumPB
com.inductiveautomation.ignition.common.alarming.config.AlarmMode
com.inductiveautomation.ignition.common.alarming.AlarmPriority
com.inductiveautomation.ignition.common.alarming.AlarmState
com.inductiveautomation.ignition.common.alarming.AlarmStateTransition
com.inductiveautomation.ignition.common.alarming.evaluation.EventPropertyType
Convenience class that can serialize the common alarm enums
The alarm evaluator is the unit that takes a value, and determines whether it is in alarm or not.
The alarm event transports all information about a particular alarm instance.
This parse context is built to work with a collection of events.
Alarm events normally exist as a single object in the system.
com.inductiveautomation.ignition.common.alarming.AlarmEventInstance
com.inductiveautomation.ignition.common.alarming.AlarmEventInstance
Provides the context for parsing expressions that reference alarm properties.
Provider for the current alarm event during expression evaluation.
Represents an expression that retrieves a specific property value from an alarm event provided by
the
AlarmEventParseContext.SelectedAlarmEventModel.
com.inductiveautomation.ignition.common.alarming.evaluation.EventProperty
com.inductiveautomation.ignition.common.alarming.evaluation.EventProperty
com.inductiveautomation.ignition.common.alarming.AlarmEvent
com.inductiveautomation.ignition.common.alarming.AlarmEvent
This expression parse context is basically the same as the
PropertyBasedExpressionParseContext, except that it uses the AlarmBasedFunctionFactory
that adds a few additional functions.This class provides a convenient way to build common alarm filters.
com.inductiveautomation.ignition.common.alarming.AlarmFilter
com.inductiveautomation.ignition.common.alarming.AlarmFilter
Protobuf type
gateway.protobuf.ConditionPBProtobuf type
gateway.protobuf.ConditionPB
com.inductiveautomation.ignition.common.alarming.query.conditions.DateTimeCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.DateTimeCondition
Underlying class is PathCondition, see com.inductiveautomation.ignition.common.alarming.AlarmFilter.DISPPATH
Underlying class is PathCondition, see com.inductiveautomation.ignition.common.alarming.AlarmFilter.DISPPATH
com.inductiveautomation.ignition.common.alarming.query.conditions.DisplayThenSourceCondition
Potentially contains a display path (StringPath) and a source path (QualifiedPath).
com.inductiveautomation.ignition.common.alarming.query.conditions.DisplayThenSourceCondition
Potentially contains a display path (StringPath) and a source path (QualifiedPath).
com.inductiveautomation.ignition.common.alarming.query.conditions.EnumCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.EnumCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.PathCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.PathCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition
Underlying class is PathCondition, see com.inductiveautomation.ignition.common.alarming.AlarmFilter.SOURCE
Underlying class is PathCondition, see com.inductiveautomation.ignition.common.alarming.AlarmFilter.SOURCE
com.inductiveautomation.ignition.common.alarming.query.conditions.SourceOrDisplayCondition
Source paths (QualifiedPaths) and display paths (StringPaths) can be set in the filter.
com.inductiveautomation.ignition.common.alarming.query.conditions.SourceOrDisplayCondition
Source paths (QualifiedPaths) and display paths (StringPaths) can be set in the filter.
com.inductiveautomation.ignition.common.alarming.query.conditions.StringCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.StringCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.StringEnumCondition
com.inductiveautomation.ignition.common.alarming.query.conditions.StringEnumCondition
Serializes and deserializes all the Fields and their Conditions defined in the AlarmFilter class
Basic interface for the AlarmJournal extension point.
Base interface for an Alarm Journal manager, which will manager any number of
AlarmJournalsProtobuf enum
DataTypeClassPBProtobuf enum
EventPropTypePBProtobuf type
JournalEventPBProtobuf type
JournalEventPBProtobuf type
JournalEventsPBProtobuf type
JournalEventsPBProtobuf enum
JournalSystemTypePBProtobuf type
PropValuePBProtobuf type
PropValuePBFilename: AlarmJournalQueryConfig.java Created on Jul 16, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: AlarmJournalQueryConfigPanel.java Created on Jul 17, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
Filename: AlarmJournalTableTermFinder.java Created on Dec 20, 2013 Author: Kathy Applebaum
Copyright Inductive Automation 2013 Project: Vision
The event handler interface for alarming events.
Bridge different types of config controllers for our needs
This class collects together static loggers for the Alarming system.
This is the central manager for alarming in Ignition.
These are the defined types of alarm conditions.
You may safely cast the module object for the "alarm-notification" module hook to this
interface to gain access to the alarm notification API.
No-op implementation of an AlarmNotificationProfile.
This interface can be implemented by an AlarmProvider in order to expose pipelines for alarm
notification.
The AlarmObserver interface defines the contract for subscribers that observe alarm events and
state changes.
Why isn't this in DesignerHook? Because if the Vision module isn't present, Java throws a hissy
fit in the form of a ModuleLoadException for the whole alarm module.
This is an add-on interface that lets alarm events know when they're dropped from an alarm
pipeline.
The priority of the alarm.
Alarm properties are the config units of alarms.
Handles serializing BasicAlarmProperties and also CommonAlarmProperties values
The AlarmProvider is an entity that operates on alarms and provides access to alarm state model
functionality.
This interface can be implemented by an AlarmProvider in order to provide the ability to query
alarm status from a different source than the main alarm state model maintained by the gateway.
This is the result of a query against the alarming system, for both status and history.
Returns a Dataset derived from an AlarmEvent query.
com.inductiveautomation.ignition.common.alarming.query.AlarmQueryResultImpl
com.inductiveautomation.ignition.common.alarming.query.AlarmQueryResultImpl
Acts as a mutable getter for the current alarm event that we are evaluating visual style for.
Holds an expression and a cell style.
This enum represents a single alarm state, generally the state that a particular event represents
the transition to.
Filename: AlarmStatusTableTermFinder.java Created on Dec 09, 2013 Author: Kathy Applebaum
Copyright Inductive Automation 2013 Project: Vision
com.inductiveautomation.ignition.gateway.alarming.distributed.common.AlarmSubscriptionUpdate
com.inductiveautomation.ignition.gateway.alarming.distributed.common.AlarmSubscriptionUpdate
Deprecated.
Deprecated.
Dictates the tag's opinion as to when notifications should be generated.
The AlertSeverity describes the importance of the alert message
Defines the 4 classifications of alerts, along with their default render options
This ObjectInputStream will use the defined alias class when deserializing, or if not defined or
class doesn't match alias, then this ObjectInputStream will deserialize using the local class
descriptor if the descriptor from the serialized stream doesn't have an identical serial version
UID.
Interface for enums whose name() isn't actually the value that should be used.
Describes an anchor, for use with the BasicBlockUI.
An anchor point is a point on a block that is acceptable for either starting or ending a
connector.
Holds an anchor point's block and anchor id
This class provides Swing GUI editing for anim agents.
This class provides Swing UI editing for shape animation.
This class provides Swing UI editing for shape animation.
This class provides Swing GUI editing for a shapes action script.
This is a com.jidesoft.grid.Property that represents a beans-style property from an RMShape that
has been annotated with the @ShapeProperty annotation.
Just a wrapper around an annotation instance to keep track of which method that annotation was
found on
A note attached to a point in time: free text, a type and an author.
An Annotation represents data of a certain type, for a given path, for a given point in time or
range of time.
A
ChangePoint that creates, updates or deletes an annotation; a null value is a
deletion.Protobuf binary adapter for
AnnotationChangePoint.Filters annotations by the author and type of each point's
Annotation.Protobuf binary adapter for
AnnotationFilter, using the AnnotationFilterProto.AnnotationFilterPB
schema.
Wire form of com.inductiveautomation.historian.common.model.data.AnnotationFilter.
Wire form of com.inductiveautomation.historian.common.model.data.AnnotationFilter.
Deprecated.
An annotation on a source: a
ComplexPoint whose value is an Annotation, with a
start time and an optional end time.Builder for
AnnotationPoint.Protobuf binary adapter for
AnnotationPoint.Processes
AnnotationPoints read by AnnotationQueryKeys.
com.inductiveautomation.ignition.common.sqltags.history.annotations.Annotation
com.inductiveautomation.ignition.common.sqltags.history.annotations.Annotation
Key for querying the annotations of a path; its point type is
StandardComplexPointType.ANNOTATION.Protobuf binary adapter for
AnnotationQueryKey.Options for an annotation query: the shared query options plus an
AnnotationFilter on
author and type.Builder for
AnnotationQueryOptions.Protobuf binary adapter for
AnnotationQueryOptions.Deprecated.
Deprecated.
Just a basic JLabel subclass that always paints with anti-aliasing on
Protobuf type
common.protobuf.AnyObjectPBProtobuf type
common.protobuf.AnyObjectPBA condition where any value contained in a set will pass.
Protobuf type
common.protobuf.AnyOptProtobuf type
common.protobuf.AnyOptThe web UI uses these routes for status display.
These routes are used by the web UI for hand built reporting routes.
Manages the API Tokens configured in the system and exposes a method for validating HTTP Requests
against API Tokens configured in the system
Context object contains the name of the token associated with an HTTP Request as well as which
security levels are granted to the token
This is the main class for the ReportMill app.
This is the main class for the ReportMill app.
This is the main class for the ReportMill app.
This is the main class for the ReportMill app.
Filename: AppDescriptionTag.java Created on Dec 14, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: FactoryPMI_SQLTags
Deprecated.
no reason originally specified
Deprecated.
no reason originally specified
Deprecated.
no reason originally specified
Various parts of the system allow operations to be filtered based on "scope".
Filename: AppTitleTag.java Created on Dec 14, 2015 Author: Kathy Applebaum Copyright Inductive
Automation 2015 Project: FactoryPMI_SQLTags
An interface for objects that are archivable.
Adaptation of the shared axis map class for reportmill style archiving
An expression implementation that performs arithmetic operations (addition, subtraction,
multiplication, division, power, and modulo) between two sub-expressions.
Determines how the operation should behave when strings are involved.
Created by colby.clegg on 7/11/2015.
This array decoder is meant to decode the body of array elements, where the type and length are
specified by the element type and an attribute, respectively.
This delegate will serialize an array of any type.
The array element simply provides an array of the values provided by sub-elements.
An array function is not one of the built-in PDF function types.
A simple structure that holds an index into a single or double column array.
Supports temporary read and writes to ClientTag array members.
Created by colby.clegg on 7/17/2015.
Standard connection painter that traces the path with a 2px stroke, and draws an arrow at the end
Deprecated.
Created by Colby.Clegg on 12/14/2015.
Created by Colby.Clegg on 12/14/2015.
Created by Colby.Clegg on 12/14/2015.
Factory for making new AssertionStepEditor Uis
Created by Colby.Clegg on 12/14/2015.
Created by Colby.Clegg on 12/14/2015.
The "Ask AI" action shared by
AssistButton (labeled panel button) and AssistToolbarButton (icon-only toolbar button).Labeled "Ask AI" panel button — a standard
JButton bound to an AssistAction.Builds
AssistSessions for a host.One live AI-assist session.
Icon-only "Ask AI" toolbar button — a
JideButton variant bound to an AssistAction, matching the convention of JideToolbarButton so it fits naturally beside
other toolbar buttons.This class provides a TagHistoryQueryInterface for an associated historical provider.
A* algorithm implementation using the method design pattern.
An AsyncClientTask is a task that can be executed through the client progress manager.
Any tree node that loads it's children asynchronously, meaning that a call to getChildCount()
might not return the true number immediately, but then soon after fire a tree event on itself
when loaded.
The AsyncWriteValue interface is used for writing values asynchronously.
A wrapper around WriteRequest that adds the functions defined by AsyncWriteRequest.
A single raw
DataPoint; DataPointFactory.AtomicPointImpl is the only
implementation.Protobuf binary adapter for
AtomicPoint.The
text can have multiple segments with different attributes applied to them.Base style used in the declaration's block.
Specifies the span of a text that should have a specific
AttributeSet applied to it.This class manages the attributes panel which holds the color panel, font panel, formatter panel
and keys panel.
This class manages the attributes panel which holds the color panel, font panel, formatter panel
and keys panel.
This inner class is a RJColorPanel suitable for manipulating colors in current RMEditor.
This class is used to paint custom attributes in the
AttributeTextPane.This interface is used to paint custom attributes in the AttributeTextPane, for use specifically
with
AttributeTextPaneLabelView.An actor for an audit record.
An actor representing a user authenticated via a classic user source.
An actor representing a user authenticated via an IdP.
An actor representing an explicitly unauthenticated user.
An actor representing an unknown user.
Data component that can be attached to an
Entity that represents information about when
an entity was last modified and by whom.Context in which an audit log record may be written
An
AutoCloseable handle returned by AuditManager.pushAuditContext(AuditContext) that
restores the previously-active AuditContext when closed, intended for use with
try-with-resources.Request object for querying audit records.
Builder for QueryRequest objects.
Handler interface for stream processing audit records as they are returned.
An extension point for defining new types of audit profiles.
Where an audited action came from, captured at the origin site and carried to whichever component
emits the audit record — so one emitter builds the record instead of every origin site
building its own.
A record about a single audit event
Deprecated.
Deprecated.
Protobuf type
AuditEventPB.AuditRecordPBDeprecated.
Protobuf type
AuditEventPBDeprecated.
Deprecated.
Protobuf type
AuditQueryPBDeprecated.
Protobuf type
AuditQueryPropsPBProtobuf type
AuditQueryPropsPBProtobuf type
AuditRecordPBProtobuf type
AuditRecordPBProtobuf type
AuditRecordsPBProtobuf type
AuditRecordsPBSome stuff used to rely on StatusCode#getRawValue() and StatusCode#toString(), but now StatusCode
isn't available for use.
This wrapper class is used to hold an arbitrary GSON serializable payload, _or_ an object
equivalent to a GatewayException that can be handed over the wire.
This event is fired when an authentication challenge is completed by the user.
Representation of the result of an authentication challenge.
Representation of a failed authentication challenge result.
Representation of the result of an authentication challenge which failed due to the user
cancelling the authentication challenge.
Representation of the result of an authentication challenge which failed due to a generic
error.
Representation of the result of an authentication challenge which failed due to a timeout.
Representation of a successful authentication challenge result.
Immutable representation of an authentication challenge request
Provides a fluent-API (builder-style) pattern for creating new
AuthChallengeRequest
objectsA
JsonSerializer and JsonDeserializer implementation for serializing and
de-serializing AuthChallengeRequest objects to / from JSON using GSON APIs.Represents a tab for editing authentication challenge scripts.
com.inductiveautomation.ignition.common.user.AuthenticatedUser
com.inductiveautomation.ignition.common.user.AuthenticatedUser
Failover mode for an authentication operation.
com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecord
com.inductiveautomation.ignition.gateway.auth.token.AuthTokenRecord
Utility methods useful for Auth
JTree that works with AbstractTreeTransferHandler to support automatic scrolling when dropping
items on it.
Whether a
Historian, and the engines it owns, is currently usable.The lifecycle states of a historian or engine.
Implementation of Type 2 shadings, which vary color along a linear axis.
Config object for classic chart axis
An encoded representation of a badge auth challenge.
Deprecated.
since 8.3.
Deprecated.
This class handles editing of rectangle shapes.
Filename: BarcodeTool Author: Perry Arellano-Jones Created on: 7/9/15 Project: ignition_dev_7_8B
Encodes and decodes to and from Base64 notation.
Encodes and decodes to and from Base64 notation.
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.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.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.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.Base action implementation that helps actions hook into the i18n framework.
Deprecated.
Use com.inductiveautomation.ignition.client.util.action.BaseAction instead.
Base class for most text entry fields.
The base class of all functions, includes blank implementations of some of the methods from
Function that aren't used by many functions, like the connect/startup stuff.
com.inductiveautomation.ignition.common.alarming.BasicAlarmEvent
com.inductiveautomation.ignition.common.alarming.BasicAlarmEvent
com.inductiveautomation.ignition.common.alarming.config.AlarmModeProperties
com.inductiveautomation.ignition.common.alarming.config.AlarmModeProperties
Note that com.inductiveautomation.ignition.common.alarming.config.AlarmProperty is an interface.
Note that com.inductiveautomation.ignition.common.alarming.config.AlarmProperty is an interface.
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmProperty
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmProperty
com.inductiveautomation.ignition.common.alarming.config.CommonAlarmProperties
com.inductiveautomation.ignition.common.alarming.config.CommonAlarmProperties
Deprecated.
com.inductiveautomation.ignition.common.user.BasicAuthenticatedUser
com.inductiveautomation.ignition.common.user.BasicAuthenticatedUser
This is the "reference" UI used by the alarm pipeline editor.
com.inductiveautomation.ignition.common.config.BasicBoundPropertySet
com.inductiveautomation.ignition.common.config.BasicBoundPropertySet
The Property objects used as the keys in the BasicBoundPropertySet map
The Property objects used as the keys in the BasicBoundPropertySet map
com.inductiveautomation.ignition.common.config.BoundValue
com.inductiveautomation.ignition.common.config.BoundValue
com.inductiveautomation.ignition.common.config.BasicConfigurationProperty
com.inductiveautomation.ignition.common.config.BasicConfigurationProperty
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel.InternalPropertyWrapper
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel.InternalPropertyWrapper
Used internally in com.inductiveautomation.ignition.gateway.gan.protoserializers.tag.BasicConfigPropModelSerializer
Used internally in com.inductiveautomation.ignition.gateway.gan.protoserializers.tag.BasicConfigPropModelSerializer
Basic implementation of Connection
The SpringPanel is the container for FactoryPMI.
com.inductiveautomation.ignition.common.BasicDataset
com.inductiveautomation.ignition.common.BasicDataset
com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty
com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty
com.inductiveautomation.ignition.common.sqltags.model.scripts.BasicTagEventScripts
com.inductiveautomation.ignition.common.sqltags.model.scripts.BasicTagEventScripts
The ExecutionEngine is a wrapper around a scheduled executor service.
This basic function factory extends
AbstractFunctionFactory in order to implement the
ExpressionFunctionManager interface, making it mutable.A basic implementation of IGridSettings with settable values.
The basic historical record represents a specific query with columns of data.
Deprecated.
This general purpose information class has a name, and then a set of named properties and stat
metrics.
com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel
com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel
Protobuf type
common.protobuf.ClassifiedChildPropPBProtobuf type
common.protobuf.ClassifiedChildPropPB
Used to represent
com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel.ClassifiedProperties
in BasicMutableConfigurationPropertyModel
Used to represent
com.inductiveautomation.ignition.common.config.BasicMutableConfigurationPropertyModel.ClassifiedProperties
in BasicMutableConfigurationPropertyModel
This is the basic serializable version of the configuration property model.
An extremely simple thread-safe object pool backed by a LinkedList.
Basic struct-style implementation of OPCBrowseElement
A basic implementation of
Property.Value condition appropriate for use with simple Properties that have a single String-able value
or numeric value.
com.inductiveautomation.ignition.common.config.BasicProperty
com.inductiveautomation.ignition.common.config.BasicProperty
A collection of properties and values.
com.inductiveautomation.ignition.common.config.BasicPropertySet
Protobuf doesn't allow a map key to be an Object, so we can't implement the BasicPropertySet map directly.
com.inductiveautomation.ignition.common.config.BasicPropertySet
Protobuf doesn't allow a map key to be an Object, so we can't implement the BasicPropertySet map directly.
Swaps the property name for a new one, doesn't affect the value.
The basic implementation of QualifiedValue.
Deprecated.
Protobuf type
common.protobuf.BasicQualifiedValuePBProtobuf type
common.protobuf.BasicQualifiedValuePBDeprecated.
Protobuf enum
common.protobuf.BasicQuality_LevelPB
com.inductiveautomation.ignition.common.model.values.BasicQuality.
com.inductiveautomation.ignition.common.model.values.BasicQuality.
Most common implementation of RedundancySnapshot.
A TreeCellRenderer that renders trees full of RenderableTreeNodes.
A basic implementation of Result that can be used for browsing operations.
Protobuf type
common.protobuf.BasicResultPB
com.inductiveautomation.ignition.common.browsing.BasicResult
Protobuf type
common.protobuf.BasicResultPB
com.inductiveautomation.ignition.common.browsing.BasicResult
Protobuf type
common.protobuf.DisplayPathPBProtobuf type
common.protobuf.DisplayPathPBA basic implementation of the
Role interface.Deprecated.
Basic implementation of StreamingDatasetWriter that simply writes each row into an in-memory
datastructure ( a List )
Contains the local config changes of a tag.
This class combines a single tag's configuration (the "local" propertyset) with any inherited
configuration.
com.inductiveautomation.ignition.common.tags.config.BasicTagConfigurationModel
com.inductiveautomation.ignition.common.tags.config.BasicTagConfigurationModel
com.inductiveautomation.ignition.common.tags.config.BasicTagConfiguration
com.inductiveautomation.ignition.common.tags.config.BasicTagConfiguration
Deprecated.
use
AggregatedQueryOptions or RawQueryOptions.
com.inductiveautomation.ignition.common.sqltags.history.BasicTagHistoryQueryParams
com.inductiveautomation.ignition.common.sqltags.history.BasicTagHistoryQueryParams
Deprecated.
Deprecated.
com.inductiveautomation.ignition.common.sqltags.BasicTagPermissions
com.inductiveautomation.ignition.common.sqltags.BasicTagPermissions
Protobuf type
common.protobuf.ZoneRolePBProtobuf type
common.protobuf.ZoneRolePBDeprecated.
A basic implementation of the
TransactionSet interface.A translation package implementation that manages an index of keys and multiple
TranslationBundle objects for different locales.Serializes a
BasicTranslationPackage as the sequence of calls that rebuilds its keys and
translations.
com.inductiveautomation.ignition.common.user.BasicUser
com.inductiveautomation.ignition.common.user.BasicUser
A basic implementation of OPCWriteRequest.
Configuration for batching
Per-batch state carried through the definition-resolver call chain, tracking the staging-cache
keys the batch has staged.
Batching layer over
AbstractDefinitionResolver.Thread-safe accumulator of one flush's pending definition writes, deduplicated by path.
The resolver could not produce a usable node (implicit id).
The outcome of a definition flush.
A write was buffered; the node's id is known after the flush.
The accumulated definition work for one path in one flush: a retire, an upsert, or both.
The node already carries a real id.
Capability of a storage engine that accepts pre-coalesced batches of temporal points and writes
them directly, bypassing the debounce or coalesce queue used for realtime arrivals.
A BatchOperation collects together a set of operations that should be executed together as a
batch.
Engine-scoped staging cache for newly created
HistoricalNode definitions whose batch has
not yet committed: the union of the staged definitions of all in-flight batches.Batches receive events based on the
BatchStrategy and forwards to the next stage.Defines how BatchStage interacts with custom BatchStrategy.
A writer interface for writing batches of data to a data store / sink.
The tree cell renderer for the
ComponentPropertyTreePanelThis is a thin wrapper around BeanInfo, which has some more helpful conveniences for calling
getters and setters without all the syntax noise
A wrapper for the Introspector to return instances of BeanInfos.
An
ExpressionParseContext that creates expressions which reference the properties on an
object using the bean-style naming pattern to look up the getter.The SFC Chart Element Editor for the Begin Step
Factory for making new BeginStepEditor Uis
Just like DataInputStream but uses buffered reads for readInt and readShort
This layout manager fixes wonky width calculation in the normal scrollpane layout
An output stream that mirrors all output on 1 or more child output streams.
java.math.BigInteger
java.math.BigInteger
A functional interface for serializing and deserializing a value to and from binary.
Marks the annotated field or type as bindable.
A model that can have bindings applied to it.
A property editor that allows for control over whether or not binding is enabled.
A simple, type-safe implementation of
TreeNode suitable for binding
arbitrary values to a Swing JTree.Lazily-allocated record holding all checkbox-related state.
Contains references to subscriptions and
EventListeners for usage in conjunction with the
mvvm binder classes.A binding is associated with a target property and shares the lifecycle of the component (or
shorter, in the designer-scope sessions).
This class maps a UI node value to a model key value (some kind of display object like a Swing
component value or an RMShape size).
Interface for Binding objects.
Since different kinds of objects may use different subclasses of AbstractBindingHarness, this
factory is provided to instantiate the actual harness instances required.
A marker interface that marks POJOs that represent the whole configuration for a binding, but
have to logic themselves.
Wraps up all of the various bits and pieces that a binding factory needs to create a new binding
for a component's property, given a binding interchange spec
A
BindingContext holds information about how to bind various parts of a Java Object.This frame holds the configuration and preview panels for a single binding (including transforms)
This frame holds the ItemSelectionPanel that lets the user pick between the various binding
types, or clear the binding entirely.
A runtime exception for when a binding fails to bind or fails to perform.
Custom expression editor that adds browse tags and browse properties buttons
Created by carlg on 1/26/2017.
Describes a single parameter that will be used in an extensible BindingType
Contains the functions needed for a binding parameter's editor to display a popup-tree so that
the user can browse for the possible values for this parameter
Polling parameters of the historian.query binding, as
AbstractPollingBinding accepts
them.Created by carlg on 1/26/2017.
All
Bindings are called when ModelUpdates.ALL is called.Single-line expression editor that adds browse tags and browse properties buttons
A binding type describes and implements a custom binding.
Interface for classes that perform wiring of bindings.
Contains various static functions used to create bindings
This class allows for the execution of the unary bitwise complement (aka NOT) operator in
Expression Language.
Represents an observable block
Action handler for cut/copy/paste/delete of block workspaces
A JPanel used to display a block.
Deprecated.
use the state held inside
AggregateFunction accumulators.A model of a block diagram.
Extension of Callable that supports being canceled.
Helps to manage threading for a series of tasks.
A class to represent a bookmark.
Created by colby.clegg on 8/24/2015.
Created by Colby on 5/2/2015.
Created by carl.gould on 1/29/2015.
Stores a subset of information for a gateway which will be launched after a restart or
retarget.
Field used by the json editor.
A panel that has a main component and can have helper components.
Used to bind a UI control to a model property, where property is meant in a strict Java sense.
Inner utility class to simplify figuring out how to display null values in controls.
Inner utility class that performs the runtime wiring of all bindings in this package.
com.inductiveautomation.ignition.common.config.BoundExtendedPropertySet
com.inductiveautomation.ignition.common.config.BoundExtendedPropertySet
A binding for an interface component that has an extent (setExtent/getExtent methods).
Inner utility class that performs the runtime wiring of all
BoundExtent bindings.Creates a JPanel with
JTextField, JideButton to launch binding-path browser, and
a notification icon that reports the validation status of the field's String.Which bounding samples an aggregate query fetches beyond its time range: the latest sample
strictly before
startTime (pre-bound) and the earliest strictly after endTime
(post-bound).Bounding-value configuration: the mode and the optional lookback and
lookforward horizons the pipeline's
BoundingValueResolver uses when it must fetch
boundary samples itself.Policy for the search horizon of a bounding-value read, shared by every consumer of
BoundingOptions.lookback() and BoundingOptions.lookforward().A binding for an interface component that has a location (setLocation/getLocation methods).
Inner utility class that performs the runtime wiring of all
BoundLocation bindings.This is an expression that is bound to a property value in a given PropertyValueSource.
com.inductiveautomation.ignition.common.config.BoundExtendedPropertySet
com.inductiveautomation.ignition.common.config.BoundExtendedPropertySet
An interface that marks a component that wants to handle its own bounding box, rather than use
the bounding box from Swing/JComponent.
Inner utility class that performs the runtime wiring of all
BoundSelection bindings.Holds a single, generic value bound to a property or tag
A BoundVariableExpression (abbrv BVE) is the main workhorse of the expression language.
Represents a debugger break point for a project file.
The capability set shared by engines that serve queries through the tag history bridge:
SqlHistorianProvider, RemoteHistorianProvider, and any third-party engine adapted
through it.Used as a stand-in when a binding factory fails to produce a valid binding instancee.
Browsable is the elementary object of the gallery browser.
A BrowsableLibrary is the model for a browsable gallery
This is a filter for our common browsing framework.
Serializable version of PropertyValue
This filter class allows for the definition of one or more potential filters for a specific
type id.
Protobuf binary adapter for
BrowseFilter.
com.inductiveautomation.historian.common.protobuf.BrowseFilter
com.inductiveautomation.ignition.common.browsing.BrowseFilter
Protobuf type
common.protobuf.tags.BrowseFilterPB
com.inductiveautomation.historian.common.protobuf.BrowseFilter
com.inductiveautomation.ignition.common.browsing.BrowseFilter
Protobuf type
common.protobuf.tags.BrowseFilterPBProtobuf type
common.protobuf.MetaPBProtobuf type
common.protobuf.tags.MetaPBProtobuf type
common.protobuf.MetaPBProtobuf type
common.protobuf.tags.MetaPBProtobuf type
common.protobuf.NameFilterPBProtobuf type
common.protobuf.NameFilterPBProtobuf type
common.protobuf.tags.NameFilterPBProtobuf type
common.protobuf.NameFilterPBProtobuf type
common.protobuf.NameFilterPBProtobuf type
common.protobuf.tags.NameFilterPBSubclass of the
BrowsePropertiesButton that has the handling for converting the selected
property into a python access snippet.Receives the results of a browse: nodes, a continuation point for paging, and recursive child
publishers.
Configures a node before it is added to the results.
Filename: BrowserComponentTermFinder.java Created on Apr 21, 2014 Author: Kathy Applebaum
Copyright Inductive Automation 2014 Project: Ignition_77
AbstractAction which clears the selection of the current Perspective Editor.Deprecated.
com.inductiveautomation.ignition.common.browsing.BrowseResults (deprecated class)
com.inductiveautomation.ignition.common.browsing.BrowseResults (deprecated class)
BrowserLauncher is a class that provides one static method, openURL, which opens the default web
browser for the current user of the system to the given URL.
AbstractBrowserModel - A public interface for controlling a browser.
This panel contains the JxBrowser's Browser.
Model for a Perspective client dependency (aka - browser runtime dependency) required by one or
more components.
A browser class.
The browser model interface.
com.inductiveautomation.ignition.common.tags.browsing.BrowseValue
com.inductiveautomation.ignition.common.tags.browsing.BrowseValue
BufferedMarkupHandler - a PDFMarkupHandler (and Java2DMarkupHandler) that renders PDF into an
image.
BufferedMarkupHandler.
This class represents a build error (or warning) for a file.
This class is a Border that simple delegates to the UIManager's version of "Button.border" Since
button borders are typically tricky, and will only actually paint on real buttons, if this is
used on a non-button, this class will use a dummy button so that the border is drawn regardless.
Encodes an Object to byte[].
A pool of byte[].
This class takes multiple datasets and represents them through a single unified interface.
A cache bucket holds data for a certain range.
Convenience object that encapsulates proper caching logic for holding onto a Component reference
This key is our "first layer".
Deprecated.
Deprecated.
These are the settings for the cache.
Second Step.
Holds actions and implementation for constructive area geometry functions that deal with shape
components.
This is an interface that is used on some properties to indicate that they are actually
"calculated" property, derived from the values provided in a property set.
An on-the-fly roster used in scripting for Alarm Notification Pipelines
Used to construct a list of dictionaries that represent Users.
Deprecated.
use the Historian
QueryEngine pipeline.A tool exposed to the model: pairs a declarative
ToolDescription (sent to the model so it
knows how to call the tool) with an CallableTool.invoke(Map) method that executes the call with parsed
arguments.An annotation to mark that a method should be called when the bound model updates in a specific
way.
Utility class that performs the wiring for
CallOnUpdate annotations.Marker interface for option enums to indicate that their names should be converted from camel
case before use
Scheduling interface which provides a command to cancel a scheduled task.
One canvas chart style: the ECharts theme a chart renders with, plus the metadata the Perspective
Gateway web UI needs to list and preview it.
Reads and writes one style's
config.json.Owns the gateway-scoped canvas chart style resources that supply ECharts theme JSON for
Perspective canvas charts across every project on the gateway.
Chart styles for an offline session, which can't fetch from the style route.
Serves ECharts theme JSON for canvas charts.
A ChangeListener, PropertyChangeListener, ActionListener, and DocumentListener and ItemListener
all in one that calls onChange() for everything.
Category is the elementary object of the gallery categories.
Deprecated.
since 8.3.
UI for customizing the reporting pie chart shape.
Basic category dataset implementation backed by an Ignition Dateset
This provides static methods to convert comma delimited text into a JSONArray, and to covert a
JSONArray into comma delimited text.
Provides ReportMill UI editing for CellDivider shape.
Specifies a region in a
ListCellRenderer or @link
javax.swing.TableCellRenderer} that can be interacted with.Handles event that occur on a cell region.
Flagging interface for items that participate in cell regions.
Builder for creating a list of cell regions.
Handles cell regions in a JTable or JList.
Used in conjunction with
CellRendererStateSupport to manage different icon states:
Selected, Unselected, Disabled.When creating a cell renderer that has more than one component to manage state of (such as a
JLabel for the icon, and a JTextArea for the text), this class can be
used to coordinate the cell states so that all the components are in sync: the correct background
and foreground for the selected state, eg.This class provides support for UI editing of RMCellTable shapes.
Provides Swing UI editing for RMCell shapes.
A simple, strings-only representation of a cell update spec
A layout manager to simply center a component.
A property resolver that looks first in one resolver, then in another.
Created by carl.gould on 8/14/2014.
A Runnable class that takes an iterator of change listeners and a tag change event and will
notify all of the listeners when run.
Modifications to resource collections are defined as a series of ChangeOperations.
Protobuf type
common.protobuf.AnnotationChangePointPBProtobuf type
common.protobuf.AnnotationChangePointPBProtobuf type
common.protobuf.ChangePointPBProtobuf type
common.protobuf.ChangePointPBProtobuf type
common.protobuf.SourceChangePointPBProtobuf type
common.protobuf.SourceChangePointPBPer-engine registry that maps each
ChangePointType to the handler accepting a homogeneous
batch of change points of that type.Builder used in
AbstractStorageEngine.registerHandlers(ComplexPointRegistry.Builder, ChangePointRegistry.Builder); ChangePointRegistry.Builder.build() produces the
immutable registry.The type of a
ChangePoint; the only implementation is StandardChangePointType.This interface describes a character stream that maintains line and column number positions of
the characters.
This interface describes a character stream that maintains line and column number positions of
the characters.
This interface describes a character stream that maintains line and column number positions of
the characters.
Dummy context used to test expression syntax
Created by carl.gould on 7/14/2015.
Created by carl.gould on 6/16/2014.
com.inductiveautomation.sfc.scripting.ChartInfo
com.inductiveautomation.sfc.scripting.ChartInfo
A ChartObserver is notified when the chart or chart elements change state.
A tree combo box that allows for selection of an SFC path.
Accepts a flat Chart Scope dataset and creates a view of datasets with category headers.
com.inductiveautomation.sfc.ChartStateEnum
com.inductiveautomation.sfc.rpc.ChartStatus
com.inductiveautomation.sfc.rpc.ChartStatus
Protobuf enum
sfc.protobuf.ChartStatusPb.ElementStateEnumPbProtobuf type
sfc.protobuf.ChartStatusPb.ElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.ElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.ParallelElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.ParallelElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.StepElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.StepElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.TransitionElementStatusPbProtobuf type
sfc.protobuf.ChartStatusPb.TransitionElementStatusPbThe canvas chart styles that ship with the module, and the fallback used when nothing else
matches.
This is the root of the object hierarchy which is serialized into the project resource, it
represents the chart as it is displayed in the UI.
Encapsulates the checkbox state derivation pipeline for
BindableTreeNode trees.Binders for a
TriStateCheckBoxTree that supports explicit tri-state control (checked,
unchecked, partial) on individual nodes, with digIn=false by default.A
Runnable whose run() may throw a checked exception.A
Supplier whose get() may throw a checked exception.Second Step on a restart operation.
Data component that can be attached to an
Entity for entities that have children.A file to represent a Java class.
This class puts up the splash screen.
Serves as a bidirectional mapping between classes and their names.
A data source that pulls from the class path.
A set of Dataset utilities that are specific to the Vision client, e.g.
These are DB utilities that are common to the client system as a whole (designer, client)
In the client, functions are serialized into the bindings.
Handles client event scripts, working with
WindowWorkspace and resource-specific
ResourceEditors.Enum that maps client script resource types to their corresponding editor
The client (and designer's) function factory.
This is the hook that gets called from the client bootstrap launcher.
A static collection of listeners that will be notified when the client is shutdown.
Represents the object POSTed to /logs by the client's jsnlog.js system.
The trigger configuration of a Vision client message-handler event script: the thread the handler
runs on.
Which thread the handler runs on.
Deprecated.
The main hook into a module's client scope.
Reflectively destroys the thread locals held onto by the Py class - used to avoid memory leak
Implementation of property tree privacy that understands the flags set for properties stored in
prop configs
Well-known ids for Ignition platform functionalities.
This class streamlines printing tasks by capturing component snapshots and converting them into
Java BufferedImages.
Deprecated.
Since 8.3.0; create a
Task if you want platform managed UI for an
asynchronous task.This repaint manager lets use have components opt-into a coalesced repaint mode, where their
repaint requests are translated as repaint requests on their parent for their location.
Represents a session for a Designer or Vision Client.
The Client half of the negotiation of RPC payloads between the gateway and clients/designers.
Folder node for managing multi-event client scripts of the specified resource type.
Filename: ClientScriptingFunctions.java Created on Mar 27, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Represents a node in the navigation tree specifically for client script configurations.
Created by carlg on 11/23/2016.
A ClientStepFactory is responsible for creating StepView objects given their associated
StepConfig objects.
The ClientStepRegistry is where you need to add your ClientStepFactory to add a step.
Both client and designer hooks will be an instance of this interface
Subinterface of Tag, a Client Tag adds integrated change listening, and adding/removing tags.
Utilities for importing client tags from various sources (XML, TagConfiguration lists) and
building fully-qualified client tag paths.
This represents a tag provider in the client.
This class manages subscriptions between the tag system to the gateway.
The goal of this class is to 1) deliver property change events on the EDT and 2) Not let slow
prop change events cause a build up of new changes
Some utility methods for Snap.
Deprecated.
Moved to package com.inductiveautomation.ignition.client.util in Ignition
8.0.5
A ReentrantLock that supports Java 8 AutoCloseable.
A wrapper around
ReentrantReadWriteLock that provides auto-closeable lock acquisition for
use with try-with-resources.An
AutoCloseable that releases a lock when closed.A panel that wraps contents and puts a close button in the upper right corner.
Provides information about the current state of the connection to the other node.
CodeEditor is a panel that includes a syntax highlighting text area that wraps
RSyntaxTextArea.An
EditActionHandler
for CodeEditors which takes care of the basic Copy / Cut /
Paste / Delete actions.A factory for creating code editors, based on
CodeEditor.Action that will collapse all panes of a collapsible pane palette
A custom collapsible UI panel extending
CollapsiblePane.Class is used to render a cell with a dropdown icon to the right.
Describes one data collection operation for a
DataCollector, as a set of properties.First builder step: the collection id.
Final builder step: optional settings.
Third builder step: the value origin.
Second builder step: the collection source.
Keys for the standard context properties.
How a
DataCollector schedules processing of the data it receives.Identifies a data collector by a string id and a
CollectionMode.Simple component used for editing colors.
Created by carl.gould on 7/21/2015.
Class displays a grid of color swatches.
java.awt.Color
java.awt.Color
This class represents a color state, one color, possibly with an alternate (blink) color and a
blink rate
An interface used as a callback when the popup variety of the ColorStateConfig is used.
Small rectangular component that displays a color, and when pressed, shows a popup editor.
Provides a color swatch, which is a square of a specific size.
This class contains meta data used for rendering a column.
This subclass of BasicDataset knows how to populate itself based on a Map<String, ? extends
ColumnAttribute>
Helper class that can create a Map<String, ? extends TableColumnAttributesinvalid input: '>' out of a
dataset.
This panel is the table used for each column's options.
These names of these values really correspond to parameter directions, but for consistancy we're
using them for everything- for example, "OUT" indicates READ-ONLY.
A DataSet which is essentially a view on a underlying DataSet.
Created by carl.gould on 8/11/2015.
This class defines a particular column in our query.
Type of one result column in a
RowSchema: either a resolved tag DataType or the
ColumnType.Untyped.OBJECT sentinel for a column whose values are not of one type.Column whose every value has the same resolved
DataType.Sentinel for a column carrying values of more than one
DataType.Dialect-aware classification of SQL column types into a small set of comparable "families", used
to validate that an existing database column's declared type is compatible with the type the
platform expects to store there — without false-positiving on benign width/precision/dialect
differences (e.g.
If a
JComboBox contains combo items that need to be rendered to a specific
String.These are many of the properties that are used throughout the alarming system, provided/known by
Ignition.
CommonBeanInfo is the base class of all BeanInfo classes used by the Vision module.
The base interface for all Ignition contexts (Gateway, Designer, and Vision Client),
consolidating common functionality available from any context.
Simple abstract decorator for
CommonContextAbstract base class which takes care of some boilerplate for handling edit actions of
Components.This mouse listener and mouse motion listener implements logic to make handling mouse drags
easier.
These are well-known properties that are common across the system, and are used in a variety of
situations.
Created by colby.clegg on 2/2/2015.
A collection of static methods and constants to make the UI uniform.
Utility to perform string comparisons that sort in a human-readable order (e.g.
An enum listing the possible comparison operations.
com.inductiveautomation.ignition.common.ComparisonOperator
This represents a tag event script that has been compiled for execution.
This represents a tag event script that has been compiled for execution.
Renders
CompletionDescriptors as plain-text documentation — a symbol's signature,
parameters, return type, throws, members, and deprecation — for AI tool responses and
@-reference bodies.This class is an
EntityId for an instance, that also specifies the entity id of a member
element.A point whose value is a complex structure of type
V; its type defaults to StandardComplexPointType.GENERIC.Marker for processors of
ComplexPoints read by ComplexQueryKeys.Protobuf type
common.protobuf.AnnotationPointPBProtobuf type
common.protobuf.AnnotationPointPBProtobuf type
common.protobuf.ComplexPointPBProtobuf type
common.protobuf.ComplexPointPBProtobuf type
common.protobuf.MetadataPointPBProtobuf type
common.protobuf.MetadataPointPBPer-engine registry that maps each
ComplexPointType to the handler accepting a
homogeneous batch of points of that type.Builder used in
AbstractStorageEngine.registerHandlers(ComplexPointRegistry.Builder, ChangePointRegistry.Builder); ComplexPointRegistry.Builder.build() produces the
immutable registry.A
QueryKey for complex points, identified by a value of type I.Protobuf type
common.protobuf.AnnotationQueryKeyPBProtobuf type
common.protobuf.AnnotationQueryKeyPBProtobuf type
common.protobuf.MetadataQueryKeyPBProtobuf type
common.protobuf.MetadataQueryKeyPBQuery options for complex points.
Protobuf type
common.protobuf.AnnotationQueryOptionsPBProtobuf type
common.protobuf.AnnotationQueryOptionsPBProtobuf type
common.protobuf.MetadataQueryOptionsPBProtobuf type
common.protobuf.MetadataQueryOptionsPBThe ComplexTagDefinition is the primary implementation of ComplexTag.
Interface for component instances.
This class represents the configuration of a Component at a specific location in a running
DesignerViewModel.A Gson serializable representation of a Component definition.
Custom GSON serializer used to omit empty stuff to keep the serialized components small as
possible.
This interface represents the component model that is registered with
ComponentRegistry.Component implementors may choose to provide an implementation of this interface in order to
provide a more custom design experience for their component.
DesignDelegates may contribute buttons to the workspace's toolbar when the component type is
the current deep selection.
Gson-compatible class that wraps up the details that the designer retrieves from the js bridge
about a selected component.
A custom divider for a JSplitPane that contains a component centered within it.
A
BasicSplitPaneUI that embeds an arbitrary component inside the split-pane divider and
keeps drag feedback visually aligned with that component.Describes an event that a component might fire.
This isn't meant to be an exhaustive list, just commonly referenced components
Attaches a key-press listener to a Swing component that fires a callback when any key from a
specified set is pressed.
Components that implement this interface will get started up and shut down when their containing
window is first displayed and closed, respectively.
The model for a running client component, of which many may exist forming the complete component
tree for a running
DesignerViewModel;A ComponentModelDelegate is created when its
ComponentModel owner is created.Functional interface for a factory method which creates
ComponentModelDelegatesA Registry for
ComponentModelDelegateFactoriesBasic
ComponentModelDelegateRegistry implementation, backed by concurrent collection
types for safety.This object is used when a python script references a perspective component.
Delegates to the actual component, this prevents the scripting system from being able to call
everything on ComponentModel, like startup(), shutdown, etc.
Fired on the
ViewModel's EventBus when a component's name changesCreated by carlg on 6/13/2017.
Represents a path to a component, supporting the logic needed to derive the most appropriate
relative path to reference one component from another.
A popup menu that holds many of the actions that act upon the current selection.
Used to attach a light weight popup window containing a
JComponent to a JButton.If the content component needs to sit within a panel for layout reasons, this class can provide
a panel that can be used to contain the content component, while providing easy access to the
component.
To create an instance of this class use
To create an instance of this class use
ComponentPopupSupport.createContentPanel()The handler for the popup.
Specifies how the popup should be oriented relative to the popup owner.
PromptAssist that exposes the components of the current Perspective view to the
@-popup.The basic term finder looks through all properties of the bean for standard string based
translatable properties.
Agent that proposes targeted edits to a single Perspective component's PROPS tree.Document model that knows how to write values back to the underlying property tree
Registry of all perspective components.
A component restriction represents a type of security restriction that can be applied to a
component.
Handles all component-specific related routes for Perspective.
Created by Carl.Gould on 9/1/2015.
A JsonEditor that edits a specific scope of properties for the current selection
This is the frame for editing scripting on components.
Record class that represents an OpenAPI Components Object
Created by carlg on 6/13/2017.
Locates translatable terms on a component.
Visits BindingRoots, initializing them.
Visits ComponentLifecycles, shutting them down.
Visits ComponentLifecycles, starting them up.
Visits TemplateHolders, calling initTemplate() on them
Counts up the number of each template that will be needed on initialize, and then can pre-load
instances for templates that will be needed more than once.
Visits DynamicPropertyProviders, initializing their UDTProperties.
Agent composed from named slots — a preamble and framing for the system prompt, a series
of ToolBundles, and a series of AdditionalContextParts.Builder for
ComposedAgent.A composite property set holds multiple other property sets, and loops through them to find
properties.
A composite
RpcSerializer that delegates to different GatewayRpcSerializer
implementations based on the package ID of the RpcCall, falling back to a general
serializer otherwise.Provides the ability to create ProgressListeners that get coalesced into a single
BoundedRangeModel.
Use this annotation on any ShapeProperty that you want the property reflection to descend into
and discover sub-properties.
In charge of updating the various UI buttons / popups relating to tracking what other Designer
sessions are doing
A condition returns true/false for whether a value passes.
A condition returns true/false for whether a value passes.
Represents a condition that is part of a SQL where clause.
This condition subclass represents a list of conditions.
A class to parse a condition string and return a condition.
Convenience class for ensuring that a json object structure has expected members in it.
Annotate a shape with this if it requires a custom UI for configuring the shape in addition to
the properties table.
Collection of utility methods to encode and decode resource collection and related objects
to/from JSON.
One problem found in a proposed config object, anchored to the JSON path where it was found.
The collected results of validating a config object against a
ConfigSchema: one ConfigProblem per violation, ordered by path.
com.inductiveautomation.ignition.common.config.ConfigurationProperty.CustomEditorDescriptor
com.inductiveautomation.ignition.common.config.ConfigurationProperty.CustomEditorDescriptor
Holds the editor table and custom property button.
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel.InternalPropertyWrapper
com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel.InternalPropertyWrapper
Protobuf type
common.protobuf.tags.PropertyDependencyPBProtobuf type
common.protobuf.tags.PropertyDependencyPB
com.inductiveautomation.ignition.common.config.ConfigurationProperty.Option
com.inductiveautomation.ignition.common.config.ConfigurationProperty.Option
One resource of a config type, identified but not yet read.
Helpers for one-time, idempotent migrations of config resources at startup.
The full configuration of a single config resource.
The authoritative specification of one config object: a hand-authored JSON schema describing its
structure, paired with the extraction that turns config JSON into a typed model.
Turns config JSON into a typed model.
JPanel can be added to the configuration panel of a ScriptableChart to enable users to edit the
chart's configuration script
The detailed view of a single config resource type: what it is for, what its configuration looks
like, and which subtypes it offers.
A single entry in the catalog of config resource types an AI agent is allowed to know about.
Thrown when a proposed configuration object cannot be turned into its typed model — a missing
required member, an unparseable value, or a semantic rule the JSON schema cannot express.
The ConfigurationManager is the primary interface for interacting with the configuration of a
Gateway.
Represents the possible state of the gateway at startup.
An extension of
DescriptiveProperty that also provides a list of the possible values for
the property as well.Configuration properties can define custom editors.
The ConfigurationPropertyModel is a transferable (serializable) model of properties.
Adapter for serializing/deserializing
BasicConfigurationPropertyModel to/from Protocol
Buffers using the TagProto adapter system.An abstract property editor that automatically adds the dynamic property binding button.
Represents a directed connection between anchorpoints on two blocks.
Listens to the GatewayConnectionManager to monitor gateway connection health, notifying the
designer when the connection is poor
Used to, well, paint connections of course! See
AbstractBlockWorkspace.newConnectionPainter(BlockDiagramModel)Created by colby.clegg on 5/27/2015.
Different from the ConnectionListener in the sense that this listener is intended for use in
redundant setups, where the status of the inactive connection must be updated along with the
status of the active connection.
First step.
com.inductiveautomation.ignition.common.user.ContactInfo
com.inductiveautomation.ignition.common.user.ContactInfo
Record class that represents an OpenAPI Contact Object
Represents a method of contacting a user.
com.inductiveautomation.ignition.common.user.ContactType
com.inductiveautomation.ignition.common.user.ContactType
Holds a name and a class of a component.
It's a List<Object>, with a name!
Many custom function factories get cached, but when delegating to the factory provided by the
context, that shouldn't happen.
Context managers are Python's equivalent of the `try-with-resources` statement - you (generally)
open one with the with statement, and it will automatically close any opened resources, even if
your code throws an exception.
One reference the user inserted into the prompt via a
PromptAssist.Option.Insert,
resolved at submit time.A heading and body pair contributed to an
Agent's additional context.Event for whenever a property in a PropertyTree changes.
Convert a web browser cookie specification to a JSONObject and back.
Convert a web browser cookie list string to a JSONObject and back.
A thin shim around the base
CookieManager to allow setting the policy via a
string, and retrieving it as such.Builds the small icon-only Copy affordance used wherever a renderer wants to expose "copy this
chunk to the clipboard" — the assistant reply bubble, fenced code blocks, table grids, etc.
Marker interface that indicates the object (and its subclasses, obviously) can be cloned
reflectively through a copy constructor.
See
See
CloneUtil for a function to do this.Used only for client tags.
This interface is used for objects that may contain 0 or more items, when we want to know
(mostly) whether the collection is empty or not.
A simple FilterOutputStream that calculates a checksum as data is written to the underlying
stream
A simple FilterOutputStream that calculates a checksum as data is written to the underlying
stream
A create step is a wizard step an extension point type needs before its configuration form.
Use to add context to a HealthCheck and include it on the Ignition Gateway's Diagnostic Overview
page.
Filename: CrossPlatformAlloyLookAndFeel.java Created on Mar 16, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Ignition_7.7
This class provides GUI editing for RMCrossTab.
A very simple CSV parser released under a commercial-friendly license.
A very simple CSV reader released under a commercial-friendly license.
A very simple CSV writer released under a commercial-friendly license.
A specialised plot that draws a compass to indicate a direction based on the value from a
ValueDataset.Common interface between PMITable and VisionJideTable to share a customizer
Customizer Action
Customizer Descriptor
A customizer dialog which takes a Component which implements the customizer interface.
A simple extension of the JideMenu that adds a few things that we commonly use to the constructor
(such as I18N support and an Icon).
This action displays a popupmenu, customized through JIDE's PopupMenuCustomizer, when the action
is performed.
This is the API base class for a custom complex property editor.
Run a chart with a custom mapping of params
A simple implementation of ExtendedTagType that lets providers easily specify their own custom
types.
This is a number axis that can have a different TickUnit for grid lines vs tick marks.
Renders the parts of the database-connection digest that the resource system cannot supply: live
connection detail, fault text, pool saturation, and in-flight query text, all read from
Datasource objects rather than from stored configuration.This Authenticator uses a database and SQL queries to authenticate users and retrieve roles
An enumeration of common RDBMS vendors.
Collects data for data nodes: creates their sessions, executes collection, and shuts down.
Sits between a collection session and its nodes and the tag actor, absorbing lifecycle gaps such
as a session created before the profiles load or a provider restarting.
Singleton registry that creates and tracks
DataCollectors, one per storage engine and
collector id, and runs their collection tasks.Forwards collected atomic, complex and change points to the storage engine unchanged, logging
the results.
A consumer interface that can store data of type
T which extends PersistentData.One key the script can read from its
data dictionary at runtime.Created by carl.gould on 7/17/2015.
Popup panel to search for data keys.
Apply this annotation to RMShape properties that are strings which represent data keys.
Filename: DataKeyTransferable.java Created on Jun 03, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Utility class to help manage DataKey functionality in Ignition Reporting.
A session for one data node: applies data, source and metadata changes to it, and ends with
DataNodeSession.retireNode() followed by DataNodeSession.release().The availability of a node.
Filename: DesignPanel.java Created on Jan 20, 2015 Author: Perry Arellano-Jones Copyright
Inductive Automation 2015 Project: Reporting 3.0
Created by mattgross on 3/15/2016.
A data point: an
AggregatedPoint or an AtomicPoint, with a value and a quality
code.Static factory for
AtomicPoint, AggregatedDataPoint and null points.Sealed marker for processors of standard temporal points; its only subtypes are
AggregatedPointProcessor and RawPointProcessor.Protobuf type
common.protobuf.AtomicPointPBProtobuf type
common.protobuf.AtomicPointPBA
QueryKey for standard points, raw or aggregated.Protobuf type
common.protobuf.AggregatedQueryKeyPBProtobuf type
common.protobuf.AggregatedQueryKeyPBProtobuf type
common.protobuf.RawQueryKeyPBProtobuf type
common.protobuf.RawQueryKeyPBBase options for data point queries: observation exclusion, quality level filtering and bounding
values.
Builder for
DataPointQueryOptions.The type of a data point, combining
TemporalPointType and QueryablePointType with
return types narrowed to data points.Enum that represents a tag value quality.
A Dataset represents tabular data.
An XYDataset that is backed by a PMI Dataset (confusing, I know)
A builder to create datasets by hand (i.e.
Created by Colby on 12/7/2015.
This class edits datasets AND arrays!
Used in the Designer to edit dataset properties and as the dataset tag editor.
Deprecated.
Used by classes like BasicDatasetSerializer and StreamingDatasetHeaderSerializer to serialize columns
Used by classes like BasicDatasetSerializer and StreamingDatasetHeaderSerializer to serialize columns
Runs a simple panel letting the user choose a dataset key element, like table, graph, crosstab or
labels.
Runs a simple panel letting the user choose a dataset key element, like table, graph, crosstab or
labels.
com.inductiveautomation.ignition.common.Dataset
Handles different Dataset implementations
com.inductiveautomation.ignition.common.Dataset
Handles different Dataset implementations
Protobuf type
common.protobuf.DatasetRowPBProtobuf type
common.protobuf.DatasetRowPB
Used by classes like BasicDatasetSerializer and StreamingDatasetRowSerializer to serialize the rows of a dataset
Used by classes like BasicDatasetSerializer and StreamingDatasetRowSerializer to serialize the rows of a dataset
These are static functions that help when testing things involving datasets.
Utility methods for manipulating datasets, exposed as system.dataset.* in scripting.
This interface represents a data sink that can consume and process data of a particular type.
The DataSinkBinding annotation is used to specify the
DataSink for a particular type of
PersistentData.The DataSinkInformation interface provides information about a data sink.
An instance of a Ignition Datasource, which represents a configured connection pool to a database
through JDBC.
This class manages Swing GUI display and editing of editor's datasource.
Holds the configuration of a data source entry for a report.
This is the designer-scoped interface that 3rd party module authors need to implement to add new
data sources.
For use with
DataSourceConfig.This class must be extended by authors of new data sources.
Protobuf type
reporting.protobuf.DataSourceConfigPbProtobuf type
reporting.protobuf.DataSourceConfigPbDeprecated.
Defines a listener interface for monitoring changes in the state or configuration of a
datasource.
Describes an Ignition datasource, including its current status, query workload, etc.
This class manages UI display and editing of editor's datasource.
A datasource panel for RMDataSource.
Runs a datasource panel.
A datasource panel for RMDataSource.
PromptAssist that browses schema across all available datasources — first a datasource
list, then tables within a chosen datasource, then columns within a chosen table.A sink that executes queries to a datasource.
Provides RPC methods for working with datasources.
Read-only datasource and schema lookups the agent uses to ground its SQL suggestions in a
datasource that actually exists on the gateway.
Exception that is thrown when a persistent data storage operation fails.
A data store is used for receiving data to be cached temporarily until it can be taken later for
forwarding to a sink.
Interface for providing information about a data store.
A record representing a snapshot of the data contained within a store.
A supplier interface that can supply data of type
T which extends PersistentData.A class to front for a table of data.
This class represents a fetch of a set of data table rows for a given query.
Deprecated.
A class to describe type of content in WebFile (from WebURL).
Represents a "category" of data type, since often in SQLTags we do this based on a broad
category- int, float, string or date.
com.inductiveautomation.ignition.common.sqltags.model.types.DataTypeClass
An extended representation of a data type that can represent either a scalar data type or a UDT
type
Protobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.ByteArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.ByteArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.DoubleArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.DoubleArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.DoubleWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.DoubleWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.FloatArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.FloatArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.FloatWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.FloatWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int32ArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int32ArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int32WrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int32WrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int64ArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int64ArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int64WrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.Int64WrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.StringArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.StringArrayProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.StringWrapperProtobuf type
com.inductiveautomation.ignition.gateway.tags.protobuf.StringWrapperUtility methods for RMProperty.
An interface for Date selection.
The Date_selector_dialog, shown below, combines a
Date_selector and a Popup_dialog to provide a standalone, popup dialog for choosing dates.A calendar-display/date-selection widget.
A property editor for editing strings.
Created by carl.gould on 7/27/2015.
Use this to specify a date format property that will have an editor that helps pick format
strings
A simple date table cell renderer that renders dates as M/d/yy h:mm a Null dates are rendered as
the empty string.
A system tag that provides a format string that changes with the locale.
Date/time formatter lengths.
Functions for date manipulation and formatting, exposed as system.date.*.
This class is used to define the configuration properties for the DB user source.
A JythonBuilder to build a SQLQuery script using the DB browser panel.
A browsing tool that allows the user to browse the database, generating appropriate select and
update queries to match the user's selection.
Interface for providing database execution capabilities to legacy database functions.
Provides database-related expression functions.
A transaction represents a sequence of commands that need to be executed as a group, or not at
all.
The interface for the internal database.
Modal JDialog that lets the user choose chart pens from browsing the database
A class that helps construct a dynamic SQL SELECT query, using proper quoting syntax and
prepared-statement style parameters.
A clause that requires parameters to be added to the prepared statement
An arbitrary part of a SQL query, that knows how to append itself into a larger query.
A required column whose live declared type is incompatible with the
DataType the schema
expects to store there, grouped into comparable type families.The live declared type of an existing column, as reported by
DatabaseMetaData.getColumns(String, String, String, String): the JDBC DATA_TYPE (Types) and
the dialect's TYPE_NAME.Static utility functions pertaining to the database.
A very simple implementation of SchemaFeature that simply runs a sequence of DDL queries
Provides the state of the deadband, whether or not the value has changed.
Settings for
DebounceStorageStrategy: when buffered points flush and how large a batch
may be.Builder for
DebounceBatchConfig.Batches until any of the following conditions are met.
This class is used to debounce data updates.
Buffers incoming points per point type and forwards them to the storage engine in batches.
Represents a
Resource whose configuration contents have been successfully decoded using
the resource's ResourceCodec.decode(Resource) method.Thrown when a resource cannot be parsed.
A listener to get property changes and nested property changes.
A simple immutable implementation of AlertEvent
A simple immutable implementation of AlertEventFilterParams
A simple immutable implementation of AlertMessage
Default
AnnotationPointProcessor: processes annotation points, tracks a quality code per
key, and exposes the results, including as tag history Annotations.A simple immutable implementation of AuditRecord
A BeanInfo is part of the JavaBean spec - it is a class that describes a visual bean.
Default implementation of
BindableModel - should be subclassed by implementations.Default implementation of BindingParameter.
A record that represents the default data sink information.
A default implementation of
DataStoreInformation.This class implements DBExpressionFunctionProvider by executing the functions against a given
data source name using the gateway context.
Simple abstract implementation of AbstractDesignableWorkspace that expects to live within the
Ignition Designer (and thus requires a DesignerContext, and implements ResourceWorkspace)
A default implementation of the
FlavorContainer interface that stores a set of flavors.Basic function factory that adds all of the common functions that apply to all scopes.
Takes a code point (a number), return a string (a single-character string with the unicode
character referenced by the number) for example: char(0x1F4A9)=💩
This is the legacy 'forceQuality' expression, which took the old pre Ignition 8 data quality
codes.
Takes a single character string and returns the integer codepoint of the character.
Thi seq() function returns an incrementing sequence starting at zero.
Default implementation of
ImportExportDelegate that provides standard import/export
behavior for resource types:Straight-forward implementation of an interaction controller using a map of adapters.
Default
MetadataPointProcessor: processes metadata points, tracks a quality code per key,
and handles errors.This is a type of illegalargumentexception that is thrown when some part of the system tries to
use a defualt "something" which hasn't been specified yet.
Default implementation of
NullableColorSelectionModel.An implementation of SerializationDelegate that uses reflection and the JavaBean standard to try
and serialize any arbitrary object
A tree node that keeps a list of children and has addChild function to add children.
Default implementation of
PersistentFlavor.The default popup window parent.
Immutable
ProcessingContext backed by a map from query key to its PropertySet.Base builder that accumulates property values per query key.
Builder for
DefaultProcessingContext.Property pane that applies some simple styling to mesh better with the DefaultPropertyTable
A utility class that parses a json file adding components to a static map of componentTypeId:
JsonObject, given that* the json file contains either a single json component definition, or
array of json component definitions associated* with a "components" property inside the root of
the json object, where a 'json component definition' is a valid json* object string like:
{
"id" : "ia.input.button",
"palette" : { "name": "Button", "category": "input" },
"props": { "aName": "somePropertyValue" },
"resources": [
{
"name": "someComponentLib-js", // unique name of the resource
"path": "/main/data/myModuleAlias/js/someComponentLib.js", // url to the resource file
"type": "js" // type of resource, such as 'js' or 'css'
}
]
} Default implementations of each member of
ResourceAction, which provide the standard CRUD
operations for a given resource type.The Default implementation of Copy.
Not for direct use
Used internally by the Copy implementation for validation.
The main wrapper
DefaultResourceActions.ValidatingCopy provides when validating a resource on copy.The Default implementation of Create.
An object which wraps the necessary details
DefaultResourceActions.ValidatingMove provides when validating a
resource on Create.An object which wraps the necessary details
DefaultResourceActions.ValidatingMove provides when validating
resources on Create.The Default implementation of Modify.
An object which wraps the necessary details
DefaultResourceActions.ValidatingModify provides when validating a
resource on Modify.An object which wraps the necessary details
DefaultResourceActions.ValidatingModify provides when validating
resources on Modify.The Default implementation of Move.
Not for direct use
Used internally by the Move implementation for validation.
An object which wraps the necessary details
DefaultResourceActions.ValidatingMove provides when validating a
resource on Move.The Default implementation of Rename.
Not for direct use
Used internally by the Rename implementation for validation.
An object which wraps the necessary details
DefaultResourceActions.ValidatingRename provides when validating a
resource on rename.Performs the default Copy operation but allows for validation of the resource prior to the
resource being committed to the configuration system to be persisted.
Performs the default Create operation but allows for validation of the resource prior to the
resource being committed to the configuration system to be persisted.
Performs the default Modify operation but allows for validation of the resource prior to the
resource being committed to the configuration system to be persisted.
Performs the default Move operation but allows for validation of the resource prior to the
resource being committed to the configuration system to be persisted.
Performs the default Rename operation but allows for validation of the resource prior to the
resource being committed to the configuration system to be persisted.
The standard
ResourceAiDelegate, holding a fixed capability level, an optional
description, and the resource type's diagnostic contributions.The standard
ResourceDiagnostics.Collects what a resource type or one extension point contributes to a digest.
A ratio gauge that shows active/total resources for a given resource type, where "active" is
defined as having a healthcheck named "status" that is healthy
A ratio gauge that shows enabled/total resources for a given resource type
Holds a collection of
ReferenceProperty objects for a given resource type.Standard, builder-supported implementation of
ResourceRouteDelegate.Assists in building a ResourceTypeMeta for a non-extension point resource type.
Assists in building a ResourceTypeMeta for an extension point resource type.
A TagDropHandler that has a framework to install property bindings between the target component
and the dropped tag
Provides a simple mechanism for adding a SimpleBoundTagAdapter binding on a component
A subclass of SimpleDateFormat that always checks the current timezone and updates to it, in case
it has been changed.
Define the default keyword in the parameter schema to specify the default value for an optional
parameter.
Set the default value for a field using an i18n string.
This interface is used to mark components that do not retain certain properties when a Window is
closed.
This implementation of PropertySet simply delegates to a different one.
An
EditActionHandler
which delegates to an injected delegate EditActionHandler.A
FocusAdapter which sets the injected DelegatingEditActionHandler's delegate to the injected EditActionHandler delegate
when the target gains focus.A delegating persistent serializer that uses a map of flavors to serialize and deserialize
PersistentDataDeprecated.
use the Historian
QueryEngine pipeline.Allows the Managed Tag Provider to manage how tag deletion requests are processed.
Annotation for adding a string description to a Resource Schema objects.
Data component that can be attached to an
Entity to provide a human-readable description
of the entity and any attached metadata.Annotation for adding i18n Description keys to Resource object fields.
A counter implementation that delegates to another Counter instance, while adding descriptive
attributes.
A
Meter implementation that delegates to another Meter instance, while adding
descriptive attributes.A timer implementation that delegates to another Timer instance, while adding descriptive
attributes.
An interface for Metrics that know how to describe themselves and their units.
Helper class for serializing metrics that may implement
DescriptiveMetricExtends Property with a few additional fields that can be used to make display nicer.
This class is mostly a copy of the
RatioGauge from the Metrics library.A ratio of one quantity to another.
Comparator used to compare java.beans.FeatureDescriptor objects.
What is generated as after deserialization.
Context for deserialization used when deserializing data with a
PersistentSerializer.A deserialization handler handles a section of an XML parsing for a specific element.
A custom exception that is thrown when deserialization fails.
Anything being designed by the DesignableWorkspace system must implement this interface.
Defines many functions required for the design panel to interact with a DesignableContainer.
Extension of
ResourceCollection with additional functionality to support the Designer's
need to model the project as a tree of resources which can be mutated and staged for push and
pull operations.Tool methods for inspecting an in-memory
DesignableProject.A repaint manager that has special handling for when components get repainted beneath the
DesignPanel.
Adapter-pattern class that has no-op implementations of all the functions in
DesignableWorkspaceListener
Contains methods and events that are used to design a view in the perspective workspace.
Designer-scoped facade for AI features.
Bindings execute only in the Gateway, but here in the Designer we need the user interfaces to
configure bindings and transforms.
Backend instance of a component as it exists in a Designer, in order to allow special
functionality not present in a typical running project (e.g., adding, removing components, etc).
Provides a connected to a deeply selected component.
This is used for parts of the designer that hold onto a DesignerContext, even though every time
you load a project a new designer context is made.
This class serves as a proxy to the gateway for the retrieval of database meta info.
Right now it passes all calls through, in the future we should probably look at implementing caching/asynchronous exec to it or the level that calls it.
Right now it passes all calls through, in the future we should probably look at implementing caching/asynchronous exec to it or the level that calls it.
This registry holds the data source configuration datasources that have been registered on the
designer.
Renders a markdown
## Environment block summarising durable session facts — Ignition
version and edition, current date, logged-in user, current project, gateway address and timezone,
and project-level defaults — for embedding in an AI agent's system prompt.DesignerResourceMeta entries for every Perspective project resource type.A component that implements this interface will have a secondary initialization phase after its
constructor, but only when created in the designer.
Message sent by the DesignerStore.ts in response to session-init.
Author: Perry Arellano-Jones Created 21Apr2015
The main hook into a module's designer scope.
Parameters posted to designer page
The DesignerPanel allows a user to design the layout and appearance of a Report by utilizing the
ReportMill engine.
Implementation of property tree privacy that understands the flags set for properties stored in
prop configs
A utility class that assists in verifying permissions given the user and global project props or
required roles for save,publish,view,export,copy, or delete on a project Note: every permission
utility method returns true if the global props are null because the project might not have any
global props, hence granting permission
Holds current designer preferences for the Vision module
A
PropertyReference which Subscribes to a DesignerViewModel's EventBus and refreshes itself when ViewStructureChangeEvents are received.Receives open/close events from resource editors in order to track all open resources in this
Designer.
Describes a project resource type contributed by a designer module.
Registry of
DesignerResourceMeta entries contributed by designer modules.This extends from a normal root node in order to add the "default" provider.
Shared JxBrowser network callback for the embedded Perspective Designer browsers.
Holds the RM shapes that are on the palette.
Agent tool surface for "where is the user, what are they editing?" — read-only state of the
Designer's workspaces, open editors, and project configuration.
Superclass of all Designer toolbars.
Hands out the Designer-side
ToolBundles every assist agent commonly reaches for.Represents the base of a running view on the gateway.
Base class for
ExtensionPoints that provide a Device implementation.Profile configuration object common to all
Devices and DeviceExtensionPoints.Indicates that the object provides some sort of diagnostics information.
Data component that can be attached to an
Entity to provide diagnostic information, in
the form of metrics and healthchecks.Result record produced by the click-driven analysis flow of the diagnostic-digest feature.
Builds the pair of
Agents that drive a page's diagnostic-digest feature: a cheap summary
agent that runs on page load and produces a DiagnosticDigestSummary, and a deeper
analysis agent that runs on operator click and produces a DiagnosticDigestAnalysis.Registry that maps a gateway web UI page URL to a
DiagnosticDigestGenerator.Result record produced by the page-load summary flow of the diagnostic-digest feature.
Stoplight-style overall judgment surfaced as a green/red pip in the UI.
DiagnosticSample is a tree of data about a target.
A class to run a dialog box.
The rendering vocabulary shared by every section of the Event Streams diagnostic digest:
metric-to-cell conversion, number and time formatting, and the redaction and truncation applied
to any text that reaches a prompt.
Content panel for Direct mode with its own component instances.
Implementation of a Perspective query binding.
A data source implementation that draws from a directory WebFile.
Stage is disabled.
A class representing an error or exception that occurred.
This condition is basically a standard path condition, but the value is an array of paths.
For classes that supports dispose() feature.
This class exists so that modules can add PyObjectAdapter to the global, static extensible
adapter found at
Py.getAdapter() in a way that can prevent leaking the module's
classloader.A divider border draws dividing lines around components.
A JMenu of checkbox items that show/hide the various available command bars in the designer
A JMenu of checkbox items that show/hide the various available dockable panels in the designer
A PopupWindowParent that extends DockableFrame for use with the JIDE docking framework.
The scrolling portion of this class borrowed from JavaWorld See
http://www.javaworld.com/javaworld/jw-05-2001/jw-0525-mdi.html
A class representing an object type in Json.
A class representing an array type in Json.
A class representing an element of Document.
An
ElementExtractor over DocumentElement trees: Documents are the map
elements, DocumentArrays are the array elements, and DocumentPrimitive/
DocumentNull are the primitives, converted to plain Java values by DocumentElementExtractor.toJava(DocumentElement).Protobuf type
common.protobuf.tags.DocumentArrayPBProtobuf type
common.protobuf.tags.DocumentArrayPB
com.inductiveautomation.ignition.common.document.DocumentElement, used to serialize document tags
Protobuf type
common.protobuf.tags.DocumentElementPB
com.inductiveautomation.ignition.common.document.DocumentElement, used to serialize document tags
Protobuf type
common.protobuf.tags.DocumentElementPBProtobuf type
common.protobuf.tags.DocumentPBProtobuf type
common.protobuf.tags.DocumentPBModel that represents a json document, but held in memory as so to be editable by the JSON
editor.
Class that helps build document model root nodes from json elements
Created by carlg on 5/15/2017.
A class representing a
null value.A class representing a Json primitive value.
An extensible Jython object adapter that handles the conversion of Ignition Document types
(Document, DocumentArray, DocumentPrimitive) into their corresponding Jython-friendly wrappers.
Created by carl.gould on 7/28/2015.
This class provides UI for configuring an RMDocument.
An inner class to render Page control.
Created by carlg on 5/16/2017.
Java representation of the $ meta array found in encoded property trees and property sync updates
Serializes timestamp in dollar-qualified format
Fills the area with a solid fill at some transparency level.
This is used for when you want to give a map to a script, but you want the map to also act like a
python object, meaning, its keys can be referenced like this: myMap['key'] or like this
myMap.key
A double click handler can be added on a BeanInfo, and will be called when an instance of that
bean is double-clicked in the designer.
This is the component used in the property editor table to edit Double and double properties.
Basic subclass of JFormattedTextField that mimics the behavior of a PMINumericTextField set to
DOUBLE mode
Basic subclass of JSpinner that is specialized for doubles
Third step.
Downloads the zipped third-party Python scripts from the gateway
This step downloads the required runtime from the gateway but only if it has to.
A DPD creator is in charge of creating instances of DynamicPropertyDescriptors.
Row-oriented local draft model for one accepted plan row.
Composite key for nested UDT member parameter overrides.
Concrete row values for instance fields, parameter overrides, and preview-only metadata.
This MouseListener and MouseMotionListener listens to a JComponent, and initiates an exportAsDrag
on its TransferHandler when a drag exceeds 5 pixels of distance in any direction.
A component that accepts drag and drop of files.
Ribs Helper for RJCustomView.
Must implement hashcode and equals
A DrivenValue contains a value which can change (driven by some source).
Gson serialization struct for dropped items
Created by carl.gould on 4/2/2015.
Created by carl.gould on 4/2/2015.
Panel used to select a named query by path and set the parameters with support for both Direct
and Expression modes.
An empty implementation for use when we don't really care about progress.
A component that supports dynamic properties.
The customizer that can be added to any component that is a MutableDynamicPropertyProvider to
configure their properties.
This class can be used to delegate the functions that a MutableDynamicPropertyProvider needs to
implement.
Handles drop logic for dropping tags (from the tag tree in the runtime) and power table rows
A convenience implementation of FileFilter that filters out all files except for those type
extensions that it knows about.
A data source that reads/writes to a an Eclipse project in the local file system.
If you add plugins here, also add to EdgePlugin.java in gateway
Implementations of this are used to find a connector route between two AnchorPoints, routed
between a set of obstacles
Use with the SystemPropertiesManager to get or set various gateway system properties on an Edge
gateway.
Use this annotation if a property should only be editable when another property is set to a
certain value.
This class represents a PageConfig -or- a DocksConfig
An EditActionHandler is a class that handles common actions you'd find under an "edit" menu, like
cut, copy, paste, and delete.
A frame which is able to provide its own
EditActionHandler.A JFormattedTextField that sets its border and alignment properly for displaying in the property
edit table.
Encapsulates some logic useful in the editors to facilitate correct editing and listening of/to a
node's value and prevent notification looping
Marker class for listeners on this editor's event bus for when the editor is closed
A JTextField with no borders
Monitors Swing's EDT for responsiveness.
Delegate resource implementation that overrides the collection name, so that all resources,
inherited or otherwise, share the same resource id.
com.inductiveautomation.ignition.common.resourcecollection.EffectiveResource
com.inductiveautomation.ignition.common.resourcecollection.EffectiveResource
Represents an XML element
UI element used to configure a selected chart element.
Navigates one concrete document-like representation (JSON, Document, Python dictionary, plain
Java maps, etc.) on behalf of
ElementPathEvaluator, which walks a parsed path one element
at a time: ElementExtractor.extractKey(T, String) steps into map elements, ElementExtractor.extractIndex(T, int) steps into array
elements, and ElementExtractor.isPrimitive(T)/ElementExtractor.toJava(T) convert the final element to a plain Java
value.Signals that a map element has no value at a requested key, or an array element has no value at
a requested index.
Evaluates a JSON-style path (e.g.
CUP v0.10k generated parser.
Implements parser interface, since as far as I can tell there's no way to do that in the CUP
parser file.
Filename: EmailActionConfig.java Created on Feb 09, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: EmailActionPanel.java Created on Feb 11, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Encapsulates the details of an email message to be sent using an email profile.
Builder which provides a fluent-API style of creating new
EmailMessage instances.An EmailProfile exposes methods for sending emails.
An
EmailProfile which exposes additional methods for the Platform to drive the
profile's lifecycle.An
EmailProfile managed by the Platform.Manages the configured
EmailProfiles.Represents a type of email profile
Encapsulates the contextual information required for an email profile type to create new email
profile instances.
Fluent builder for mounting an embedded "Ask AI" assistant, collapsing the steps every host
otherwise repeats: gating on
readiness, assembling the EmbedHost, and unwrapping the result into the surface the host wants — an inline AssistSession, the shared AssistAction, or a ready-to-mount AssistButton/AssistToolbarButton.Host-side strategies an embedded AI assistant uses to talk to its surrounding UI: how to turn
each user submission into a message body and how to render replies into the suggestion card.
Fluent builder for an
EmbedHost whose composer and renderer are host-specific.Declares how an
AssistSession will be presented to the user.The singleton
CollectionContext with no properties, meaning no context.Special implementation of BindingParameter that essentially inserts a blank spot in the GUI.
Panel's that displayed when the corresponding section of a
SectionPanelViewModel is not
supplied.In the scenario where you have a
JPanel or a JComponent for which you
want the enable state of the children to match those of the parents, you can use this class to
achieve that.This interface represents a component that understands how to properly implement enabled within
the Vision component system.
A binding that will set the enabled state of the annotated component to the state of a model
boolean.
Enum to specify if normal or inverted comparisons should be used.
Inner utility class that performs the runtime wiring of all
EnabledIf bindings.Data component that can be attached to an
Entity to provide information about the enabled
state of the entity, and to allow the enabled state to be changed.An item listener that has a list of dependent JComponents.
The SFC Chart Element Editor for Enclosing Steps
Factory for making new EnclosingStepEditor Uis
Encodes and decodes project and resource collection objects to and from JSON.
An encoder contains a value of some type that it knows how to encode as both XML text or as
binary.
A serialization delegate that uses an encoder factory to create the element body.
Contains logic to encode various types is either text meant for XML or as binary, and to decode
those types.
These are properties that are used to encode tags to/from text.
Definitions two or more engines compute.
An engine-own or shared aggregate's definition: its id, label key, output type, parameters and
the predicates the pipeline reads.
What a query engine supports, used to filter query options in the Designer and the
historian.query binding and to filter the aggregate catalog.Details of what each capability supports.
The query features an engine can declare.
Protobuf binary adapter for
EngineCapabilities, using the EngineCapabilitiesProto.EngineCapabilitiesPB
schema.Protobuf type
common.protobuf.EngineCapabilitiesPBProtobuf type
common.protobuf.EngineCapabilitiesPBImmutable, concrete
EngineCapabilities value, for carrying capabilities across a
serialization boundary such as the gateway network, which an engine's own implementation cannot
cross.What the gateway asks an engine to do for one aggregated key it computes natively: how to treat
windows without samples, which window edges to return, and the signal's shape between samples.
The windows the engine returns edges for: the first and last stored sample of each.
How the engine treats a window without samples.
Snapshot of store and forward engine information specific for data pipelines.
The manifest for a store and forward engine, representing the engine id and all the associated
data flavors tracked within.
Represents a sink registration within the manifest, combining the storage key with the
engine-bound status.
One historian engine's slice of a binding's work; maps to one entry of the runtime
MultiEngineQueryOptions envelope.The store and forward engine status.
The modes an engine can report.
An entity is a named object that can have various data components attached to it.
This class represents an entity for a data source.
This interface marks an opaque identifier for a tag store.
The EntityManager is responsible for managing the registration and retrieval of registered
Entities.
Condition that specifies a set of enum values, any of which will pass.
Annotation for adding an enumeration of values to a Resource Schema object.
Interface for providing enumeration values
Filename: EnumOptions Author: Perry Arellano-Jones Created on: 7/24/15 Project: Reporting 3.0
EnvironmentVariable assists with resolving environment variables and provides some utility
behavior for detecting presence, resolving values, and performing simple value
translation/mapping.
Implement to define equality and hash code for class T.
When the default equals() and hashCode() of a class needs to be overridden for any purpose.
Filename: EquipmentScheduleViewTermFinder.java Created on Dec 09, 2013 Author: Kathy Applebaum
Copyright Inductive Automation 2013 Project: Vision
Protobuf type
ignition.rpc.ErrorProtobuf type
ignition.rpc.ErrorProtobuf type
ignition.rpc.Error.StackTraceProtobuf type
ignition.rpc.Error.StackTraceAuthor: Perry Arellano-Jones Created: 14Apr2015
Deprecated.
use the Historian
QueryEngine pipeline.A localized error message that gets rendered without its stack trace
Generic error message to be sent to the client for notification purposes
Used to display errors, warning, etc.
Vision clients should implement this so that this class can be secondary desktop aware.
A Write operation that represents an exception during the write.
These are quasi-properties of an alarm (that is, properties that are only known during
evaluation, not config properties) that are available to expressions on other properties.
Custom evaluator to get the next animation value for the next key frame Essentially it does what
EvaluatorColor and EvaluatorFloat does but combines it all into one class
Holds the event and action configuration for a component.
com.inductiveautomation.ignition.common.alarming.EventData
The actual EventData class extends BasicPropertySet, but Protobuf definitions can't extend other Protobuf
definitions.
com.inductiveautomation.ignition.common.alarming.EventData
The actual EventData class extends BasicPropertySet, but Protobuf definitions can't extend other Protobuf
definitions.
Created by carlg on 2/15/2017.
Defines the flags that are used in the alarm journal to further describe events.
Manages subscriptions to and delivery of events.
Handler that will be called in a listener throws any Throwable while receiving an event.
Represents a subscription of a listener that has been subscribed to an event.
NOTE: This is an in-memory event collector, but it's not currently used.
Combines EventStreamSource event data with the events metadata.
Builder for creating EventPayload.
Holds a preview of the payload.
Why there is no event to preview.
A successfully encoded event.
This wrapper around Property adds information about what kind of property it is.
Result of submitting an event to an Event Stream
A Condition implementation with the smarts to be able to search tag event scripts in a tag.
Base class for folder nodes managing event scripts in a script workspace.
Abstract node for event script nodes, providing common actions like close and commit, and close
and revert.
Contributes the event-script tab's live state as the leading blocks of each assistant message:
Renders event-script assistant replies and applies an accepted suggestion to the live tab in one
click.
Write-backs to the live tab, each invoked on the EDT when the user clicks Apply.
A base class for event script nodes in the navigation tree.
Represents the various states of event scripts based on their configuration and migration
needs.
Abstract base class for event script tabs.
An event-script tab as the assistant sees it, taken fresh at each read — the popup is non-modal,
so nothing may be cached across submits.
This is a wrapper around the beans
EventSetDescriptor that also holds all of the relevant
methods as children.The grounding a handler editor needs to power its "Ask AI" assist.
Provides AI groundings for the Scripting surfaces for following stages:
Implemented by a handler editor that wants an "Ask AI" assist on its editing surface.
Contains full configuration required to start an Event Stream
Manages the configuration of an event stream.
Various metrics that can be retrieved from Stages
Outcomes a previewing run reports that a caller may need to recognise.
Contains all Stages provided by Ignition
Context specific to an Event Stream
What every design-time delegate registered against a source / handler type has in common: its
type key, and the editor it builds for that type.
Contains diagnostics data for an Event Stream and all it's included stages
Curates and publish diagnostics information about an event stream at 1 sec intervals.
Builds the
DiagnosticDigestGenerator for the gateway's Event Streams subsystem, which
produces two digests: a cheap summary and a deeper analysis.The two tools the digest's analysis agent calls against live event-stream state:
find the stream and read that stream.Class is used to ensure uniformity of method definitions in
ViewModels.Converts between data types.
Local message bus for sending messages to
GatewayEventSourceExpression used in
EventStreamHandler for extracting data and metadata from EventPayload.Creates an
EventStreamExpression from ExpressionValueThe
EventStreamExpressionFactoryProducer class is responsible for producing instances of
GatewayEventStreamExpressionFactory, which facilitate the creation and management of
event stream expressions in the Ignition framework.Handles events from Event Streams.
Registered with
EventStreamRegistry to create concrete implementation of EventStreamHandler from the provided configuration.Produces EventStream lifecycle events to registered
ResourceLifecycleEvent.CallbackContains all registries used to build an
EventStreamGeneric registry based on String key and type T
Configuration for running a one-off Event Stream, mainly used for test runs in Designer.
Utility class that attaches a shared "Ask AI" toolbar button to an Event Stream script-editing
surface.
Provides
EventPayload to the Event Stream through the EventStreamSource.Subscriber interface.Registered with
EventStreamRegistry to create concrete implementation of EventStreamSource from the provided configuration.Interface for submitting events to the Event Stream.
Represents the current state an Event Stream
This class tracks the state of the event stream as reported by the Gateway, by using the
You can add listeners to this class to get notified when states change via
EventStreamPushReceiver.You can add listeners to this class to get notified when states change via
EventStreamStateTracker.addListener(EventStreamStateTrackerListener).This class is responsible for synthesizing the
SubtextStateInfo, and updating the EventStreamSubtextStateSynthesizer.stateInfo property.A scripting stage whose Jython body an AI assist can be mounted on, and the key both halves of
the grounding are looked up by: the framing string via
EventStreamAiGrounding.callerContextFor(EventStreamSurface), and the on-demand sample tool via
EventStreamAiGrounding.sampleToolFor(EventStreamSurface).Class facilitates the creation of events
Note: Adding methods to deal with Events specifically, as timestamp collisions seem to be common
-Mitch
Provide an example value for a field.
An adapter interface that supports drawing
Workbooks and Sheets based on the
supplied objects.The known types that can be directly set via Apache POI for a cell.
This class provides a Swing UI panel to inform users that an exception was hit and send info back
to ReportMill.
This class provides a Swing GUI panel to inform users that an exception was hit and send info
back to ReportMill.
A class to hold a bunch of Exceptions.
Central manager for all asynchronous and scheduled tasks
Generates private execution engines that can be used to schedule tasks.
Queues up submitted
Runnables and executes them in serial on an ExecutorService.Queues up submitted
Runnables and executes them in serial on an ExecutorService.Provides intellihints for "expandables" - custom properties in UDTs that can be referenced by
fields in contained tags.
Provides intellihints for "expandables" - custom properties in UDTs that can be referenced by
fields in contained tags.
This class provides support for expanding and collapsing rows in a
JTable.Action that will collapse all panes of a collapsible pane palette
This renderer has a cell that when collapsed shows texts truncated to fit on one line, when
expanded will show the entire text.
This renderer has a cell that when collapsed shows a title text.
Deprecated.
An expression is something that can be executed to compute a result.
Provides actions for expression-related UI components.
Used to create side-bar actions for expression editors
A Perspective
Binding for Ignition Expressions.BindingFactory for Perspective ExpressionBindingsExpressionParseContext for Perspective ExpressionBindings.TagListener for Perspective ExpressionBindings.An ExpressionDrivenStringValue is a
ExpressionDrivenValue with type String.An ExpressionDrivenValue is a
LockGuardedDrivenValue driven by a PerspectiveExpression.Links the enabled state of an action to the visibility property of a component.
This editor supports two forms of operations: building full expressions, and building simple
strings with references to items.
A right-click menu that fills in operators and functions for an expression editing text area.
Item selection handler that places the selected item directly into the code editor
Thrown during expression parsing or execution when an unrecoverable error occurs.
A text field that displays a popup expression editor
This interface is used in conjunction with the
FunctionFactory, but provides the
functions to add new expressions.Content panel for Expression mode with its own component instances.
A query path panel that uses an expression editor for dynamic path specification.
A
SlidingPane which toggles
between an AbstractCRUDTable of type ExpressionParam and a CodeEditor which is visible when an
expression cell from the table is edited.Passed to the ELParser to help it create Expressions that have dynamic implementations.
Extension interface for expressions so that we can try and knit together the sources of what's
triggering what to prevent loops.
An ExpressionStructureBinding is a
Binding where a given JSON document of any shape /
size will have all its string value leaf nodes interpreted as expression sourcesTable will display a key/value pair with the value portion handled by an expression editor.
An
ExpressionBindingParseContext which additionally wraps a ConstantExpression
and a Predicate which returns true if the path in the bound Expression should
delegate to the ConstantExpression.Expression, SQL and Named Query tags are all just flavors of Memory tags.
Use with expression tags to be able to pass the expression tag's path, needed to locate actual
tag paths to relative tag locations.
Represents a field that can be either a static string or standard expression.
Control switches between TextField and ComboBox.
Validator that checks that an
ExpressionValue is not null or blank.Validator that checks the syntax of an expression using the provided
ExpressionValueSyntaxValidator.ExpressionChecker.Interface for checking the syntax of an expression to see if it's valid.
Component works with
ExpressionValue.Component works with
ExpressionValue.Extendable objects are complex objects that know how to deal with extensions, in the sense that
one definition of the class will add additional details on to the same type of class.
Created by colby.clegg on 3/7/2016.
Allows cloning a
Document without having to create a deep copy of all it's elements.Allows cloning a
DocumentArray without having to create a deep copy of all it's elements.In this case, "extended inheritance" means there are 2 or more levels of parent-child, i.e.
A property set that actually consists of two sets- a local one, and it's "parent".
com.inductiveautomation.ignition.common.config.ExtendedPropertySet
com.inductiveautomation.ignition.common.config.ExtendedPropertySet
Protobuf type
common.protobuf.CustomTagTypePBProtobuf type
common.protobuf.CustomTagTypePB
com.inductiveautomation.ignition.common.sqltags.model.types.ExtendedTagType
com.inductiveautomation.ignition.common.sqltags.model.types.ExtendedTagType
com.inductiveautomation.ignition.common.sqltags.model.types.TagType
com.inductiveautomation.ignition.common.sqltags.model.types.TagType
An 'extensible' component simulates the idea of subclassing a component in the Vision runtime by
exposing a set of methods that may be implemented in Python.
An extension function is a Python script that can be used to extend the functionality of a
component.
Describes an extension function that a component may call during it's lifecycle.
An argument for an extension function.
Handles the execution of a message handler script defined as an extension function.
An "extension point" is a category of configuration that can have many flavors.
Represents the role of various kinds of React components to use for the extension point.
Represents a collection of extension points of a particular category.
Represents an extension point resource's configuration, with its associated profile configuration
and type-specific settings configuration (if any).
All extension point "profile" config objects must inherit from this interface, because the one
mandatory field is the "type" field, which is used to identify the specific type of the extension
point.
This ResourceCodec is used to encode and decode ExtensionPointConfig objects, which are pairs of
a "profile" object and a "settings" object.
Describes a form that can add/edit a specific extension point resource type
One registered flavor of an extension point config type, such as a single kind of alarm
notification profile within the alarm notification category.
This validator doesn't actually do any validation, it is just a way to "extend" the schema system
with arbitrary information attached to schemas.
Record class that represents an OpenAPI External Documentation
Object
This class represents a change event for when the 3rd party scripts have changed.
Configuration for an extra attribute that should be retrieved from LDAP and stored on the user
object under the specified property.
A DefaultTreeCellEditor that only starts editing on F2 and not on click-and-wait 1200ms or on
triple-click
This is used to wrap the popup buttons to allow for both rollover and fade animations.
This is used for animations with JDesktop's property setter Holds the background, foreground,
icon color for a component at a specific key frame.
Filename: FadingHighlight.java Created on Apr 22, 2014 Author: Kathy Applebaum Copyright
Inductive Automation 2014 Project: Ignition
Created by Colby.Clegg on 12/14/2015.
A
PointStorageStrategy decorator that routes points its delegate failed to store to a
FailureHandlingStorageStrategy.StorageFailureHandler.Policy for points a delegate strategy failed to store, invoked once per failed flush with the
failedData() of a FAILURE, PARTIAL_FAILURE or EXCEPTION result
and the failure reason.A
PropertyResolver that first checks a delegate property resolver, if defined, and then
on failure simply creates a new Property<Object> using the provided id and returns it.A JPanel that displays a 'fancy' header at the top, which consists of an icon, text, and a
gradient color background.
Represents stages that will never be able to process events.
This class provides a Swing UI panel to send feedback back to ReportMill.
The FetchableCache is a place for perspective component model delegates to place downloadable
data (named "fetch"-able after the invalid input: '<'a
href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API>Fetch API) for their
front-end counterparts to fetch in the near future.
A field defines the particular source of data that a condition would apply to.
A field defines the particular source of data that a condition would apply to.
This border delegates to the UIManager's "TextField.border" border.
Assembles text in the canonical
Key: value shape — one key: value line per field
in the order it is added.Strips characters that are invalid (to the filesystem) on common OSes.
PromptAssist that exposes the project's file-resource tree through the @-popup.Per-resource HTTP exposure configuration for a file resource.
Constants for the platform-level file resources feature.
Editor for a file resource.
Agent for the File Resource Editor.
Static helpers for working with file resource content: classifying a content type as textual, and
keeping a resource's data key aligned with its leaf name.
Designer workspace for file resources (RFC-31).
A data source to read/write data and files to a file system.
This source reads events from a file and forwards them to the event stream.
Builds a
FileId -> FieldFileEntry lookup from a Perspective form submission JSON payload.Pairs an owning field id with the user-facing display name for a single file.
This is the event object for the route to post to the page's gauva event bus, to get picked up
by this delegate.
This is the event object that will be passed to the `onFileReceived` actions.
Contains a few static file-related functions that were ported from the FactoryPMI-provided
FPMIFileUtilites class for general use in the SR Designer
Functions for file system access, exposed as system.file.*.
Represents the types of file watch events which may occur
Simple layout manager fills all components to the size of the parent
What an aggregated key's window gets when its calculation leaves it without a value.
Protobuf type
common.protobuf.FillModePBProtobuf type
common.protobuf.FillModePBA Filter is used by the row selector panel.
A filter contains multiple conditions, and operates on a type of object.
A filter contains multiple conditions, and operates on a type of object.
Created by carlg on 10/20/2016.
Configuration required for filtering
This class wraps a StreamingDatasetWriter, and allows us to specify indexes or column names (case
insensitive) that will be filtered from the underlying dataset.
Contains logic for filtering, searching, sorting, and paging through a set of objects.
Used by routes that want to support LHS-style filtering, paging, searching, and sorting query
params like:
Filters events based on return value (True, False) from user's script.
An editor that uses a non-editable combo box displaying a list of pre-canned items
General purpose wrapper around an int that lets you easily work with numeric flags.
Flattened JSON Serialization representation of a JsonWebEncryption object.
A sealed interface representing a container of flavors.
This is the UI for the script editor that appears as a floating frame
Class is responsible for managing the
FlowCellRenderComponent instances for a given list
of FlowCells.A layout that puts children one after another, wrapping when needed.
This class provides UI editing for shapes with FlowLayout.
A reading of the flushes a buffering
PointStorageStrategy has completed, over a sliding
window of recent flushes.Configuration class for Font Assets.
Interface which exposes methods for retrieving
fonts and information
about the fonts (such as the font name, font style, and font type)This class is a Swing/Ribs Font panel for selecting fonts.
This class is a Swing/Ribs Font panel for selecting fonts.
This class provides UI for showing the formatter from the currently selected shape and editing or
changing it.
This class provides GUI for showing the formatter from the currently selected shape and editing
or changing it.
A TableCellEditor that can handle numbers and dates using a formatted text field.
This expression type is actually a wrapper around another expression, which is expected to
produce a number.
A simple delegating expression parse context that detects the presence of a format string defined
by a pipe "|", such as {Property|#.00}, and creates a wrapped expression that executes
the formatting.
A class to build a form.
An annotation to include the "x-form-category" property in the schema for a field.
An annotation to include the "x-form-category" property in the schema for a field.
An annotation to include the "x-form-field-settings" property in the schema for a field.
An annotation to include the "x-form-field" property in the schema for a field.
An annotation to include the "id" form setting in the schema for a field.
This is the event object for the route to post to the page's gauva event bus, to get picked up
by this delegate.
This is the event object that will be passed to the `onChange` actions when there are files
attached to this event.
This is the event object for the route to post to the page's gauva event bus, to get picked up
by this delegate.
This is the event object that will be passed to the `onSubmitActionPerformed` actions when
there are files attached to this event.
An annotation to include the "x-form-field-settings" property in the schema for a field.
This template makes a basic form letter.
Defines all the known form setting keys.
The class used behind the data model for the "Form Submission Event" and "Offline Form Submission
Event".
Represents a tab for editing form submission handler scripts.
A transaction for forwarding persistent data to a sink / store.
Vision Layout constraints object, used with FPMILayout to hold the "layout constraints" (LC) of a
component.
Javabean-style class used for the shutdown allowed script
Adds the client-only "refresh" function to system.vision
These are the file utilities that have a GUI element.
Deprecated.
Use VisionModule instead.
Adds overlay functions to the system.vision scripting library
Each window in the Vision module is an instance of this class.
A
BiConsumer which can throw a ThrowableA
BiFunction which can throw a ThrowableRepresents a supplier of results which may throw a
ThrowableAn enumeration of the supported methods for presenting the authentication challenge UI
A
JsonSerializer and JsonDeserializer implementation for serializing and
de-serializing FramingOption objects to / from JSON using GSON APIs.Most of what was in this class was moved to TagFunctionFactory.
Filename: FtpAction.java Created on Apr 13, 2015 Author: Kathy Applebaum Copyright Inductive
Automation 2015 Project: Reporting
Filename: FtpActionConfig.java Created on Apr 13, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: FtpActionPanel.java Created on Apr 13, 2015 Author: Kathy Applebaum Copyright Inductive
Automation 2015 Project: Reporting
A function is used by the FunctionExpression.
A factory for looking up and managing expression functions.
This interface provides a level of indirection to the execution of compiled python objects
against the script manager.
Function-based (type 1) shadings x,y values in shading space are just passed to the function and
the returned color value is plotted.
This class provides UI for showing an RMParentShape and allowing drag and drop from it.
This class provides Swing UI for showing a RMDocument and allowing drag and drop from it.
An inner class and RMViewer subclass for showing and dragging shapes in an RMDocument.
An inner class and RMViewer subclass for showing and dragging shapes in an RMDocument.
Essentially a holder for a list of browsables that fires a change event when the list changes.
Adds ability to send messages through GAN.
Created on 4/21/15.
Created by mattg on 4/3/15.
Represents an Http URL, with the various segments split up.
Holds the HttpURL addresses for up to two gateways - a master and a backup
Gateway-scoped facade for AI features.
Implemented by the AI module's
GatewayModuleHook so the platform can discover and obtain
a GatewayAiContext without taking a compile-time dependency on the AI module.The user does not have sufficient authorization for a given project operation (save, create,
etc.)
Read-only AI tool surface over the connected gateway's configuration system: which config types
exist, what one type is for, which resources it holds, and how one resource is configured.
This record contains the context required for
GatewayConnection instances.Builder class for customizing a new instance of GatewayConnectionContext using a fluent-style
API.
Deserialize for
AuthChallenge that can polymorphically distinguish SimpleAuthChallenge and ADSSOAuthChallenge instances.The GatewayContext is the main interface to the Ignition Gateway.
Simple abstract decorator for
GatewayContextThis registry holds the types of report data sources usable in the gateway for generating
reports.
This handler sends events to a
GatewayEventSource, through the EventStreamEventBus.Represents a node for gateway event scripts in the navigation tree.
project and path are populated at time of source creation, so resource
doesn't need to store any fields.This little helper class makes it easier to implement polling gateway function logic within a
component.
This class is the gateway hook for loading into the Ignition platform.
The Gateway Logging Manager extends the logging manager to provide the idea of monitoring
sessions, which can be used to collect specific sets of logs for a short amount of time.
Represents a module that is loaded in the gateway.
The main hook into a module's gateway scope.
Created by colby.clegg on 3/23/2015.
Use with WSChannelSettingsResource to get or set various gateway network properties.
Sentinel
recordType of a ParameterSchema decoded where the original params class
is unavailable, such as the designer decoding a gateway-specific type like
StatsAggParams.The GatewayProgressManager is used to execute tasks on the gateway that might take a while.
Provides a run function that can return a value and throw an exception.
This interface is used to provide the Gateway with the necessary information to handle RPC calls.
The Gateway half of the negotiation of RPC payloads between the gateway and clients/designers.
Keeps track of registered
StepFactorys.Use with the SystemPropertiesManager to get or set various gateway system properties.
This class is the link between tags in the client and tags in the gateway.
This ClientTagProvider is used when the default tag provider is not set on the project.
Keeps track of registered
TransitionFactorys.This class choose an OPC item by browsing through a SQLTags provider.
File that holds General Properties for the Vision client.
Created by carl.gould on 6/8/2015.
Protobuf type
common.protobuf.GenericObjectPBProtobuf type
GenericObjectPBProtobuf type
common.protobuf.GenericObjectPBProtobuf type
GenericObjectPBA utility class that provides methods for converting between
GenericObjectProto.GenericObjectPB objects and
other types of objects.Filename: GenericRoleValidatedField.java Created on Oct 02, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Ignition
This is a general exception that can be used to transfer error information across RPC.
Created by carl.gould on 6/30/2014.
A serialized property resource that is defined by the framework itself, and holds some of the
core project properties.
Represents a glob-style pattern that can be used to match and validate paths.
Represents a segment type in a segment-based tag path.
A JComponent subclass that can be installed as the glass pane of another component, to help show
the regions that get repainted.
This wizard subclass is used to create a simple table.
This class provides RMEditor inspector support for RMGraph.
This class provides RMEditor inspector support for RMGraph.
Special version of ruler that counts grid cells for SFCs, rather than pixels.
Deprecated.
Wrapper class for a TagGroupConfiguration, used to track name changes and display it in a config
list
Record class that represents a Group object.
A group task is listener for timing events from a tag group.
Adapts Gson's
LazilyParsedNumber to an appropriate Python numeric type (Long or Double)
by parsing its string representation.An extensible Jython object adapter for converting Gson JSON elements (JsonObject, JsonArray,
JsonPrimitive) into Jython-friendly structures.
A ResourceCodec that uses a Gson instance to directly encode and decode resources.
The field or method that this annotation is attached to can only be accessed when holding a
particular lock.
Handler configuration
Defines how to handle Handler failures
Determines how retries are attempted
Metrics:
{}.handler-{index}.received (Meter): Total events received
{}.handler-{index}.processTimeNs (Histogram)
{}.handler-{index}.errors (Counter)
Event emitted by the agentic harness at the natural boundaries of its tool-calling loop.
Emitted when the model returns prose alongside the tool calls it is requesting.
Emitted when the model's response includes a reasoning trace.
Emitted when a typed
AgenticHarness.send(String, Class) rejected a reply and asked
again.Emitted when a chat response stopped because it hit the model's output-token limit (finish
reason
LENGTH); its final text, or a tool call's arguments, may be cut off.Emitted when the sub-harness opened by
HarnessEvent.SubagentStarted returns, carrying its final
response (or error message) so consumers can close out the subagent scope.Emitted by
spawn_subagent immediately before its sub-harness starts running, so
downstream consumers can scope subsequent events to the subagent.Emitted after a chat response that reports token usage, carrying the input and output tokens
billed for that one call.
Emitted after a tool invocation completes successfully.
Emitted when a tool invocation throws.
Emitted when the model requests a tool invocation, before the tool runs.
Emitted when the conversation turn opened by
HarnessEvent.TurnStarted completes, carrying the
model's final text reply.Emitted at the start of each conversation turn, immediately after the user's message has been
accepted but before the first request is sent to the model.
Emitted at most once after each
HarnessEvent.TurnFinished, reporting how full the orchestrator's
conversation is as of the request that produced the final reply.Immutable snapshot of one
AgenticHarness as of the moment its context's harness registry
was read.Lifecycle state at the moment the snapshot was taken.
A record that pairs an original source key with its computed hash based on a
KeyHashRule.Just a JLabel that uses BOLD, 11pt font
A titled border that uses the Designer's bold 11-font label as a title, and no border.
Helps to gather named metrics from the registry into a collection of IdentifiedHealthCheckResults
Library of utility methods useful in dealing with converting byte arrays to and from strings of
hexadecimal digits.
Hides a field from being discovered by the reflective schema builder found at
SchemaUtil.fromType(Class, Consumer)Put this annotation on a type to hide properties you don't want from your superclass(es)
A historian: a named, configurable provider that owns a storage engine and/or a query engine for
historical data, with a startup and shutdown lifecycle.
Gson type-adapter registration for the binding-config types.
Historian traits the binding picker sets on a
BrowseFilter before the historian browse
RPC.Constants and helpers for historian logging and metrics: logger names for the historian
components, query and storage metric keys, and builders for dynamic metric keys.
Hides parameters a scripting function accepts but does not document:
browse's
snapshotTime, and includeBounds on queryRawPoints and
queryAggregatedPoints.Extension point through which a module supplies a historian provider: it names the type and
creates the
Historian from its resource configuration.Protobuf type
common.protobuf.HistorianLocalizedStringPBProtobuf type
common.protobuf.HistorianLocalizedStringPBGateway-wide access to historians: their names and engines, and multi-engine queries.
Base gateway module hook for modules that provide historian functionality through the
HistorianManager.Converts historian model objects to and from their Protocol Buffers messages.
The extension-point profile configuration that identifies a historian provider by type.
Top-level config of the
historian.query Perspective binding, persisted in the view JSON.One entry of a
HistorianQueryBindingConfig.EngineQuerySection.Aggregated data-point entry: the aggregate identity, optional aggregate parameters, fill,
interpolation and constant.
Annotation entry: filters by
AnnotationFilter on author and type, with no aggregation.Metadata entry; an empty
metadataKinds list means all kinds.Raw data-point entry: streams atomic points with no aggregation or fill.
Executes one fetch for the
historian.query Perspective binding, in process.The outcome of a fetch: the envelope, the per-key terminal timestamps for cursor advancement,
and a closer for STREAMING resources.
RPC functions the Designer and clients call on the gateway historian module: browsing, queries,
aggregate catalogs and stores.
Supplies the
ProtoRpcSerializer configured with the binary adapters for every type the
historian RPC functions exchange.Marker for the settings classes of a historian.
Base column type for historical column values.
Deprecated.
Deprecated.
since 8.3.0
Deprecated.
A versioned node in a historian: uniquely identified, with a source path, an optional data type,
a creation time, and an optional retirement time.
Identity of a
HistoricalNode.A
PathTree of HistoricalNodes keyed by QualifiedPath, with recursive
removal that also removes parent nodes left without children.The versions of one node identity, sorted by created timestamp ascending, with lookups by exact
created timestamp and by point in time.
Protobuf type
BasicHistoricalRecordPBProtobuf type
BasicHistoricalRecordPBProtobuf enum
ColumnTypePBProtobuf type
HistoricalColumnPBProtobuf type
HistoricalColumnPBA sink that stores historical records to a datasource.
This interface defines a piece of history coming from a tag, and is used by the history storage
system.
Deprecated.
Protobuf type
common.protobuf.AdHocPythonAggregatePBProtobuf type
common.protobuf.AdHocPythonAggregatePBProtobuf type
common.protobuf.AggregateInfoPBProtobuf type
common.protobuf.AggregateInfoPB
Proto3 cannot distinguish an absent enum from value zero, so zero is a sentinel no producer emits.
Protobuf type
common.protobuf.AggregatePBProtobuf type
common.protobuf.AggregatePB
Legacy discriminator, still read by 8.3 gateways.
Protobuf type
AnnotationPBProtobuf type
AnnotationPBProtobuf type
AnnotationsPBProtobuf type
AnnotationsPBProtobuf type
BatchedHistoryDataPBProtobuf type
BatchedHistoryDataPBProtobuf type
DataBytesPBProtobuf type
DataBytesPBProtobuf type
DataTransactionPBProtobuf type
DataTransactionPBProtobuf enum
DataTypePBProtobuf type
FlavorPBProtobuf type
FlavorPBProtobuf type
HistoricalTagValuePBProtobuf type
HistoricalTagValuePBProtobuf type
HistorySetPBProtobuf type
HistorySetPBProtobuf enum
InterpolationModePBProtobuf type
MetadataPBProtobuf type
MetadataPBProtobuf type
RetirementTagsPBProtobuf type
RetirementTagsPBProtobuf enum
TimestampSourcePBProtobuf type
ValuePBProtobuf type
ValuePBA TagDropHandler that is meant to bind to components that can display dataset-based history.
Deprecated.
How historical data should be treated.
Deprecated.
use the Historian
QueryEngine pipeline.Utility class for serializing and deserializing common historical objects.
A panel that simply holds some other panel, using a filling layout.
Similar to the
VerticalScrollingFlowLayout, this layout will lay out objects
top-to-bottom, and then left-to-right in a way that is compatible with scroll panes.An interface for components to listen to whether or not they're being hovered over.
This class is an overly complex way to do something that you think should be simple.
The HSLColor class provides methods to manipulate HSL (Hue, Saturation Luminance) values to
create a corresponding Color object using the RGB ColorSpace.
Created by colby.clegg on 11/12/2015.
A SnapFile for HTML files.
Convert an HTTP header to a JSONObject and back.
Implementation of the Perspective HTTP Binding.
Configuration for the HTTP handler.
Enum representing the various methods allowed by HTTP.
A class to represent an HTTP request and generate a response.
A class to hold headers.
A class to represent an HTTP response.
A WebSite for HTTP sources.
The HTTPTokener extends the JSONTokener to provide additional methods for the parsing of HTTP
headers.
Param class that contains everything needed to execute an HttpBinding's value execution in a
hashable way suitable for use as a key in
ValueCacheRepresents an Http URL, with the various segments split up.
Filename: HttpUtils Author: Perry Arellano-Jones Created on: 8/14/15
A basic utility for calling restful web services that return JSON from IA's website
This class is simply a means of adding the ICEPDFViewer to the classpath to allow seamless
upgrades in Ignition 7.8.
Simple label based button made to work with a
VectorIcon whose color is set to null (and
thus inherits the component's foreground color) in order to provide rollover indication.Interface which exposes methods for retrieving Icon Libraries (as SVG Strings) and information
about the Icon Libraries (such as the icon names within an Icon Library)
For a given component, trailing icons can be set.
A pair of an ID and a health check result.
A pair of a name and a metric.
The ordered project Identity Provider list.
How an entry naming a provider the gateway doesn't have is marked.
An ordered list of a project's Identity Providers.
Immutable meta information about an Identity Provider
Deprecated.
This class should only be used for special migration related purposes only.
Picker that lets the user choose one or more Identity Providers (by name) to add to an
IdentityProviderList.Represents a "design tool", which is a mode that the design panel can be in.
This class puts up the IdP Login splash screen.
Indicates an exception that is really a transparent facade over another interface.
Retry strategy applied to Ignition's HTTP clients.
Redirect strategy applied to Ignition's HTTP clients.
Created by carl.gould on 7/14/2015.
Ignition's very own version of the infamous SwingUtilities class.
Overrides the
SynthButtonUI and performs some additional checks on the component state to
ensure that the correct foreground color is set on the Graphics object before painting
the buttons text.Deprecated.
A grouping of settings getters to avoid littering AbstractDesignableWorkspace with these
preferences.
An IHandle represents a draggable control used to manipulate a component.
A class implementing the ImageFactory interface knows how to create java.awt.Image classes for
the various formats supported by PDF.
A class implementing the ImageFactory interface knows how to create java.awt.Image classes for
the various formats supported by PDF.
The ImageLoader is the main interface for the images stored in the Gateway.
Fills the area with a solid fill at some transparency level.
Record type that represents an image resource.
Provides Swing UI for RMImage shape editing.
The base interface of all menu and toolbar merging classes
A tagging interface to mark exceptions that should only display their message - not their entire
stack trace.
A singleton
PointStorageStrategy that stores atomic, complex and change points
immediately and synchronously through the supplied storage functions, returning completed CompletionStages.The class this method is attached to is immutable.
An immutable collection of extension points.
Created by carlg on 12/29/2016.
com.inductiveautomation.ignition.common.resourcecollection.ImmutableResource
com.inductiveautomation.ignition.common.resourcecollection.ImmutableResource
Protobuf type
common.protobuf.ResourceAttrMapEntryProtobuf type
common.protobuf.ResourceAttrMapEntryProtobuf type
common.protobuf.ResourceDataMapEntryProtobuf type
common.protobuf.ResourceDataMapEntryAn immutable
StorageStrategyMetrics snapshot holding the queued count and oldest dwell
directly.An immutable, thread-safe implementation of
TranslationPackage.GSON adapter that serializes in the same wire format as
BasicTranslationPackage for
backwards compatibility with existing clients.Provides metadata about the source gateway from a
.gwex file's exportinfo.json.Deprecated.
Contributes standalone content (not tied to a specific resource type) to the gateway
import/export system.
Reads content data from the
.gwex ZIP for this contributor.Writes content data to the
.gwex ZIP for this contributor.A selectable sub-item within a contributor.
Delegate that controls how a resource type participates in the gateway import/export system
(
.gwex files).A resource entry bundling the resource, its decoded configuration, and the collection it
belongs to (or is being imported into).
Pairs a
ResourcePath with the collection it was found in within the .gwex ZIP.Module-author SPI for the gateway import/export system (
.gwex files), reachable via
GatewayContext.getImportExportManager().Describes the contents of a parsed
.gwex file as it would apply to the receiving gateway.A group of config resources sharing a
ResourceType.A contributor entry present in the
.gwex.Project conflict reasons.
A project present in the
.gwex.Config resource conflict reasons.
A single config resource entry from the archive.
Marker interface for a
TagActor that must continue receiving observeValue calls even while the tag provider is NOT redundancy-active (standby node).Parent interface to coordinate the functions between NavUtilities and NavUtilitiesDispatcher
A concrete subclass of GlyphMapper for the Identity-H invalid input: '&' Identity-V maps input bytes -> cids is
done with no mapping, just interpreting the bytes as big-endian shorts.
Represents either a string portion of an indirect tag path, or a reference index part
An InfoBar is the bar that slides down from the top of the Client to notify users of something,
like a new version of the project is available.
Note: This class should be the last class added to the painters list of the AttributeTextPane.
A browse tree node that has info retrieved from the gateway.
Record class that represents an OpenAPI Info Object
What a running historian's ingest has been doing: the rate points are stored at, joined with the
shape of the flushes storing them.
A metered rate over the 1, 5 and 15 minute exponentially weighted windows.
Represents the inheritance relationship between two types (described as "type A" and "type B" in
relation to the values).
Used to indicate a preferred size for a newly created component.
A double-click handler that implements in-place editing for components that want text
editability.
This action, which needs to be initialized with a text component, will show a dialog box
prompting the user to find a historical tag.
This action, which needs to be initialized with a text component, will show a dialog box
prompting the user to find a tag.
Like java.awt.Insets, but with double precision
Created by carl.gould on 4/20/2015.
This class is responsible for the Swing UI associated with the inspector window.
This class is responsible for the Swing GUI associated with the inspector window.
Renders a markdown listing of every Ignition module currently installed on the connected gateway,
suitable for injection into an AI agent's system prompt via
Agent.getAdditionalContext().Detached validator for parsed AI Multi-instance Wizard UDT-instance plans.
One validation message for the full plan.
Severity levels surfaced to the suggestion renderer.
Validation result for a parsed plan.
Created by carl.gould on 6/17/2014.
Agent for the standalone AI Multi-instance Wizard planning surface.
Composes the AI Multi-instance Wizard's current planning context into one assistant message.
Parsed inner payload from a
ResponseEnvelope.Suggestion#value() string for the AI
Multi-instance Wizard.Non-throwing parse result for renderer and validator entry points.
Renders AI Multi-instance Wizard assistant replies and exposes a gated local Apply Plan action.
Callbacks used by the renderer to validate and accept a parsed local plan.
Controls binding interaction and other adapters for a hierarchy of components.
An Interaction Descriptor represents an inter-component dependency relationship.
An interaction listener is something that listens to one or more children that can change, and
when they do typically the interaction listener needs to re-evaluate something involving all
children.
An icon that can display different states depending on interaction
Properties for the internal authentication profile.
Configuration for contact information for a user.
Used for some features that depend on the specific internal db flavor.
Represents a role in the internal user source.
Represents a schedule adjustment on an internal user in the internal user source.
The internal interface to sessions used by the system to coordinate the lifecycle and inner
workings of the session with the communications from clients and designers.
A page visitor interface.
Represents an extra properties on an internal user in the internal user source.
Represents a user in the internal user source.
Builder for the
InternalUserResource class.This user source stores users, roles, extended properties, and contact info inside the internal
database.
Utility class for persisting internal users and roles to disk for
InternalUserSource
profiles.A text field that displays a popup parameter picker
How an aggregated key reads the signal between its samples, and whether its windows take edge
values.
Type 2 exponential interpolation functions.
Describes how values are interpolated/extrapolated in the history system.
Interpolates between values to provide a value at a specific time.
For analog tags, the value is ramps directly between the values
For discrete tags, the value is flat until it then changes, at the timestamp of B
Represents an intersection of PropertySets.
This is a helper for dealing with intersected models.
Basic subclass of JFormattedTextField that mimics the behavior of a PMINumericTextField set to
INT mode
Basic subclass of JSpinner that is specialized for ints
Thrown to indicate an invalid edit was detected
Thrown when an uploaded
.gwex cannot be parsed because its exportinfo.json is
missing, malformed, or has null required fields.Relevant only for Edge and Maker editions.
This is used to communicate the unusual case that a listener is no longer valid, and thus should
be removed from the list of listeners in the calling function.
This exception is used to indicate that the qualified path is not valid for the attempted use.
Instances of this class have two uses.
An interface that knows how to execute a query given a GatewayInterface
An object that listens for responses from the QueryManager for a registered query
Provides logic to check whether or not scripts are currently enabled.
This interface describes a class that can provide the IHandles needed to manipulate a given
selection.
An annotation to include the "x-form-category" property in the schema for a field.
Handler for a route that returns a list of items.
A search result item found by an
ItemSearchDelegate.Attached to the navigation model, this delegate is responsible for searching for items found at
the given page.
This is a specialized panel that essentially acts like a tabbed pane whose tabs are always on the
left hand side.
A validator (keyed off
items) that either defines a schema for all items in an
arbitrarily long sequence, or a validator with a fixed set of schemas - both the contents
and the number of those child schemas must match to be valid.An extremely simple interface that simple allows for "late" retrieval/calculation of a value.
A tagging interface to mark exceptions are purely used to wrap another exception, and should not
be shown themselves.
A ParseRule for annotations.
A WebSite subclass for Jar files.
A ZipFile.
Shapes should implement this if they draw themselves using Java2D.
A file object for managing Java files.
A class to manage dependencies.
This class acts as a 'bridge' between the Java and Javascript environments.
An
AbstractEditActionHandler for cut, copy, and paste handling of the JavaJsBridge.A parser for java files.
A class to hold some utilities for JavaParse package.
Helper class that invokes methods in the javascript side of the designer safely on a background
thread, turning the results into a CompletableFuture
A tokenizer for Java input.
A class to build components for JComponentShape.
JButtonHpr.
This class is the superclass for labels and buttons which handles attributes common to both
classes.
An RMShape subclass for JButton.
This class provides GUI editing for RJButtons.
An inner class to act as JButtonShape's Tool
An inner class to act as RJButtonShape's Tool
A JComponentShape for JCheckBoxMenuItem.
An RMShape subclass for JCheckBox.
This class provides Swing GUI editing for RJCheckBox.
Provides an inspector for JCheckBoxShape.
Provides an inspector for JCheckBoxShape.
A Java member for ClassOrInterfaceDeclaration.
This class represents a JFile class reference, so that classes don't have to be resolved until
the last moment.
A JMemberDecl for Initializers.
This class provides Ribs functionality for JComboBox.
This class provides Ribs functionality for JComboBox.
A combobox model implementation to handle binding.
A SwingEventListener for JComboBox.
An RMShape subclass for JComboBox.
A class to act as JComboBoxShape's Tool
An inner class to act as RJComboBoxShape's Tool
An anchorpoint that uses a jcomponent to define its hotspot.
This class is used to provide Snap UI functionality to Swing JComponents.
An abstract DesignableDelegate that implements many functions using the size/locations provided
by JComponent
A shape subclass for JComponent.
The base tool class for ribs tool.
A Java member for ConstructorDeclaration.
A JNode for Enum constants.
The JNode base class for Java expressions.
A JExpr subclass for Allocation expressions.
A JExpr subclass for ArrayIndex expressions.
A JExpr subclass for Cast expressions.
A class to represent a chain of expressions.
An class to represent expressions that include an operator (math, logical, etc.).
A ParseRule (and Handlers) for a Java Expression.
A JMember for Field declarations.
The top level Java part describing a Java file.
A ParseRule for parsing Java files.
Ribs Helper for formatted text field.
An RMShape subclass for JFormattedTextField.
Provides an inspector for JTextFieldShape.
Provides an inspector for JTextFieldShape.
A JExpr subclass for identifiers.
Filename: JideToolbarButton.java Created on Mar 03, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Ignition
A Java part for import declaration.
Created by carlg on 4/19/2017.
This helper implementation for JLabel.
This class is a simple RJButtonOrLabel subclass to support Ribs archival and to support Ribs
unified accessor model.
An RMShape subclass for JLabel.
This class provides a RM shape/inspector for editing JLabel.
This class provides a UI inspector for JLabelShape.
This class provides a UI inspector for JLabelShape.
An RibsHelper implementation for JList.
An RJHelper implementation for JList.
List Model implementation for lists of items.
Inner class to dereference the display value from list value using given key (from binding).
An inner class to describe a selected range (start, end, length).
A simple sample table model so Ribs app can show sample table data.
An RMShape subclass for JLists.
An RJShape for editing JLists.
Provides UI editing for JListShape.
A JExpr subclass for literals.
A parse rule subclass for JLiteral.
A JNode for type members: Initializer, TypeDeclaration, EnumDeclaration, ConstructorDeclaration,
FieldDeclaration, MedthodDeclaration, AnnotationTypeDeclaration.
Copyright (c) 2004 ReportMill Software, Inc.
A JComponentShape for JMenuBar.
A helper class for JMenu.
A helper implementation for JMenuItem (with specific support for subclasses:
JCheckBoxMenuItem,JRadioButtonMenuItem).
A RJHelper implementation for JMenuItem (with specific support for subclasses: JMenu,
JCheckBoxMenuItem).
A JComponentShape for JMenuItem.
Represents a menu merge for a JMenu.
A JComponentShape for JMenu.
This class represents a method call in code.
A Java member for MethodDeclaration.
The base class for all nodes of a JFile.
A base ParseHandler implementation for JNodes.
A Java part for package declaration.
An RMShape subclass for JPasswordField.
A tool subclass for JPasswordFieldShape.
Data object defining a JPMS module which requires --add-opens and --add-exports clauses due to
strong encapsulation of the JVM internals.
This class contains the correct logic for a component that wants to pop up a popup menu.
A helper class to add Ribs bindings to JPopupMenu.
A JComponentShape class for JPopupMenu.
Ribs Helper for JProgressBar.
An RMShape subclass for JProgressBar.
Provides UI editing for JProgressBarShape (and JProgressBar).
A panel that will contain a series of radio buttons.
A JComponentShape for JRadioButtonMenuItem.
An RMShape subclass for JRadioButton.
An inner class to act as RJRadioButtonShape's Tool.
An inner class to act as RJRadioButtonShape's Tool.
An RJHelper implementation for JScrollPane.
An RJHelper implementation for JScrollPane.
A JComponentShape subclass to represent a JScrollPane.
An RJShape subclass to represent a JScrollPane.
This class provides Ribs editing of JScrollPaneShape.
An inner class to act as RJScrollPaneShape's Tool.
This class provides a RM shape/inspector for editing JSeparator.
This class provides a RM shape/inspector for editing JSeparator.
Provides Swing UI editing for JSeparatorShape.
This class is a RibsHelper implementation for JSlider.
This class is a RJHelper implementation for JSlider.
An RMShape subclass for JSlider.
An inner class to act as RJSliderShape's Tool
An inner class to act as RJSliderShape's Tool
A JSONArray is an ordered sequence of values.
Created by carlg on 5/15/2017.
This is a label that knows how to monitor a json editor for errors.
Protobuf type
common.protobuf.tags.JsonArrayPBProtobuf type
common.protobuf.tags.JsonArrayPBProtobuf type
common.protobuf.tags.JsonElementPBProtobuf type
common.protobuf.tags.JsonElementPBProtobuf type
common.protobuf.tags.JsonObjectPBProtobuf type
common.protobuf.tags.JsonObjectPBThe JSONException is thrown by the JSON.org classes when things are amiss.
Just an ArrayList that will toString() into json.
This provides static methods to convert an XML text into a JSONArray or JSONObject, and to covert
a JSONArray or JSONObject into an XML text using the JsonML transform.
A JSONObject is an unordered collection of name/value pairs.
An
ElementExtractor over gson JsonElement trees: JsonObjects are the map
elements, JsonArrays are the array elements, and JsonPrimitive/JsonNull
are the primitives, converted to plain Java values by JsonObjectElementExtractor.toJava(JsonElement).Output shape of the
ResultWriterOptions.ObjectType.JSON sink.A property path represents a location in a JSON document.
Basic wrapper around a
JsonResourceCodecThis is the core of json constraint implementation.
Listens to document models in order to drive the visibility of DocumentNodes based upon their
schema and the "visibleWhen" meta-validator.
The
JSONString interface allows a toJSONString() method so that a class
can change the behavior of JSONObject.toString(), JSONArray.toString(),
and JSONWriter.value(Object).JSONStringer provides a quick and convenient way of producing JSON text.
A JSONTokener takes a source string and extracts characters and tokens from it.
Encodes byte[] objects as Base64
Standard json validator interface, implemented by all validators and JsonSchema.
Utility methods for working with
JsonWebKey and JsonWebKeySetJSONWriter provides a quick and convenient way of producing JSON text.
Implements Ribs bindings for JSpinner.
An RMShape subclass for JSpinner.
An inner class to act as RJSliderShape's Tool
An inner class to act as RJSliderShape's Tool
Ribs Helper for JSplitPane
An RMShape subclass for JSplitPane.
Provides Ribs representation for viewing and editing JSplitPanes.
A Ribs app tool for JSplitPanes.
A Ribs app tool for JSplitPanes.
This class is a utility class used to creating split panes.
The Java part to handle Java statements.
A Java statement for AssertStatement.
A Java statement for a block of statements.
A Java statement for BreakStatement.
A JStatement for Class declaration.
A Java statement for ContinueStatement.
A Java statement for DoStatement.
A Java statement for EmptyStatement.
A Java statement for statements that are just expressions.
A JStatement for for() statements.
A JStatement for if() statements.
A Java statement for LabledStatement.
A ParseRule for Java Statements.
A Java statement for ReturnStatement.
A Java statement for SwitchStatement.
A class to represent individual labels in a switch statement.
A Java statement for SynchronizedStatement.
A Java statement for ThrowStatement.
A Java statement for TryStatement.
A JNode for a catch block
A Java statement for LocalVariableDeclaration.
A Java statement for WhileStatement.
Represents the types possible in a JSON encoding.
A Helper for JTabbedPane.
An RMShape subclass for JTabbedPane.
An RMShape representation of JTabbedPane.
Provides Ribs UI editing for JTabbedPaneShape.
Provides Ribs UI editing for JTabbedPaneShape.
Represents a JTable TableColumn.
This class provides an inspector for JTableColumnShape.
An
EditActionHandler
for JTables which takes care of the basic Copy / Cut / Paste / Delete
actions.A Helper subclass for JTable.
This class is a JTable helper class to do some table management and archival for Ribs.
ListSelectionListener for table.
A simple sample table model so Ribs app can show sample table data.
A RMShape subclass for JTable.
A RJShape implementation for JTables in Ribs.
An RBTool implementation for JTableShape management.
An RBTool implementation for JTableShape management.
A helper for JTextArea.
An RMShape subclass for JTextArea.
Provides UI editing for JTextAreaShape.
An inner class to act as RJTextAreaShape's Tool
An
EditActionHandler
for JTextComponents which takes care of the basic Copy /
Cut / Paste / Delete actions.This class is a JComponentHpr subclass for JTextComponent.
This class is a RJHelper implementation for JTextComponents.
A shape implementation for JTextComponent.
A Tool for JTextComponentShape.
Helper for JTextField.
An RMShape subclass for JTextField.
Provides UI editing for JTextFieldShape (and JTextField).
An inner class to act as RJTextFieldShape's Tool
JToggleButtonHpr.
An RMShape subclass for JToggleButton.
Provides Swing UI editing for JToggleButtonShape.
An inner class to act as RJToggleButtonShape's Tool
This class is a simple JTree subclass to support Ribs archival and to support Ribs unified
accessor model.
This class is a simple JTree subclass to support Ribs archival and to support Ribs unified
accessor model.
An RMShape subclass for JTree.
Provides Swing UI editing for JTreeShape (JTree).
An inner class to act as RJTreeShape's Tool.
A JNode for types.
A JNode subclass for type parameters.
A JNode to represent a defined variable.
This class should only be called if JX Browser libs are on the class path.
Base class for the different action tabs of the event configuration UI.
Annotates a function added to the scripting system.
This class wraps a PyException, to force it to be caught (PyException is a RuntimeException)
A modern, non-blocking HTTP client for use in scripting (system.net.httpClient).
Provides meta-information about exceptions that a function exposed to Jython may throw.
Optionally annotate your class with this and all the rest of the annotations will have this key
base prepended to their i18n keys.
Components that require keyboard input should let this class know about it.
Created by carl.gould on 6/1/2015.
Text field for editing node keys.
The KeyedSerialScheduler class is a utility designed to manage the scheduling and execution of
tasks associated with distinct keys.
The class used behind the data model for the "Key Event" session events.
Panel that allows user to set the event mode, event binding config, event key modifiers, and
event options.
Represents a tab for editing key event scripts.
Defines the normalization rules for creating a search key from a source key.
Created by carl.gould on 5/8/2015.
Created by carl.gould on 5/8/2015.
This class shows the current set of keys relative to the current editor selection in a browser
and lets users drag and drop them to the editor.
This class shows the current set of keys relative to the current editor selection in a browser
and lets users drag and drop them to the editor.
This class shows the current set of keys relative to the current editor selection in a browser
and lets users drag and drop them to the editor.
Filename: KeysBrowserNode.java Created on May 12, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Created by carl.gould on 4/20/2015.
This class shows the current set of keys relative to the current editor selection in a browser
and lets users drag and drop them to the editor.
This class shows the current set of keys relative to the current editor selection in a browser
and lets users drag and drop them to the editor.
Gson adapter for serializing and deserializing
KeystrokeKey objects.Tab for editing client keystroke event scripts
The trigger configuration of a Vision client keystroke event script: the keystroke that fires it,
as the keystroke chooser edits it.
The style declaration classes support two different key encodings.
A useful meta-annotation that serves dual purposes:
If you are using a
PropertiesFileDocProvider, your
argument names and classes can be retrieved from this annotation.A
KeywordMap is similar to a hashtable in that it maps keys to values.Annotation for adding a string label to a Resource Schema objects.
This class is the superclass for labels and buttons which handles attributes common to both
classes.
A JComponentShape subclass for Labeled JComponents (JLabel, AbstractButton).
Provides base inspector UI for Swing Buttons and Labels.
Filename: LabelFormat Author: Perry Arellano-Jones Created on: 7/27/15 Project: ignition_dev_7_8B
A shared class that holds the size information about the format of a RMLabel.
Filename: LabelShapeConfigFactory Author: Perry Arellano-Jones Created on: 7/27/15 Project:
Reporting 3.0
Full-panel language picker.
Filename: LanguageSelector.java Created on Apr 24, 2014 Author: Kathy Applebaum Copyright
Inductive Automation 2014 Project: Vision
Filename: LanguageSelectorBeanInfo.java Created on Apr 24, 2014 Author: Kathy Applebaum Copyright
Inductive Automation 2014 Project: Vision
Message sent to the perspective client containing information about the localization terms
available for a language.
This source emits the last event that was emitted by a source.
Retains the last event each Event Stream's Source emitted, so a preview or a
LAST_EVENT Source
can replay it.Contains helpful functions for doing things...later! Every function here wraps up it's logic into
a runnable submitted to
EventQueue.invokeLater(Runnable)This class is used for processing tasks in the background, ensuring that only the latest task is
processed.
A LatinGlyphMapper is a concrete subclass of GlyphMapper that can handle the standard pdf
encodings that map single byte character codes from a named encoding, with possible modifications
by a Differences array.
A LatinGlyphMapper is a concrete subclass of GlyphMapper that can handle the standard pdf
encodings that map single byte character codes from a named encoding, with possible modifications
by a Differences array.
The interface that any class that want sto be launched by the bootstrap launcher must implement
Describes all of the jars, broken up by module, required for launching an application of a given
scope.
All of the pertinent info to start the Launcher
A panel that holds a splash panel suspended in the middle for when splash panels don't live in
their own frame.
A System Property reference which has its value set at instantiation.
Analogous to
LaunchSysProp.StringLaunchSysProp, but for Booleans.Analogous to
LaunchSysProp.StringLaunchSysProp, but for Integers.A system prop which has keys and legacy keys, but also has a companion "jvm" property which
should be set along with it.
Analogous to
LaunchSysProp.StringLaunchSysProp, but for Longs.A collection of system props which expect to have a 'list' of system properties which are in
the form of
{key}.{index}.The most standard form of a system property, whose value is simply a (nullable) String type.
A collection of System Properties used during bootstrap, especially in the case of a restart or
retarget.
This is a LayeredPane for use as a JRootPane's glass pane.
A JFrame with some helpers to open and center itself late
Represents an LDAP attribute in configuration.
Encapsulates lots of the boilerplate code required to connect to and query an LDAP server.
Adapts a tag history
Aggregate to AggregationType, so it can be used where an
AggregationType is required.Conversions between legacy tag history query flags and annotations and their Historian types.
Classes that implement this will be able to create a NamedQuery from their own config.
Meant as a last resort for when a Vision border specifies "com.incors.plaf.alloy.de", a class
that was used by the 7.x era Laf.
Same as PropertyRef, but allows spaces, so that an old reference containing spaces will attempt
to keep working on upgrade.
Code originally present in the ScanclassCSV class has been moved to here.
Deprecated.
for maintaining existing historians only.
All the system.tag functions that were formerly located in AbstractTagUtilities and
AbstractIALabsTagFunctions.
Our definition of levels, since there are many different versions defined across the different
frameworks.
Base class for
PromptAssists that browse a ScriptLibrary — a dotted-path tree of
script symbols — through the @-popup.The represents an Ignition license file
Represents the licensing details for a specific module
Record class that represents an OpenAPI License Object
Represents some license parameter.
Represents what license state a specific module is in, including any platform-wide license
details and the license details for the module in question.
Where the limit should go in the query.
The
LinearGradientPaint class provides a way to fill a Shape with a
linear color gradient pattern.Adds a linear regression pen to the EasyChart
Factory class for LinearRegressionPenDatasource
Represents the columns in the indicator dataset
Filename: LinearScaleTermFinder.java Created on Dec 09, 2013 Author: Kathy Applebaum Copyright
Inductive Automation 2013 Project: Vision
This class is responsible for removing the attributes for all text in the row where the user is
typing, and replacing them with the
A specific use of this class is for tag path validation.
AttributeSet provided in LineAttributeApplier.install(AttributeTextPane, AttributeSet).A specific use of this class is for tag path validation.
The RMGraph class provides a template and the machinery for generating graphs.
This class handles editing of rectangle shapes.
This class handles creation of lines.
This is a specialized selection controls which puts link handles on any chart element that is
dangling (not connected to the chart)
Created by carlg on 10/20/2016.
Utility class to adapt classic swing listener patterns to a more Java-8 style of code.
Static utility map to add map-like functionality to
Java.
A marker interface to distinguish the opc transferable dataflavor
Used for Dnd data flavors.
Carries a
List element by element, each element encoded as a TagValuePB by the
calling context.Helps build a
ReferenceProperty for a property whose value is an ordered list of
resource names (as opposed to ReferencePropertyBuilder, which handles a single scalar
reference).Given a JList that contains items that implements
ListTooltipSupport.ToolTipTexter.This column type provides a literal string that will be worked into the raw db query.
Deprecated.
This class contains the logic to implement the livechart feature.
An icon that displays an simple animation while something is loading
This class is a subclass of LoadingIcon that uses a (shared) java.util.Timer, and issues
repaintImmediately commands to the parent component on non-EDT thread.
It's a label that says "Loading..." with a little blinky thing.
This parse context results in expressions that only evaluate to strings, and do so in a way that
respects the provided locale, as much as possible.
Filename: LocaleChangeEvent.java Created on Dec 10, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: SRCommon
This is a split button that lets the user select one or more locales.
Provides a list of locales that can be selected, calls Locale.setDefault() when a selection is
made.
Utility methods for working with
Locale objects, including sorting and parsing.A class that represents a locale.
Local client fallback is a mechanism where a client tries to see if there is a gateway on the
local machine, and if so, automatically can retarget to that local gateway in the event of losing
it's connection.
Gateway-scoped access to the system's translation store: the set of localizable keys and the
translations defined for them across the gateway's available locales.
Defines static constants for localization message keys and updates.
RPC interface for managing localization settings, translation packages, and keyboard layouts.
This interface is used to provide a localized string representation of a class.
This class is used to render enum values for a list, in a localization friendly way.
A localized message that takes a bundle key and lazily uses BundleUtil to create its localized
message.
A label whose setText() function is overridden to take a bundle key instead of plain text.
A localized message that takes a bundle key and lazily uses BundleUtil to create its localized
message.
An exception whose message is a bundle key that gets resolved on a call to getMessage(), using
the current ClientReqSession's or web request's locale.
A special string container that holds a key, and returns the localized version of that key on
toString().
Protobuf binary adapter for
LocalizedString, using the HistorianLocalizedStringProto.HistorianLocalizedStringPB
schema.
com.inductiveautomation.ignition.common.i18n.LocalizedString
Protobuf type
common.protobuf.tags.LocalizedStringPB
com.inductiveautomation.ignition.common.i18n.LocalizedString
Protobuf type
common.protobuf.tags.LocalizedStringPBThis Gson adapter is used to serialize and deserialize LocalizedString objects for RPC usage.
A FileSite subclass that stores files in a named directory relative to SnapCode home directory.
Consumes a location, implying some navigation happened within the Designer.
A Location uniquely identifies a resource in the project (by
ResourceId), plus
some additional context in the form of simple string key/value pairs.Builder class to hold rendering information for a particular
Location for the platform.Functional interface-like to indicate this class is capable of updating a
LocationRenderingInfo with additional context for Location, which will uniquely identify
some element in the Designer.Specific kind of PushException indicating that a push failed because the lock acquisition timed
out.
A LockGuardedDrivenValue is a
DrivenValue which holds a lock object and asserts that
Threads which call LockGuardedDrivenValue.isReady(), LockGuardedDrivenValue.isDirty(), and LockGuardedDrivenValue.getAndClear() hold this
lock.A LockGuardedDrivenValueCollection is a
LockGuardedDrivenValue which provides
implementations for LockGuardedDrivenValueCollection.isReadyInternal(), LockGuardedDrivenValueCollection.isDirtyInternal(), LockGuardedDrivenValueCollection.startup(),
and LockGuardedDrivenValueCollection.shutdown() common to a managed Collection of DrivenValues.This is a general purpose representation of a logging event.
Created by colby.clegg on 5/5/2016.
This class is a wrapper around a logger which provides additional useful tools.
A
FailureHandlingStorageStrategy.StorageFailureHandler that logs failed points and discards them.This is our main filter in the logging system.
We can do 2 things: 1) set levels for specific property values (which bypass/ignore logger
levels) 2) set property filters, so that events only pass when the property matches.
Basic nominal tuple used as a return value for Designer and Client authentication.
An instance of this class is used to create the UI to log into the client.
Created by carlg on 3/17/2017.
Renders an image (from
resources/images/$path), centered over a branded background
gradient from bottom left to top right.Record class that represents an OpenAPI "Logo Object".
The Log Property registry is a simple collection of
LogPropertyDescriptors.A set of parameters for querying the logging system.
The results of a query to the logging system.
Implementation of EntityId that hold a long value.
bigint-shaped id used by relational Historians.This implementation of Connection doesn't actually store the AnchorPoint objects themselves,
instead, it stores the block ids and anchor point ids.
Main tile that is shown in the palette frame.
Platform-agnostic partition cadence used by
AbstractMaintenanceScheduler to compute
scheduling delays.What
AbstractMaintenanceScheduler does with eligible partitions; independent of any
backend's settings.A
SecretProvider managed by the Platform.A Managed Tag Provider is one that is managed by outside code- in other words, not one created by
the user.
An
ElementExtractor over plain Java objects: Maps are the map elements, Java
arrays (accessed reflectively) are the array elements, and everything else is a primitive
returned as-is by MapElementExtractor.toJava(Object).Parser for the AI Multi-instance Wizard mapping target vocabulary.
Write and preview surfaces supported by AI plan mappings.
A class for working with parameter strings as found in a URL query part or fragment id, typically
with the format: field1=value1invalid input: '&field2'=value2
Read-only markdown renderer that walks the Commonmark AST and emits a tree of native Swing
components — one component per block.
Color palette for the rendered markdown.
Contains functions we wish were in java.lang.Math
Fills the area with a solid fill at some transparency level.
How the historian stores a tag's held value once the max time between samples has passed.
An annotation to provide a hint in the OpenAPI schema that a number field has a maximum value.
A json-schema validation that requires a string field must be a shorter than a maximum character
length.
A tristate butto model that can have the mixed mode turned on or off
Read-only snapshot of one currently-running gateway MCP connection.
Read-only snapshot of one tool advertised by an MCP connection.
Source of MCP-derived
CallableTools for an AgenticHarness.A tag config that has a string path with is the UID of the parent folder.
A menu action is an entry in the "hamburger" menu displayed for items in a data grid.
Represents the entire menu bar.
Interface to create consist api between JMenu and JPopupMenu
Interface representing the channel used by the backend to send messages down to the client (the
websocket).
Manages the dispatching of messages and requests to message handlers.
Utilities for binding
MessageDisplayComponent components.A utility class that provides support for painting text on a
In the component that you want to paint text on, add the following code to the paintComponent method:
JComponent.In the component that you want to paint text on, add the following code to the paintComponent method:
A unique identifier for a message handler, including its name, enabled status, threading model,
and permissions.
Manages the lifecycle and execution of message handlers within a project.
Handles the execution of a message handler script.
Tab for editing message handler event scripts.
A container for all information required to execute a message handler script.
Handles some boilerplate for classes that can handle receiving messages from a websocket channel.
Callback interface for receiving results from a message request.
The trigger configuration of a Gateway message-handler event script: the thread the handler runs
on, and optionally the zone/role permissions that gate who may invoke it.
Which thread the handler runs on.
Metadata for a source: a
ComplexPoint whose value is a PropertySet, with a
quality, timestamp and source.Builder for
MetadataPoint.Protobuf binary adapter for
MetadataPoint.Processes
MetadataPoints read by MetadataQueryKeys.Key for querying the metadata of a path; its point type is
StandardComplexPointType.METADATA.Protobuf binary adapter for
MetadataQueryKey.Options for a metadata query: the shared query options keyed by
MetadataQueryKey, plus a
property filter.Builder for
MetadataQueryOptions.Protobuf binary adapter for
MetadataQueryOptions.The base MetaProperty class.
A wrapper around a MethodDescriptor with a link to the containing EventSetDescriptorNode.
This builder helps build metrics that implement
DescriptiveMetric.Created by mattgross on 3/15/2016.
Created by carlg on 6/9/2016.
Created by carlg on 6/9/2016.
A class to represent midi files.
A simple jpanel that uses a MigLayout to create a 2-column form.
An annotation to provide a hint in the OpenAPI schema that the number field has a minimum value.
A json-schema validation that requires a string field must be a minimum character length.
This event is broadcast when data is posted to the GW from a mobile client session, containing
data provided by the native mobile application (barcode, image, nfc scan, etc).
A convenience class for collecting the different data type identifiers used by the mobile device,
as well as the script handlers that are associated with the originating data source.
Ignition-side mirror of langchain4j's
dev.langchain4j.model.chat.Capability.Describes a single model offered by a provider.
Describes an AI model provider.
A marker interface to designate that an
Enum is intended to be used as a model update
specifier.Pre-defined
ModelUpdate types with special meanings to the framework.Represents a resource that has been modified.
Identity of the historian module.
Contains meta information about a module, such as its id, name description, required versions,
hook classes, and jar file information
Contains meta information about a module's jar file, such as its scope and native lib
parameters, and path within the module package.
This class parses the module descriptor file.
Class for project resource Python script libraries
Manages how modules are installed, restarted, and removed from Ignition
This ObjectInputStream first tries the normal method of locating classes that it's deserializing,
but if it can't find them, it goes to the modules to resolve them.
Marker interface for a generic service provided by a module.
The
ModuleServicesManager is responsible for managing the lifecycle of ModuleServices and ModuleServiceConsumers.When the Perspective Module is about to Shut Down, this event is sent on the Perspective Context
Event Bus
A monitoring session is a way for us to set levels and filters on the logging system, and have
them timeout after a certain period of time.
Abstract adapter implementation of MouseListener and MouseMotionListener.
Panel that is used to represent a collection of style attribute editors.
Query envelope that carries different query options per engine in one pipeline call, instead of
one call per engine.
Discriminated wrapper for AI Multi-instance Wizard plan suggestions.
Top-level plan modes supported by this parser.
Some util functions for getting device information on multi monitor set ups
This is the superclass for Paints which use a multiple color gradient to fill in their raster.
The color space in which to perform the gradient interpolation.
The method to use when painting outside the gradient bounds.
A transferable that accepts multiple transferables and will multiplex between them.
Useful for contributing to multiple timers with a single auto-closeable.
This class holds a value for each of the type classes, in case we need to pass all of the
possibilities along until we can know for sure which to use.
Mutability mode represents how a session should interact with external sources of data, such as
tags or databases.
An implementation of Dataset that is used by gateway-side functions for returning to clients.
A simple wrapper around a SimpleDateFormat that simplifies the interface for altering and
retrieving the format.
An entity that can have children added to it.
A nav tree node to which children can be added by external actors
The normal BasicTagValue will throw exceptions on the setters after initialization.
A class that performs the work of reading and setting values on a bound field.
The requested name would collide with another local resource (a problem on case-insensitive OSes,
ie Windows)
A NamedId is an identifier which is primarily a UUID, but can have a "friendly" name associated
with it.
Record that holds a resource collection / project name and a
ResourceCollectionManifest.Used by ProjectRoutes for the project overview list.
This class represents a single named query.
Hooks into the QueryManager for polling
Agent powering the "Build with AI" popup on the Named Query authoring panel.
Authoring panel of the NamedQueryWorkspace
Tree in Named Query Workspace that browses the selected datasource and displays tables and
columns Supports dragging a table or column into the Code Editor for quick table and column
references
Panel used to select a named query by path and set the parameters in Direct mode only.
Panel that shows the description for a named query as appropriate.
Panel that shows the fallback value for a NamedQuery.
This allows NamedQueries to use unsaved queries in the Designer (so other resources can use them
without forcing a save), but not the Client.
Project resource node specific to Named Queries.
PromptAssist that surfaces the entries currently in the Named Query's parameter table.Composes the Named Query authoring panel's state into the host-context blocks sent to
NamedQueryAgent; the framework appends the canonical references block and the user's prompt
after them.Renders
NamedQueryAgent replies into a Swing view with an Apply button that writes the
suggestion back to the host panel.Write-back callbacks invoked when the user clicks Apply.
A tabbed resource editor for Named Queries
Named Query–specific
AbstractSchemaPromptAssist that resolves the active datasource from
the panel's current snapshot.Settings panel of the NamedQueryWorkspace
Frozen view of the Named Query authoring panel taken at the moment the user submits a prompt.
Basically a
SQLQueryTagBinding, altered for Named QueriesValue-source properties for tags backed by a Named Query.
Testing panel of the NamedQueryWorkspace
Workspace for creating NamedQueries; integrates easily with the project resource nav tree
This class acts as an abstraction layer for handling named configuration resources.
NamedTheme to be applied to CodeEditor TextAreas
A simple thread factory that uses a custom name prefix.
A wrapper around an Object that attaches a resource bundle key to it.
The requested name is already in use by another local resource.
This class provides helper functions for naming objects.
The basic name factory generates sequential names with simple pattern detection.
For a given object, provides its name.
The implementor will return whether the provided name exists or not.
This NameValidator wrapper is used for generating many names, when the underlying name
validator won't be updated on the fly.
Resolves file paths to native libraries based on the following file structure:
Pipeline-supplied context for one aggregated query computed natively by an engine: the directive
for each key, the live post bound of each key that has one, and whether the batch runs the
classic tag history calculation.
This class is wrapper for a
Date_selector that adds a navigation bar to manipulate the
wrapped selector.This jython builder provides a GUI that defines a navigation action
Data component that can be attached to an
Entity to provide navigational information for
the web-ui.An icon used in the Designer
NavTreePanel that can show a normal and selected state.By creating a dedicated class for a list of tree paths, we gen an un-ambigious DataFlavor
through LocalObjectTransferable rather than a type-erased data flavor for List.class
This class tracks where the Rename functionality follows a convoluted path.
This class contains the actual implementation for the methods mounted under system.nav.*, but it
is not actually directly mounted in the script manager because there is a separate instance of
this class for each desktop instance.
This class exists in order to automatically detect what desktop the call is coming in from and to
dispatch the invocation to the correct NavUtilities instance, based upon the thread local in
VisionDesktop.CURRENT_DESKTOP.
This class is responsible for GUI editing of nested document shape.
This JTree supports renderers who have mouse-location sensitive tooltips.
This action will pop up the
CreateResourceDialog.Action delegate used to configure NDef format NFC data collection from mobile/native devices
The "Node" is the base unit of everything in the tag system.
Node attributes are characteristics of a node that affect how they are displayed.
Protobuf type
common.protobuf.tags.BasicNodeAttributePBProtobuf type
common.protobuf.tags.BasicNodeAttributePBProtobuf type
common.protobuf.ExtendedInheritanceAttributePBProtobuf type
common.protobuf.tags.ExtendedInheritanceAttributePBProtobuf type
common.protobuf.ExtendedInheritanceAttributePBProtobuf type
common.protobuf.tags.ExtendedInheritanceAttributePBProtobuf type
common.protobuf.NodeAttributePB
Base interface is com.inductiveautomation.ignition.common.tags.model.TagPath
Protobuf type
common.protobuf.NodeAttributePB
Base interface is com.inductiveautomation.ignition.common.tags.model.TagPath
Protobuf type
common.protobuf.TagColorAttributePBProtobuf type
common.protobuf.tags.TagColorAttributePBProtobuf type
common.protobuf.TagColorAttributePBProtobuf type
common.protobuf.tags.TagColorAttributePBNodeBrowseInfo is an extension (wrapper) around NodeDescription which includes its full path.
Gson serialization and deserialization adapter for NodeBrowseInfo objects.
com.inductiveautomation.ignition.common.tags.browsing.NodeBrowseInfo
com.inductiveautomation.ignition.common.tags.browsing.NodeBrowseInfo
Gson serialization and deserialization adapter for NodeBrowseInfo objects.
com.inductiveautomation.ignition.common.tags.browsing.NodeDescription
com.inductiveautomation.ignition.common.tags.browsing.NodeDescription
This UI does the heavy lifting for the json editor.
Heads up! If you implement this, you also must be a JComponent
A utility class to mine various information from a given node.
This provides a bridge from the historian back to the system providing data.
Represents the connection between the tag subscription model and the tag execution model.
Provides the meta data needed for an OPC server to subscribe to a node
TagNodes that implement
NodeSubscriptionDelegate tells subscription system the implementing class wants to manage it's
own TagChangeEvents to a SubscriptionNode's listeners.Created by carlg on 5/15/2017.
This class is meant to be the designer side definition of the possible values the
NodeBrowseInfo.subType, typically when the object type is "Node".
Listens to tree expansion events to determine which nodes are currently visible, and thusly must
listen for changes.
Provides a "No Expression" action that clears expression content.
Methods annotated with @NoHint are ignored by
PropertiesFileDocProvider.Deprecated.
use the Historian
QueryEngine pipeline.Filename: NonKeyMappable Author: Perry Arellano-Jones Created on: 7/7/15
This annotation is used to mark a field as non-secret.
A wrapper around a delegate dataset which is only useful because there is a special serialization
delegate registered for it which only serializes the column names and types, but not any of the
rows.
A NoOpCookieStore is a
CookieStore which does nothing when asked to add / clear cookies.Sentinel for unparameterized aggregates.
A
BindableModel implementation which does nothing.Created by carl.gould on 7/14/2015.
Marks the annotated field as not bindable.
The context for a particular notification.
Specific kind of PushException indicating that a push failed because the active node is not the
primary.
The class this annotation is attached to should be not be assumed to be thread-safe.
Like a
SQLQuery, except for named queries.ColorSelectionModel that allows for null
colors.This class encapsulates calls to
ColorSwatch which may not be instantiated (aka null).A tool that does nothing.
A text document which will reject any characters that are not digits.
A property editor for editing strings.
Created by carl.gould on 7/27/2015.
Use this to specify a number format property that will have an editor that helps pick format
strings
This record class is the root of an OpenAPI specification.
A simple tuple of an object, a field on that object's class, and a method of that object's class.
A Helper class for Object.
The method that this annotation is attached to will directly synchronized on some lock during its
course of execution.
The method that this annotation is attached to will indirectly synchronized on some lock (i.e.
Project data for an offline session.
Defines an offline resource
A component binding that will call a method when an action occurs.
Inner utility class that performs the runtime wiring of all
OnChange bindings.A binding that will call a method when the on-click action occurs on this component.
Enum specifying which mouse button is being bound by this binding.
Inner utility class that performs the runtime wiring of all
OnClick bindings.Runs a script when events that flow through this stage have errors.
A binding that will call one method when the bound component loses focus, and another method when
focus is gained.
Inner utility class that performs the runtime wiring of all
OnFocusChange bindings.Created by mattgross on 7/28/2017.
Escape hatch for aggregates whose schema isn't formalized.
Sorts annotations along either the X or Y axis, depending on the plot orientation
This is the browse element supported by the OPC subsystem.
com.inductiveautomation.ignition.common.opc.BrowseElement
com.inductiveautomation.ignition.common.opc.BrowseElement
Protobuf type
common.protobuf.PropertyElementPBProtobuf type
common.protobuf.PropertyElementPBRead-only AI tool surface for discovering OPC connections, browse nodes, and node metadata.
An
OpcConnection is a connection to some kind of OPC server.Base class for
ExtensionPoints that provide an OpcConnection implementation.Manages
OpcConnection instances and provides an interface to read, write, browse, and
subscribe to OPC values via those connections.An
OpcConnection and its associated resource and configuration.Optional extension point hook for OPC connection types that publish additional system tags under
OPC/Connections/<connectionName>/.Definition for one contributed system tag.
Resource-level context used while contributed system tags are configured.
Current value for one contributed system tag.
Live connection context used while contributed system tag values are refreshed.
Represents an OPC item for purposes of Cut/Copy/Paste
Prompt assist provider for selecting OPC source nodes for Designer AI prompts.
Builds bounded OPC source context for Designer AI prompt composers.
The resolved body of an
@opc: prompt reference — the OPC source node the user selected.An object that provides the information needed to subscribe to a node (the
NodeSubscriptionDefinition), and receives the QualifiedValue when the subscribed node changes.
These are Tag Group level properties that pertain to OPC tags.
Used by routes to configure OpenApi OperationObjects.
The OperationAggregator takes a set of objects, splits them up based on keys determined by a
KeyProvider, and then aggregates the results back together in the correct order, after some
execution has occured.
The InputValidator provides a way to validate input values before they get to execution.
A record object that represents an OpenAPI Operation Object.
Similar to the OptionRowEditor but uses toggle buttons and icons instead
Option editor for attributes who a large number of options, more than 4-5.
Option editor for attributes who have a small number of options: 2-5ish.
Use this annotation on reporting shape getter/setter methods to define a set of options for
integer properties that act like enums.
For use when a Dockable Frame should not contribute to the Designer edit menu, but should still
return an edit handler when a context switch is performed
Takes a set of sub conditions and passes if any of them passes.
Annotation used to specify that a property should be ordered directly beneath another property.
Enum representing the origin of a property value.
This edge router uses an orthogonal edge routing algorithm to route edges between blocks at right
angles.
Describes at output pin for a pipeline block.
A simple painted layer, used by LayeredOverlay
Class that manages painting data quality overlays for JComponents that are QualityMonitors.
A simple toggle control that indicates whether a property is overridden or not.
This is a map that connects
Member's UID to a set of property overrides.This class contains all of the methods to display and handle RMEditor UI methods.
This class contains all of the methods to display and handle RMEditor UI methods.
An immutable tree element that represents a particular system library package (e.g.
An implementation of historical tag value that stores the enums packed together as an integer.
Deprecated.
Deprecated.
A page contains a number of views all running within the same web page, or tab.
Panel that is placed in the middle of the dock editor to editor properties of the page
Represents a tab for editing page startup scripts.
Created by carl.gould on 1/13/2015.
This class provides GUI editing for RMPage shapes.
Utility class for handling pagination related operations, specifically those that deal with
binding Page related keys to components.
The model underlying the component palette used by the Vision module in the Designer.
Quick filter field that will filter a CollapsiblePanes object if it is populated with
FilterableCategoryPane objects.
Created by carlg on 10/20/2016.
Implementation copied (and simplified) from DefaultSingleSelectionModel and modified to handle
objects, not ints.
Created by carlg on 10/20/2016.
Manages a number of palette items (trees) similar to how a button group works Only one tree node
can be selected at any given time.
Reads palette.xml and creates the static set of palette components
Parameters are special types of properties.
Represents a range of float values with a specified start, step, and name.
Represents a range of integer values with a specified start, step, and name.
Represents a range of alphabetical values starting from a given character and generates a
list of alphabetically ordered strings up to the specified limit.
Represents a manually defined list of values.
Represents a numeric range with a specified start value and step.
Table used to fill in a NamedQuery's parameters with a value.
Typed container for parameter metadata and values.
With properties, we can have a mix between inherited and non inherited.
Filename: ParameterKeyPopup.java Created on Jul 14, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
This is an informational class about what parameters exist in a UDT, including sub members.
Protobuf type
common.protobuf.ParameterModelEntryPBProtobuf type
common.protobuf.ParameterModelEntryPB
A wrapper around different types of PropertySets that can be Protobuf serialized.
A wrapper around different types of PropertySets that can be Protobuf serialized.
Parameter-table changes the agent has proposed alongside a SQL revision: rows to drop by name and
rows to add.
One row the agent has asked us to add to the parameter table.
Record class that represents an OpenAPI Parameter Object
Describes the parameter contract of an
AggregationType, for frontend rendering and for
decoding the parameters of a parameterized aggregate.Protobuf binary adapter for
ParameterSchema, using the ParameterSchemaProto.ParameterSchemaPB schema.
Represents a single field in a ParameterSchema.
Represents a single field in a ParameterSchema.
Protobuf type
common.protobuf.ParameterSchemaPBProtobuf type
common.protobuf.ParameterSchemaPBThis is a utility function to help deal with changes we've made to parameters over time
(re-introduction of data types through ParameterValue).
This is the config value for a Parameter.
com.inductiveautomation.ignition.common.tags.config.properties.ParameterValue
com.inductiveautomation.ignition.common.tags.config.properties.ParameterValue
This exception is thrown when parse errors are encountered.
This exception is thrown when parse errors are encountered.
An exception subclass for parser.
This exception is thrown when parse errors are encountered.
This exception is thrown when parse errors are encountered.
A class called when child rules are parsed.
A class called when child rules are parsed.
A parse node.
Interface for expression parsers.
A class to parse a given input (string) using given rule(s).
A class to represent a parse rule.
Some utility methods and classes for Parser.
A subclass that prints rules.
A parse node subclass that is also a handler.
Result of a call to
ResourceCollectionManager.pushPartial(PushOperation).Fired by a historian after each durable partition-maintenance operation on a table.
The kind of partition-maintenance operation.
Observes partition-maintenance operations after they are durable.
Immediately forward events to handlers.
A panel that allows for editing of a password in the following way:
Simple 'wrapper' around an actual AuthChallenge that indicates the attempt should bypass any
password expiration.
Throw this from
UserSourceProfile.authenticate(AuthChallenge) if the password was correct
but expired.A path condition operates on
Paths.Passes if any part of a tag path matches the provided pattern
Encapsulates the UI that lets the user configure the tag change script's options, everything but
the script itself.
The case fold for every in-memory tag-path and gateway-name key: each code point goes through
Character.toUpperCase(int) then Character.toLowerCase(int), independent of the
JVM's locale.This class loads an icon, possibly stretching and applying filters (color replace, color tint) to
it.
Record class that represents an OpenAPI Path Item Object
Base interface is com.inductiveautomation.ignition.common.Path
Base interface is com.inductiveautomation.ignition.common.Path
Collectors for sets of qualified paths.
A tree structure that uses a path to locate values.
Utilities for paths.
A json-schema validation that requires a field confirms to a regex pattern.
A helper class to be used with
StepController.executeUntilComplete(PausableFutureStepWork), takes a
CompletableFuture, and will block step progression until the future has completed.This class represents a PDF annotation (like a hyperlink).
This class represents a PDF annotation (like a hyperlink).
An inner class (and annotation subclass) to support hyperlinks.
An inner class (and annotation subclass) to support hyperlinks.
This class is like a StringBuffer, but for creating PDF files instead of strings.
This class is like a StringBuffer, but for creating PDF files instead of strings.
This class is an image producer that uses the RBCodecCCITTFaxDecoder to produce the bits of a
1bpp monochrome image.
An implementation of interface CharStream, where the stream can contain any binary data.
An implementation of interface CharStream, where the stream can contain any binary data.
A Snap file subclass for PDFs.
This is an implementation of the DeviceCMYK colorspace as defined in the pdf spec.
A collection of routines for pulling various objects out of PDF dictionaries
The PDFEncyptor is a subclass of PDFSecurityHandler that is used to encrypt strings and streams
for pdf output.
The PDFEncyptor is a subclass of PDFSecurityHandler that is used to encrypt strings and streams
for pdf output.
This class is used to read a PDF file for parsing.
This class represents a PDF file.
This class represents a PDF file.
This class is used to read a PDF file for parsing.
An inner class to store font info.
PDFFontFactory.java
PDFFontFactory.java
An object which holds on to a stream of markup operations for later drawing.
This is an abstract superclass for all objects implementing PDF functions.
This class is used to map cids to widths.
Represents a PDF graphics state stack with graphic state objects.
An inner class for GStates.
The PDFImageColorModel is a subclass of PackedColorModel which can be used to display a pdf
image.
A representation of the alpha channel.
This class handles writing images to a PDF file.
PDFIndexedColorSpace
PDFObjectStream
A PDF Output destination.
Writes a report's PDF output to the supplied output stream directly.
This class is used by RMPDFFile to read a PDF file (page) for parsing.
All drawing happens in PDFPage object.
All drawing happens in PDFPage object.
This class is used by RMPDFFile to read a PDF file (page) for parsing.
This class is a subclass of PDFBuffer, that knows how to write an RMPage and its shapes.
This class parses the page marking operators for a specific page number (it gets the contents for
that page from n RMPDFParser.) It uses the various factory objects for graphic object creation
and a MarkupHandler to do the actual drawing.
This class parses the page marking operators for a specific page number (it gets the contents for
that page from n RMPDFParser.) It uses the various factory objects for graphic object creation
and a MarkupHandler to do the actual drawing.
This class represents a pages tree in a PDF file.
This class represents a pages tree in a PDF file.
PDFPattern.java Created Dec 15, 2005 Copyright (c) 2005 by Joshua Doenias
The Pattern colorspace is a special colorspace where shadings and tiling patterns can be
declared.
Implementation of the Adobe Standard security handler using the Sun security extensions for md5 invalid input: '&'
rc4.
A java.awt.color.ColorSpace subclass to represent a pdf /Separation colorspace.
PDFShadingPattern.
This class represents a PDF stream object.
This class represents a PDF stream object.
This class represents a PDF stream object.
This class represents a PDF stream object.
This class generates PDF for an RMText.
An inner class to store font info.
Represents text spacing details that are defined in between BT invalid input: '&' ET operation.
This class handles drawing images as tiles, for when allocating a BufferedImage for the entire
pdf image would be too expensive.
This class represents a PDF XRef entry.
This class represents a PDF XRef Table entry.
An inner class for XRef Table entries.
An inner class for XRef Table entries.
This class represents a cross reference table in a PDF file.
This class represents a cross reference table in a PDF file.
A pen is the main unit of configuration for the EasyChart.
Simple struct-like class that holds pen options for a reporting chart
This interface exists just so that we can have one function to create renderers and an instance
of this class can resolve the differences between pens as they are found in the chart at runtime
and as they are found in the customizer
PenData represents the data for a single pen.
Class that bridges PenData objects into the JFreeChart's Dataset interface
Represents the current state of resources if we were to do an update
Iterates through the various datasets of pens, creating Pen ojbects on the fly.
Parameters of a single-percentile aggregate such as APPROX_PERCENTILE.
The three points of a distribution worth showing an operator: typical, tail, and worst.
Deprecated.
A GsonAdapter for PermissionConfig that returns a default
PermissionsConfig if
deserialization fails.A Gson adapter for serializing and deserializing
PermissionsConfig objects.
com.inductiveautomation.ignition.common.auth.permissions.PermissionsConfig
com.inductiveautomation.ignition.common.auth.permissions.PermissionsConfig
Store & Forward carrier for one
AtomicPoint, letting a storage engine route live
atomic data through the tag-history Store & Forward subsystem, for example when it diverts
data under backpressure.Serializes
PersistentAtomicPoint to/from the generic
common.protobuf.AtomicPointPB wire format, encoding with HistorianProtoCodec, the same
encoder RPC and replication use.An
AuditRecord wrapper that contains PersistentFlavor information that can be
used within the Store invalid input: '&' Forward system.Store & Forward carrier for one
ChangePoint, a source-change or annotation-change
point.Serializes
PersistentChangePoint to/from the generic
common.protobuf.ChangePointPB wire format, handling both source-change and annotation-change
points with HistorianProtoCodec, the same encoder RPC and replication use.Store & Forward carrier for one
ComplexPoint, a metadata or annotation point.Serializes
PersistentComplexPoint to/from the generic
common.protobuf.ComplexPointPB wire format.Represents a type of data that can persist across application sessions.
Associates PersistentData with a specific storage destination within an engine.
Utility class for operating on collections of
PersistentData.Interface representing the flavor of a
PersistentData instance.Wraps historian temporal points in the Store & Forward carriers that can persist them.
Store & Forward flavors for the historian point carriers (
PersistentAtomicPoint,
PersistentComplexPoint, PersistentChangePoint), grouped in one FlavorContainer so a single sink registered for PersistentPoint accepts all three.A simple extension of properties that is meant to represent a file based property file.
An interface that provides methods for serializing and deserializing
PersistentData.A
RedundantAuthTokenManager which manages ProjectAuthTokenRecords bound to Perspective offline mode sessionsA
RedundantAuthTokenManager.Builder which provides a fluent-style API for incrementally
building the required pieces to create new PerspectiveAuthTokenManager instances.Routes for browsing, touching, and removing Perspective offline mode
PlatformAuthTokenRecords, protected by config read and write
permissions.Provides a way to find resources shared by all Perspective sessions.
Implementation of
AbstractSession which is used when the Ignition Designer is creating,
running, and previewing Perspective Views.Helper class that simplifies the creation and proper evaluation of expressions that execute in
and around the binding / transform system.
A PerspectiveExpressionFactory is a
FragileBiFunction which takes a BindingContext and an expression source as a String and creates and returns the
corresponding PerspectiveExpressionA PerspectiveFont is a
Triple of a font name (i.e.Enumeration of font types supported by Perspective and their respective MIME types
Same as the base
KeyEditorField, but with an additional validator based on PropertyRef.NAMEContains common configuration and const definitions for things like module ID, and also provides
a registry for components.
RPC Interface for the Perspective Module.
Named subclass of base
NodeEditor so that PerspectiveNodeEditor.createKeyEditor(DocumentNode) can return a PerspectiveNodeEditor
instead of the default object.A polling blocking task that looks up its rate from a property tree and is reactive to the rate
changing.
Manages a polling task that looks up its rate from a property tree and is reactive to the rate
changing.
A PerspectiveProject is a simple container of a
ProjectConfig, concatenated compiled CSS
style resources, and the Map of all style resource IDs to their compiled CSS in the
ResourceCollection.Used to provide scripting access to some metadata about the project
The PerspectiveProjectCache manages a cache of the latest
ProjectConfig and concatenated
css classes compiled from the style resource JSON sources on a per-project version basis.Contains a running Perspective project for a session.
Read-only tools that expose context about the view, selection, and component graph in the
Perspective designer to an LLM for agentic code completion.
Panel used in the project property editor for manipulating perspective project options
Attaches a shared "Ask AI" toolbar button to a Perspective component script surface — one of the
PerspectiveScriptSurface editors, or another module's script surface bound to a Perspective
component.Produces the AI grounding for one Perspective script-editing surface: the framing string that
describes where the body lives, the read tools the agent can call for anything the framing does
not carry, and the
@-reference sources the prompt offers.What an editor window was opened on, captured once when the window is built — not when an
editor panel inside it is built, since those are created lazily, after the selection may
already have moved.
A Perspective scripting surface whose Jython body an AI assist can be mounted on, and the key
its framing is looked up by through
PerspectiveScriptGrounding.callerContextFor(PerspectiveScriptSurface) or, for the
surfaces whose framing reads live form state, that surface's own variant.This is the top level of session object for a collection of "project" sessions.
Struct-like class describing session details used by the status pages.
Used for customer-facing encoding of this class, but not used for the status page's encoding.
Simple class which holds a set of auth sessions that are currently live.
Builds the
DiagnosticDigestGenerator that produces summary and analysis digests for the
Perspective Sessions status page.Tool exposed to the analysis agent for inspecting Perspective thread state.
One session's timer and meter values.
A
PerspectiveExpression which has an additional PerspectiveTransformExpression.execute(QualifiedValue) method
to handle updating the underlying Expression with the incoming value and subsequently
executing the expression which may be bound to the incoming value.Mounts a websocket servlet for use by the Perspective module.
Acts as a
TabbedWorkspaceListener which manages the book keeping of the Perspective
Workspace's currently selected Perspective Editor's EditActionHandler and also notifies
the appropriate ViewResourceEditor when it has been activated / deactivated.Deprecated.
since 8.3.
Component used by the BasicBlockUI to represent an anchor point.
A
PipelineBlock.BlockEvaluationContext is an "instance" for evaluating an incoming AlarmEvent
against a PipelineBlock's configuration.An interface that may be used on the UI that is returned from
PipelineBlockPrototype.createEditingUI(DesignerContext, PropertySet) so that the UI knows when
to commit its edits.A pipeline block prototype describes a pipeline's general nature for the purposes of visual
design within the pipeline design workspace.
An event flowing through the pipeline stages.
Signals that the stream for
PipelineEvent.KeyComplete.key() completed successfully.Signals that the stream for
PipelineEvent.KeyFailure.key() failed with the given quality code.Signals that the stream of points for
PipelineEvent.KeyOpen.key() has begun.Carries one point for
PipelineEvent.Point.key().Advances the watermark for
PipelineEvent.Watermark.key(): every later point has a timestamp at or after PipelineEvent.Watermark.time().A record that contains information about a data pipeline within a store and forward engine.
Gson-compatible class that wraps up the details that the designer retrieves from the js bridge
about a selected pipes.
Just a standard template for a placeholder empty panel to show before something gets selected.
Wrapper around a byte array representing plaintext to be encrypted into ciphertext or decrypted
from ciphertext.
Protobuf type
common.protobuf.PlaintextPBProtobuf type
common.protobuf.PlaintextPBSerializer for
Plaintext instances.Hands out pre-loaded
ComposedAgent.Builders backed by Designer-side tool surfaces.Registers
DesignerResourceMeta entries for resource types contributed by the platform
itself (as opposed to those contributed by modules via their designer hook).A collection of RPC interfaces which exist at the platform level and can be used by clients and
designers.
Filename: PMI2StateButtonTermFinder.java Created on Nov 18, 2013 Author: Kathy Applebaum
Copyright Inductive Automation 2013 Project: Vision
Utilities to help with internationalization
This component is commonly referred to as the "Classic Chart".
A subclass of JFreeChart's ChartPanel that overrides doSaveAs() and createChartPrintJob() to have
FPMI compatible popup windows for FSE mode.
Represents a range of dates, from a start to an end
History: Base code pieced together from code found on java.sun.com forum posting
http://forum.java.sun.com/thread.jspa?threadID=494920invalid input: '&start'=15invalid input: '&tstart'=0
Deprecated.
Represents a simple style configuration for a button
Abstract superclass of all FactoryPMI shape components.
Deprecated.
Decides when and how points reach the storage engine: store immediately, buffer and batch, or
divert.
Receives batches that are ready to store.
Scaffolding for managing the execution of a blocking task that may need to poll or be executed
on-demand.
Scaffolding for managing the fetching of a completable future that may need to poll or be
executed on-demand.
Represents a polling rate, either off, relative, or absolute, with a time value in milliseconds
This class manages creation and editing of polygon shapes.
This inner class defines a polygon tool subclass for drawing freehand pencil sketches instead.
A Popup_dialog is a clean, lightweight, "modal" window intended for simple pop-up user-interface
widgets.
This class uses a lower-level implementation of Popup than the similar JPopupMenuHelper class
does.
A popup window that has a JList instead of menu items.
Defines a class that will be used as a FPMI Client popup window, for some window contents.
Wraps the logic of displaying a small panel in a popup.
Source of the Power Chart's main tag-history series.
Wire-friendly mirror of
ParameterSchema.ParameterField — covers both scalar and enum
variants in a single flat record so the React side can dispatch on PowerChartTagHistoryDataSource.ParameterFieldDescriptor.kind without
dealing with sealed-permits.Plain-data descriptor record carrying just enough to render a dropdown row + persist a stable
identifier back to the binding.
One pen's answer as
PowerChartTagHistoryDataSource.describeSeries(PowerChartTagHistoryDataSource.SeriesRequest) reports it.One pen of a
PowerChartTagHistoryDataSource.SeriesRequest.Plain-data fetch request for
PowerChartTagHistoryDataSource.fetchSeries(SeriesRequest, StreamingDatasetWriter).A predicate map connects predicates of a certain type to multiple objects of another type.
This class provides a Preferences panel UI window.
Use this to mark properties as "preferred" which means they are the properties a user is most
likely to edit
This class provides a Preferences panel UI window.
Created by carl.gould on 3/3/2015.
Created by carl.gould on 3/4/2015.
Filename: PreviewLanguagesMenu.java Created on Feb 24, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Ignition
Row model prepared for preview rendering before tag configuration generation.
This delegate serializes one-dimensional arrays of types that can be represented in a very simple
manner.
Filename: PrintAction.java Created on Mar 23, 2015 Author: Kathy Applebaum Copyright Inductive
Automation 2015 Project: Reporting
Filename: PrintActionConfig.java Created on Mar 23, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: PrintActionPanel.java Created on Mar 23, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Implements the functions mounted as "system.print" on all scopes
Created by colby.clegg on 7/31/2015.
The context for initializing point processing: it gives access to the properties of each query
key.
This class lets various "profile" items (notification profile, tag history profiles, etc)
communicate basic running state information.
This enum defines the general state in coarse terms.
Deprecated.
Since 8.3.0; create a
Task if you want platform managed UI for an
asynchronous task.Interface for listening to something that can be tracked.
The idea of progress tracking has multiple facets, namely:
Designer tasks Designer/Gateway communciation tasks
Designer tasks Designer/Gateway communciation tasks
The root node of the designer's project browser tree.
Given to a project in order to apply all changes pulled from the Gateway, along with the choices
made on resource conflicts.
A GSON-serialization compatible class that holds all of the information about a project that a
Vision client needs in order to be able to get started and logged-in, after which it can download
the whole project.
Deprecated.
The ProjectConfig class is
Gson serializable model used by the gateway to represent a
saveable Perspective client state for a given Perspective module Project.Custom Gson serializer for ProjectConfig that properly handles the componentResources field.
A tag manager that translates tag paths sources between the "default" source of empty string and
the absolute name of a project's default tag provider
The ProjectDeletedEvent is fired on the
PerspectiveProjectCache event bus when a ResourceCollection is deleted.Stores all required attributes and resources for a created or imported project.
The Direction the transition is moving towards.
Custom Gson serializer for ProjectDiff.
Projects rates by extrapolating from processing duration of event batches.
Collection of utility methods to encode and decode resource collection and related objects
to/from JSON.
A utility class for inspecting, identifying and loading Projects from Files or streams.
A
ComboBoxUI that renders an arrow and text at the correct padded position.A single Identity Provider entry in a project's
IdP list.A ProjectImport is a self-contained collection of the information that represents a single
Ignition Project.
Deprecated.
retained purely for pre-8.3 EAM agent backwards-compatibility.
Deprecated.
The ProjectRebuiltEvent is fired on the
PerspectiveProjectCache event bus when an
existing ResourceCollection has had its component resources (list of js, css files
needed) changed.Deprecated.
A button that displays a tree of the given project resource type in a popup.
Convenience class for a text field that will validate a resource path, such as a Named Query.
A snapshot of one gateway-run project script: what it is, whether it is enabled, whatever
configuration is specific to its kind, and the report from its most recent execution only.
The configuration specific to one kind of script, as reported alongside its diagnostic.
A message handler's threading configuration.
A scheduled script's cron schedule and the state of the queue its jobs run through.
A timer script's cadence.
A ScriptModule representing a project resource.
ProjectTags are what we call Client Tags.
This tag manager hold the root of the project tag tree configuration.
The ProjectUpdatedEvent is fired on the
PerspectiveProjectCache event bus when an
existing ResourceCollection is updated.Created by carlg on 7/5/2017.
Utilities for Project package.
Simple implementation of LaunchContext.WritableProject.
A
Promise is, as the name implies, a rough analogue of other languages (such as JS)'s
"Promise" class.Pluggable source of in-prompt assistance — the rows that appear when the user triggers the
autocomplete popup in the embedded assistant's prompt area.
One row in the popup.
A "folder-like" row: selecting it rewrites the trigger span to
nextQuery and asks
every assist for fresh options.A terminal row: selecting it splices
@<id>:<path> — built by the framework from the
owning assist's PromptAssist.id() and this row's PromptAssist.Option.Insert.path — into the prompt at
the trigger span, closes the popup, and registers a ContextReference the framework
resolves at submit time.A row that is both confirmable and expandable.
Hands out the reusable host-agnostic
@-reference browsers Designer assist surfaces
commonly mount.Captures host-UI state at submit time and turns it into the host-context blocks that lead the
message body sent to the assistant's harness.
Little helper class that holds an old value of something for property-change listener purposes.
Default ScriptFunctionDocProvider implementation that relies on various annotations on methods
and fields to look up script documentation in properties files.
A Property describes a unique name and datatype for a property.
This class describes an attribute of an entity.
A tag path that delegates to another tag path, but alters the TagProp that the path points to.
A tag path that delegates to another tag path, but alters the TagProp that the path points to.
This annotation is used to hold property amendments for a component.
This context creates expressions that reference properties.
Collects the most recent value per path, and is an envelope for sending them to the client.
Column model for the classic property table (from pre-JIDE days).
A condition that support a number of property related sub-conditions.
This class combines a mutable property set (the "target"), with a ConfigurationPropertyModel
(which dictates what changes are allowed to be made) along with particular information about the
state of editing- is this an intersection? A new propertyset? An inherited property set? All of
these things have implications for the editing UI that we show, but we don't want to try to
figure them out based on the nature of the target.
Popup window used for jython property 'binding' windows.
Created by carlg on 6/14/2017.
DialogPage that wraps an instance of an AbstractPropertyEditorPanel in a JIDE DialogPage, adding
a banner on top.
An interaction descriptor that represents a dependency on a source component's property.
A property key is a hashable combination of component + property name
Uniquely identifies a property of a component by combining it's path and it's property scope.
This subclass of PropertyInteractionDescriptor is simply an PID that is also the listener, and a
ValueHolder.
Represents a "property" of a component.
This property node subscribes directly to a tag property, and can deal with scalar, array, and
dataset types.
PromptAssist that surfaces Perspective property paths through the @-popup.
com.inductiveautomation.ignition.common.alarming.config.AlarmModeProperties
Extends WellKnownAlarmProperties
com.inductiveautomation.ignition.common.alarming.config.AlarmModeProperties
Extends WellKnownAlarmProperties
com.inductiveautomation.ignition.common.alarming.config.AlarmProperty (interface)
Base message for alarm properties - used when the specific type is unknown
com.inductiveautomation.ignition.common.alarming.config.AlarmProperty (interface)
Base message for alarm properties - used when the specific type is unknown
com.inductiveautomation.ignition.common.alarming.config.AssociatedData
Implements AlarmProperty<Object>
com.inductiveautomation.ignition.common.alarming.config.AssociatedData
Implements AlarmProperty<Object>
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmProperty
Implements AlarmProperty directly (does not extend BasicProperty)
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmProperty
Implements AlarmProperty directly (does not extend BasicProperty)
com.inductiveautomation.ignition.common.config.BasicProperty
com.inductiveautomation.ignition.common.config.BasicProperty
com.inductiveautomation.ignition.common.alarming.config.CommonAlarmProperties
Extends WellKnownAlarmProperties
com.inductiveautomation.ignition.common.alarming.config.CommonAlarmProperties
Extends WellKnownAlarmProperties
com.inductiveautomation.ignition.common.config.BasicConfigurationProperty
Extends BasicDescriptiveProperty, implements ConfigurationProperty
com.inductiveautomation.ignition.common.config.BasicConfigurationProperty
Extends BasicDescriptiveProperty, implements ConfigurationProperty
ConfigurationProperty.CustomEditorDescriptor
ConfigurationProperty.CustomEditorDescriptor
com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty
Extends BasicProperty, implements DescriptiveProperty
com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty
Extends BasicProperty, implements DescriptiveProperty
com.inductiveautomation.ignition.common.alarming.evaluation.EventProperty
Wrapper around Property that adds EventPropertyType
com.inductiveautomation.ignition.common.alarming.evaluation.EventProperty
Wrapper around Property that adds EventPropertyType
com.inductiveautomation.ignition.common.alarming.evaluation.EventPropertyType
ConfigurationProperty.Option
ConfigurationProperty.Option
com.inductiveautomation.ignition.common.tags.config.properties.Parameter
Extends BasicProperty<ParameterValue>
com.inductiveautomation.ignition.common.tags.config.properties.Parameter
Extends BasicProperty<ParameterValue>
Main Property message that wraps all Property implementations.
Main Property message that wraps all Property implementations.
com.inductiveautomation.ignition.common.sqltags.model.TagAttribute
Implements Property<T>
com.inductiveautomation.ignition.common.sqltags.model.TagAttribute
Implements Property<T>
Adapter for serializing/deserializing Property implementations to/from Protocol Buffers.
Represents a Property of value <T> that can be subscribed to using
PropertySubscriber.This interface converts an id to a Property, if the id exists.
A PropertySet is a collection of property values.
Abstract superclass for pipeline blocks that are backed by an
ObservablePropertySetThis is the UI panel for the "Set Property" event script builder.
Like other Config entities, this object houses a source PropertySet and a Diff.
Note: This class is incorrectly named.
The property set that is currently being edited in the property table.
This node manager publishes properties from a PropertyValueSource.
Protobuf type
common.protobuf.tags.BasicPropertySetPBProtobuf type
common.protobuf.tags.BasicPropertySetPBProtobuf type
common.protobuf.tags.ExtendedBoundPropertySetPBProtobuf type
common.protobuf.tags.ExtendedBoundPropertySetPBProtobuf type
common.protobuf.tags.PropertySetDiffPBProtobuf type
common.protobuf.tags.PropertySetDiffPB
A wrapper around different types of PropertySets that can be Protobuf serialized.
Protobuf type
common.protobuf.tags.PropertySetPB
A wrapper around different types of PropertySets that can be Protobuf serialized.
Protobuf type
common.protobuf.tags.PropertySetPBProtobuf type
common.protobuf.tags.PropertyValuePBProtobuf type
common.protobuf.tags.PropertyValuePBA wrapper around different types of PropertySets that can be Protobuf serialized
This class is used to subscribe to a
PropertyPublisherReadOnly and consume the values
emitted by the publisher.Registry for dynamic suggestion sources for perspective component properties.
Created by carlg on 2/7/2017.
This custom PropertyTableModel adds the following features:
Adds filtering based on bean properties: All, Standard, Expert
Adds styles for the property name for dynamic props and bound props
Table model used to obtain property names and values.
This class represents a tree structure of properties.
Event for whenever a property in a PropertyTree changes.
A PropertyTreeOwner manages a set of
PropertyTrees for the various PropertyTypesObject attached to a property tree that controls which nodes may be written to and sync'ed to the
browser.
This represents a simple type system that is a bridge between documents/json which aren't very
strongly typed, and our/java's type system, mostly for the purpose of storing/using properties.
Created by carlg on 1/5/2017.
Indicates that the value provided cannot be cast to the correct type for the property.
Some basic functions that aide our use of properties, or help consolidate logic.
An editor for types which have a property editor.
An editor for types which have a property editor.
com.inductiveautomation.ignition.common.config.PropertyValue
com.inductiveautomation.ignition.common.config.PropertyValue
This interface represents a specific subset of functionality implemented by most property holders
(such as
PropertySet), used to retrieve property values.Add this inside a PropertyAmendments annotation to notify the system of a property that used to
be on a component but was removed.
Add this inside a PropertyAmendments annotation to notify the system of a property whose name
changed.
One row of the agent's structured reply: a path into the PROPS tree plus the JSON value to write
at that path, with a sentence explaining the change.
Envelope deserialized from the fenced
```json block in the agent's reply.Tree node that represents a scope of a component like "props" or "custom"
Tree node implementation for displaying the structure inside a single View.
Wraps a Property to be used with the
ConfigPropertyTable.Options dialog that pops up when the user tries to open a protected resource
Parent exception that captures other exceptions while deserializing an object from its Protobuf
form
Parent exception that captures other exceptions while serializing an object to its Protobuf form
Utilities for converting between Protobuf's Json representation (
Value) and Gson's
(JsonElement).A Protobuf based serialization handler.
A builder for creating a ProtoRpcSerializer.
Thrown when a model provider's configuration cannot produce usable credentials — a missing or
blank API-key environment variable, or a
SecretConfig that resolves to nothing.The ProviderContext provides access to important information, tools, and systems under the
appropriate Tag Provider.
Does a case-insensitive filter on provider name when browsing children.
Interface representing lifecycle events that can occur within a tag provider.
Event fired when the redundancy state of the provider changes.
Specific kind of PushException indicating that a push attempted to create a resource but a
resource with the same path already exists.
Which sort of collision was found, which decides the remedy the message offers.
Thrown by ProjectManager to indicate there was a problem applying the ChangeOperations in a push.
Deserializes a push notification message from the provided input stream.
A listener for "push notifications" (out of band events broadcast from the gateway).
An adapter to send arbitrary types over the Designer/Client's "push notification" API, allowing
the gateway to initiate actions out of band.
Created by colby.clegg on 10/27/2014.
A utility class for converting Jython's keyword argument signature (
PyObject[], String[])
into more useful Java base classes.A specialized map for handling keyword arguments in scripting functions.
This class represents any "scope" in the SFC system, and is fundamentally just an observable
dictionary.
An observer that gets notified when the scope is modified.
com.inductiveautomation.sfc.api.PyChartScope
com.inductiveautomation.sfc.api.PyChartScope
A Jython-friendly wrapper for Ignition
Dataset objects.An
ElementExtractor over Jython object graphs: PyDictionarys are the map elements
and PySequences are the array elements.Protobuf type
common.protobuf.DictEntryPBProtobuf type
common.protobuf.DictEntryPB
org.python.core.PyDictionary
org.python.core.PyDictionary
A Jython wrapper for Ignition
DocumentArray objects.A Jython wrapper for Ignition
Document objects.A Jython wrapper for Gson
JsonArrays.A Jython wrapper for Gson
JsonObjects.A
PyIterator that wraps a Java Iterator of PyObjects, providing a
standard Python iterator interface.Protobuf type
common.protobuf.PyAsJsonPBProtobuf type
common.protobuf.PyAsJsonPBProtobuf type
common.protobuf.PyObjectPBProtobuf type
common.protobuf.PyObjectPBCarries a Jython
PyObject to a peer by Java serialization, whatever its Python type: a
string, a list of values, a dict, or a Java object Jython wraps.A Python wrapper for the
Plaintext class, allowing it to be used as a context manager in
Jython scripts, which means it can be used in a with...as statement.Allows tag properties to be expressed as a PyDictionary, which makes tag editing via scripting
much easier.
Extension of ArrayList to allow a list of PyTagDictionaries to be easily identified
Indicates that the data in SendRequestResult is actually a stringified PyObject.
An
EditActionHandler for PythonTextAreas which takes care of the basic Copy / Cut
/ Paste / Delete actions.A User implementation that delegates to another user object, but has some methods that are more
scripting friendly.
Represents a polygon made of 4 points.
This class is a path to anything in Ignition, across any system.
A builder to assist in constructing
QualifiedPaths.Protobuf binary adapter for
QualifiedPath.Represents an adapter for processing and normalizing
QualifiedPath objects.
com.inductiveautomation.ignition.common.QualifiedPath
com.inductiveautomation.ignition.common.QualifiedPath
Filename: QualifiedPathTransferable.java Created on Aug 06, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
This class provides utilities related to
QualifiedPaths.Represents a value with a DataQuality invalid input: '&' timestamp attached to it.
Protobuf binary adapter for
QualifiedValue.since 8.0
This extension of PropertySet adds support for retrieving the quality of properties, generally
for the purpose of bound property values.
com.inductiveautomation.ignition.common.model.values.BasicQualifiedValue
com.inductiveautomation.ignition.common.model.values.BasicQualifiedValue
Base interface is com.inductiveautomation.ignition.common.model.values.QualifiedValue
Base interface is com.inductiveautomation.ignition.common.model.values.QualifiedValue
Created by carlg on 1/10/2017.
Deprecated.
QualityCode contains a 32-bit integer code and optionally a diagnostic string.
Protobuf binary adapter for
QualityCode.This class currently extends StringPropertyEditor, to present the quality code as a string.
This class is a type of exception that is used to communicate a QualityCode based result.
com.inductiveautomation.ignition.common.model.values.QualityCode
com.inductiveautomation.ignition.common.model.values.QualityCode
A filter for quality levels.
A builder for creating a QualityLevelFilter.
Wire-friendly subset of
QualityLevelFilter for the historian query binding config: the
four levels the DataPointQueryOptions builder accepts, as a pure data record, giving
per-level control over which qualities a query admits.A component that monitors the quality of its properties' values.
This class provides some basic functions for creating derived QualityCodes and values.
Represents the information associated for any quarantined data.
The
QuarantineInterface provides a common API for handling quarantined data operations.Receives the points a query returns, for one point type, along with per-key failures and
watermarks.
An object to fetch a dataset from a data source entity with a set condition and parameters.
A point type that can be queried, tied to the query options that read it.
Agent powering the "Ask AI" popup on the Query Browser.
Composes the Query Browser's state into the host-context blocks sent to
QueryBrowserAgent; the framework appends the canonical references block and the user's prompt
after them.Write-back callbacks invoked when the user clicks an Apply button.
DB Query Browser–specific
AbstractSchemaPromptAssist that resolves the active datasource
from the panel's current snapshot.Frozen view of the Query Browser editor at the moment the user submits an AI prompt.
Stores queries prepared for execution - that is, with columns quoted, etc.
Interface that all config objects that represent query sources must implement.
This is the designer-scoped interface that 3rd party module authors need to implement to add new
query types.
This class must be extended by authors of new query types.
The query context provides information about the overall query that might be useful to
aggregation functions.
Deprecated.
use the Historian
QueryEngine pipeline.Created by carl.gould on 3/4/2015.
Reads historical data for a historian: browsing, raw, aggregated and complex point queries, plus
the capabilities and node metadata the query pipeline uses.
Resolves a
QueryEngine for a given source.A utility class that helps extract filters from the `filters` component object property which
when read from the PropertyTree is a QualifiedValue.
Handle returned by
QueryPipeline.run(DataPointQueryOptions, ResultWriterOptions, RowSink): completion, cancellation and progress.Like QueryNode, but with an additional property to let us know the name of the Named Query
parameter this node represents.
When creating the
QueryHolder, we parse the text the user input into string chunks and
tag chunks.Base of all query keys: identifies one queried series and the point type it yields.
Options for querying a queryable
TemporalPoint type: the query keys, the point type, an
optional time range, and an optional return size.Protobuf type
common.protobuf.AggregatedQueryOptionsPBProtobuf type
common.protobuf.AggregatedQueryOptionsPBProtobuf type
common.protobuf.BoundingOptionsPBProtobuf type
common.protobuf.BoundingOptionsPBProtobuf type
common.protobuf.RawQueryOptionsPBProtobuf type
common.protobuf.RawQueryOptionsPBRepresents parameter metadata (type and datatype) for query binding parameters.
Runs queries through the modern pipeline and streams the assembled rows into a
RowSink.Pipeline-wide tunables.
Reads the current value of the live tag behind each historized path, which the pipeline offers
as a query's post bound when no stored sample follows the range.
Progress event emitted by
QueryHandle.progress().This is the "ConfigObject" for the Query data source.
Represents a single query in a tree of nested queries.
Created by carl.gould on 3/5/2015.
Final result of a
QueryPipeline run.This object represents the results of a query / nested query structure generated by a report's
query datasource.
This interface is not used directly for rpc calls, because methods here relies on streaming.
Protobuf type
QuerySFDataPBProtobuf type
QuerySFDataPBA QuerySource executes a type of report query.
Used to handle multiple executions of a nested query.
Mode selector of the
historian.query binding panel.Filename: RadarChart2TermFinder.java Created on Aug 5, 2014 Author: Kathy Applebaum Copyright
Inductive Automation 2014 Project: Vision
The
RadialGradientPaint class provides a way to fill a shape with a circular radial color
gradient pattern.A concrete subclass of PDFShadingPattern which implements pdf radial (type 3) shadings.
A persistent circular buffer system that uses a
RandomAccessFile as the backing store.A component that displays polling rate options
Processes raw
AtomicPoints read by RawQueryKeys.Key for querying the raw points of a path; its point type is
StandardDataPointType.ATOMIC.Protobuf binary adapter for
RawQueryKey.Options for a raw query; the query key is a
RawQueryKey.Builder for
RawQueryOptions.Protobuf binary adapter for
RawQueryOptions.This class provides a bunch of core functionality for loading and saving Ribs documents.
Does special Mac-only initialization.
This is Ribs version of the AttributesPanel
LZW decompressor
The RMDocument class represents a ReportMill document and is also an RMShape subclass, so it can
be a real part of the document/shape hierarchy.
This inner class models MenuBars, Menus and MenuItems as TreeNodes.
An inner class to act as RMDocument's Tool.
This RMEditor subclass customizes RMEditor behavior for Ribs.
Handles drop listener stuff for an RBEditor.
This ribs shape painter adds support for clipping child shapes (like for scrollpane).
This RMEditor subclass customizes RMEditor behavior for Ribs.
This class manages the inspector panel.
This class contains static utility methods for generically getting and setting values on any
object using a key chain string.
This class shows the current set of keys relative to the current editor selection in a browser
and lets users drag and drop them to the editor.
This class manages a list of objects provided by a rib file's owner to facilitate binding to UI
controls.
List Model implementation for lists using bind key.
This page subclass represents an RJPanel in the ribs designer.
Provides for Swing UI editing of RBPage properties.
Simple class to run Ribs preview apps.
An inner class to be a glass pane for the editor while testing rib files in editor window.
The base tool class for ribs tool.
Represents a front-end react component that can be mounted.
Used to build a json object representing a config section form, used in the React front end.
Reader interface for reading from a data store.
A DocumentModel that will never be editable.
Use this annotation to list properties that should not be editable.
Runs actions under the read or write side of a
StampedLock: withReadLock and
withWriteLock, plus *Interruptibly variants for cancellable callers.Options dialog used to allow users to immediately (or temporarily) elevate their comm mode for a
particular operation
Filename: RealtimeDateRangeTermFinder.java Created on Dec 06, 2013 Author: Kathy Applebaum
Copyright Inductive Automation 2013 Project: Vision
Tag history query param implementation that dynamically returns start and end dates based on the
current time.
Extracts a node id, timestamp, value and quality code from one backend record.
Per-column metadata passed to
RecordExtractor.extractValue(Object, ColumnInfo).
com.inductiveautomation.sfc.recorder.RecordingMeta
com.inductiveautomation.sfc.recorder.RecordingMeta
Protobuf type
sfc.protobuf.RecordingMetaPb.ChartMetaPbProtobuf type
sfc.protobuf.RecordingMetaPb.ChartMetaPbRepresents a rectangle - a Quadrilateral with parallel sides.
This class handles editing of rectangle shapes.
Util class which contains helpful Reducers
Holds a list of change operations that need to be applied to a redundant node's provider to bring
it into sync with the other node's provider.
Used by the redundancy manager to execute tasks on both redundant nodes, and to pass one-shot
messages from the master to the backup.
Register an instance of this class using
RedundancyManager.addMessageHandler(String, RedundancyMessageHandler) Whever a
message is received from the peer node (with the protocol string that is registered for this
handler), this handler will fire.
com.inductiveautomation.ignition.common.messages.RedundancyMessage
com.inductiveautomation.ignition.common.messages.RedundancyMessage
These are all of the redundancy settings for both master and backup.
A RedundancySignature is used to compare an object between gateways.
See the
RedundancyDiff class Javadoc for a full rundown on how this class is used.Empty implementation of
RedundancyStateListener that can be subclassed.Generic exception that can be used in redundancy synchronization
Verifies that the caller behind a GAN
SecurityContext is this gateway's own redundant
peer: the master/backup sibling that shares this gateway's system name with the opposite
redundancy role, calling over a direct (non-proxied) connection.A very general purpose interface to provide a reference to an object that may or may not be
available.
Represents a range of alphabetical values from a starting character to an ending character or
string.
Represents a numeric range with specified start, end (inclusive), step, and format.
The resolved payload of one prompt reference — what a
PromptAssist.Option.Insert's
supplier produces at submit time and the framework attaches to the outbound message.A text-modality body — the wire form is the exact text embedded between
<reference>
tags.Concrete
ReferenceBody.TextBody that carries only its rendered wire text.Encapsulates the logic used to start up all bindings in a view and its components.
Represents the choice to make when reference(s) are found when renaming a resource.
A property on a resource that references another resource.
Helps build a
ReferenceProperty, which represents a property on a config resource that
references another resource by name.This class keeps track of references for the XMLSerializer.
Represents a reference to another resource, and the logic to update that reference.
A collection of utility methods and classes to handle all the of the Java Reflection calls need
to wire and fire bindings.
Abstract JsonDeserializer that will use the default Gson reflective deserialization logic, and
then let subclasses perform further logic on the deserialized object.
This is a message that can be passed through redundancy and will reflectively invoke a function
on the far side.
Used to annotate a type that should generate a reference schema instead of a reflectively
discovered inline schema.
A class for building regular expressions like a string buffer.
A regular expression based implementation of
AbstractFormatter.This class just runs a simple modal panel to register user name and email on first run.
Describe this class
Similar to LinearGradientPaint, but this one specifies it's points as percentages of the
user-space bounds of the object it will fill.
The relative path provider, as the name suggests, is used for building relative paths.
Similar to RadialGradientPaint, but this one specifies its points as percentages of the
user-space bounds of the object it will fill.
This invocation handler simply relays invoke to another invocation handler, except that it
intercepts equals(Object), hashCode(), and toString()
Created by colby.clegg on 11/11/2015.
An interface used to abstract settings for remote objects, like realtime providers, or historical
providers, used by the RemoteProviderChoicePanel
This history query executor executes a query against a remote gateway.
A subinterface of TreeNode that adds some information to help it render.
Used in conjunction with
AbstractRM2DShape to determine what output should be produced:
vector graphics, or raster (at specific DPIs).For a given list of FlowCells, this class assigns a
RenderInfo to each cell.RenderOptions is an abstract class that represents the options needed to create a renderer for a
collection of "pens" or series that share the same basic render style but have different series
specific options such as color.
A RenderStyle represents a specific configuration of chart renderer.
Algorithm for reordering items in a list.
Turns a model's reply text into the type a typed
AgenticHarness.send(String, Class) asked
for.Renders one model reply into a Swing view with optional apply actions.
Builds the
ReplyRenderer used for one assist session.The Swing view a
ReplyRenderer produces from one model reply.A wrapper around Ignition's Dataset that is understandable by the reporting system Created by
carl.gould on 2/5/2015.
Filename: ReportActionUtils.java Created on Feb 09, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Used to let the Gateway send a push notification to projects when the report completes execution.
Filename: ReportConverter.java Created on Jul 20, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
A file for Snap reports.
Holds the data configuration for a report, including parameters and data sources.
Protobuf type
reporting.protobuf.ReportDataConfigurationPbProtobuf type
reporting.protobuf.ReportDataConfigurationPbPromptAssist that surfaces the entries already present in the data dictionary
when a Reporting updateData script runs — namely the report's parameters and the output
keys of any data source declared upstream of the current script.This is the interface that module authors who wish to add a new report data source must implement
and register in the Gateway scope.
Read-only report-data lookups the Reporting
updateData script agent uses to ground its
suggestions in one report's actual configuration: the parameters already populated into
data, and the source of script data sources declared upstream of the script being edited.Created by carl.gould on 3/3/2015.
Builder pattern because the number of parameters is getting to be insane.
ReportLoggerEx is a logging class that extends LoggerEx to add errors to the
ReportExecutionData's error list when a WARN or ERROR level messages are logged.
ReportExecutionData contains a data
Map<String, Object> from a report datasource, as well
a List<String> of any warnings that were generated when the execution attempted to
collect data.Protobuf type
reporting.protobuf.ReportExecutionDataPbProtobuf type
reporting.protobuf.ReportExecutionDataPbFilename: ReportExecutionStatus.java Created on Apr 21, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: ReportExpressionEditor.java Created on Mar 09, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: ReportFormat.java Created on Feb 04, 2015 Author: Kathy Applebaum Copyright Inductive
Automation 2015 Project: Reporting
Central registry for Reporting module constants, IDs, and custom shape registrations.
Created by carl.gould on 6/8/2015.
Is the tabbed workspace for reports, extended to allow Report Resource types, and their
customized leaf node structure.
Background worker that resizes a byte[] to 250x300 for display in thumbnails/preview panels.
Utility class for Reporting RPC operations.
This class exists to isolate the reporting designer hook's vision dependency, so that it is a
soft dependency and the reporting module can exist as a standalone Module.
This class is used as a helper object by RMDocument to generate a report.
This class is used as a helper object by RMDocument to generate a report.
An inner class to provide a hook for converting objects (like NSArray to List, etc.).
An inner class to provide a hook for converting objects (like NSArray to List, etc.).
An interface for classes than want to know about filled shapes.
An interface for classes than want to know about filled shapes.
A base class that loads and runs reports.
A shape class to represent multiple pages of shapes.
Represents a parameter for a report.
Protobuf type
reporting.protobuf.ReportParameterPbProtobuf type
reporting.protobuf.ReportParameterPbAuthor: Perry Arellano-Jones Year: 2015
Author: Perry Arellano-Jones Year: 2015
Filename: ReportPopupInitializer.java Created on Jul 28, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
A thread-local accessible context that should be non-null while a report is rendering.
Primary object representing a Report resource in Ignition.
RPC Interface for reporting operations.
Represents a scheduled execution of a report.
Filename: ReportSchedulerTask.java Created on Feb 06, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: ReportScheduleRunner.java Created on Feb 06, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Adapter for PyDictionary to be serialized and deserialized by the ProtoSerializer.
Scripting functions for the Reporting module.
Information about a report.
Filename: ReportScriptingFunctionsPyWrapper.java Created on Mar 27, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
Filename: ReportStatusManager.java Created on Apr 02, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: ReportStatusWatcher.java Created on Apr 20, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
filename: ReportViewer.java author: Perry
ReportViewerBeanInfo.java author: Perry
This is the event object that will sent through the event bus to generate a "refresh" event
here in the delegate.
Author: Perry Arellano-Jones Year: 2015 Project: Reporting 3.0
Represents an asynchronous request.
A request to a server.
Wrapper around an HttpServletRequest to include some helpful data for
RouteHandler
instances.Convenience class to request focus on a component.
Carries a message meant for whoever made the request, for the responses where the fault is the
caller's and there is nothing to diagnose on the server.
Writes a
RequestRejectedException as its message alone.Provides a mechanism to wait for one or more asynchronous requests to complete.
An annotation to provide a hint in the OpenAPI schema that the field is required.
Reserved Security Levels and their descriptions.
Local context state for the standalone AI wizard.
A newer explicit value disagrees with an earlier explicit value.
Context concepts that can be supplied by launch selection, controls, or prompt references.
One resolved context slot value.
Source of a context value.
Protobuf type
common.protobuf.CreateOperationProtobuf type
common.protobuf.CreateOperationProtobuf type
common.protobuf.DeleteOperationProtobuf type
common.protobuf.DeleteOperationProtobuf type
common.protobuf.ManifestOperationProtobuf type
common.protobuf.ManifestOperationProtobuf type
common.protobuf.ModifyOperationProtobuf type
common.protobuf.ModifyOperation
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionDiff.AbsoluteDiff
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionDiff.AbsoluteDiff
com.inductiveautomation.ignition.common.resourcecollection.ChangeOperation
com.inductiveautomation.ignition.common.resourcecollection.ChangeOperation
This sealed interface represents all supported resource "capabilities".
An immutable collection of
ResourceActions, with type-safe getters for
easy consumption in subsystems.Declares how a config resource type participates in AI features: how much of it is visible to
agents, and what a diagnostic digest should know about it.
How much of a resource type an AI agent may see.
Part of a
ResourceTypeMeta that provides custom auditing of the resource.Represents a change event in a resource collection.
Responsible for encoding and decoding configuration
Resource objects.Represents a change event in a resource collection.
The
ChangeOperations associated with a resource collection when pulled from the Gateway.An absolute diff, i.e.
An effective diff, i.e.
A resource collection lifecycle is a specialized
AbstractLifecycle that is designed to
make implementing lifecycle management for a RuntimeResourceCollection easier.A factory for creating and managing
ResourceCollectionLifecycles.ResourceCollectionListener get registered with the resource collection manager.
Contains the metadata for an entire resource collection, including inheritance linkage
information.
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionManifest
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionManifest
Used by the abstract tabbed workspace, this is all the information the workspace needs to know
about your resource type so that it can correctly integrate with the nav tree.
What something contributes to a diagnostic digest: how its resources fail, where their log events
are, and what live state is worth reporting.
A digest section heading and the function that renders its body, evaluated once per digest
request.
A delegate on
ResourceTypeMeta that provides an Entity that represents a resource
type.Unique ID for a resource, containing the resource collection name, module id, type id, and folder
path.
com.inductiveautomation.ignition.common.resourcecollection.ResourceId
com.inductiveautomation.ignition.common.resourcecollection.ResourceId
Serializes/Deserializes a ResourceId from a JSON element.
Specific kind of PushException indicating that a push targeted a resource that is not there, as
discovered while validating the push rather than by the caller's own read beforehand.
Deprecated.
Represents a full resource path from the file system, relative to a particular resource
collection.
com.inductiveautomation.ignition.common.resourcecollection.ResourcePath
com.inductiveautomation.ignition.common.resourcecollection.ResourcePath
com.inductiveautomation.ignition.common.resourcecollection.ResourceType
com.inductiveautomation.ignition.common.resourcecollection.ResourceType
com.inductiveautomation.ignition.common.resourcecollection.Resource
com.inductiveautomation.ignition.common.resourcecollection.Resource
Provides read access to a
.gwex ZIP file during import.A reference represents when a property of a resource references another resource.
Part of a
ResourceTypeMeta that provides a way to find references to other resources.All of the references held by a single resource to one other resource, along with the decoded
resource that holds them.
Contains various meta information used by the system that automatically creates routes for a
resource type.
A Designer session and their open resources
Represents the content of a resource within the context of a
ResourceId, i.e.
com.inductiveautomation.ignition.common.resourcecollection.ResourceSignature
com.inductiveautomation.ignition.common.resourcecollection.ResourceSignature
com.inductiveautomation.ignition.common.resourcecollection.Snapshot
com.inductiveautomation.ignition.common.resourcecollection.Snapshot
A delegate that provides health checks and metrics for a particular resource type.
Deprecated.
Renders the contents of a
DesignerResourceMetaRegistry as a markdown summary suitable for
injection into an AI agent's system prompt via Agent.getAdditionalContext().A ResourceTypeMeta provides metadata and performs delegate actions that pertain to a particular
type of configuration resource.
A ResourceValidator is a class that can validate the state of a resource's config object
A main editing area for the designer.
A resource workspace frame is a dockable frame that will be available for display when its
associated workspace is selected.
Provides write access to a
.gwex ZIP file during export.The result of an HTTP request.
The response.
Structured reply shape produced by inline assist sessions.
Prose-only informational reply.
Apply-able reply — prose plus a host-interpreted payload.
An exception wrapped around a failed response.
Record class that represents an OpenAPI Response Object
Formats an object returned by a
RouteHandler into a string suitable for the body of an
HTTP response.Record class that represents an OpenAPI Responses Object
Specialized serializer to accommodate the specification's format of this object doesn't
naturally work with GSON
Interface to indicate that the implementing class needs to implement a flag that indicates
whether the redundant backup is in the midst of a gateway restore.
Deprecated.
use the Historian
QueryEngine pipeline.Protobuf type
common.protobuf.ResultPB
com.inductiveautomation.ignition.common.browsing.Result
Protobuf type
common.protobuf.ResultPB
com.inductiveautomation.ignition.common.browsing.Result
The results of a browse operation.
Protobuf binary adapter for
Results.helper class for processing JDBC ResultSet objects
Protobuf type
common.protobuf.InnerResultsPBProtobuf type
common.protobuf.InnerResultsPBProtobuf type
common.protobuf.ResultsPB
com.inductiveautomation.ignition.common.browsing.Results
com.inductiveautomation.ignition.common.browsing.Results
Protobuf type
common.protobuf.ResultsPB
com.inductiveautomation.ignition.common.browsing.Results
com.inductiveautomation.ignition.common.browsing.Results
Options for how query results are written: object type, result format, JSON shape and column
naming.
Builder for
ResultWriterOptions.The kind of object a query returns.
How the data is laid out in the result.
Protobuf binary adapter for
ResultWriterOptions.Protobuf enum
common.protobuf.ObjectTypePBProtobuf enum
common.protobuf.ResultFormatPBProtobuf type
common.protobuf.ResultWriterOptionsPBProtobuf type
common.protobuf.ResultWriterOptionsPBSent by the frontend when a page reconnects the websocket to an existing PageModel
Encapsulates all information passed across a cross-gateway retarget, or a same-gateway restart
for when the jars need to be re-downloaded.
A
HistoricalNodeTree that propagates retirement up the path hierarchy.Which retirement state of nodes a historian browse includes; the value of
HistorianBrowseTraits.RETIREMENT_STATE.Tested are included with
HandlerStage.Deprecated.
A type of
PersistentData that can have a success and a tried state as well as a failure
reason.Represents the state of the data
Row-shape selector.
Specifies how data is returned for history queries.
This really just exists because property sets don't like generic collections
Interface for enums that have reverse values (ie flex direction)
This class helps to load and manage panels and windows of GUI components in the form of a rib
file, which is a simple XML description of UI controls.
An interface for objects that want notification about event processing.
An interface for objects that want notification about event processing.
A ribs version if RXArchiver to use RJHelpers to load classes.
An AWTEventListener implementation to capture isAltDown(), isMetaDown() and notifications:
appActivated, appDeactivated.
An interface for objects that want notification about event processing.
An Ribs event queue subclass to capture isAltDown(), isMetaDown() and send Ribs.EventListener
notifications.
An Ribs event queue subclass to capture isAltDown(), isMetaDown() and send Ribs.EventListener
notifications.
An interface for an exception handler.
A gallery panel for ribs Swing components.
FocusListener implementation to add nice editing behavior to CallbackText.
This class provides Swing GUI editing for the currently selected shapes location and size.
This class offers a number of useful general purpose utilities used by ribs classes.
This Error subclass lets us rethrow exceptions.
This class encapsulates additional information for uncommon actions.
This component displays a hierarchy of data like a JTree, however, it does it with a number of
distinct JTables layed out horizontally.
This component displays a hierarchy of data like a JTree, however, it does it with a number of
distinct JTables layed out horizontally.
AbstractBrowserModel - A public interface for controlling a browser.
Provides Ribs management for RJBrowser.
This class is never instantiated directly - it is the superclass for JButtonShapes invalid input: '&'
JLabelShapes.
This is a JCheckBox subclass to support a "Three State" mode.
Provides some extra Ribs management for RJCheckBox.
A ColorWell subclass that handle a whole grid of color swatches, including drag and drop support.
A ColorWell subclass that handle a whole grid of color swatches, including drag and drop support.
Provides Ribs specific support for color well.
Provides an RMShape representation of an RJColorDock.
A class to act as color dock's inspector.
This class provides Swing UI for selecting a color.
This class provides Swing UI for selecting a color.
An interface for the object(s) that provide and receive color panel color.
An inner class to act as an image color picker.
An inner class to act as an image color picker.
This class is a label subclass with a popup menu attached to implement popup menus.
This Swing control class displays a color value and kicks off the ColorPanel when clicked.
This Swing control class displays a color value and kicks off the ColorPanel when clicked.
Provides Ribs specific support for color well.
Provides Ribs specific support for color well.
An RMShape subclass for RJColorWell.
A class to act as color well's inspector.
A class to act as color well's inspector.
This class acts as a stand-in for classes not directly supported by the Ribs design application.
An RMShape subclass for RJCustomView, that stands in for any referenced JComponent subclass.
Provides RMTool implementation for RJCustomViewShape.
This class is a Swing/Ribs Font panel for selecting fonts.
An interface for Font Panel Model.
This class is used to provide Ribs functionality to Swing JComponents.
Copyright (c) 2004 ReportMill Software, Inc.
This interface is implemented by anybody that wants to use the RJStringListTool widget in their
inspector.
This class is a label subclass with a popup menu attached to implement popup menus.
This class is a label subclass with a popup menu attached to implement popup menus.
Implements Ribs helpers methods for RJMenuButton.
Implements Ribs helpers methods for RJMenuButton.
RMShape subclass for RJMenuButton.
Provides RMTool implementation for RJMenuButtonShape.
A class to act as color well's inspector.
This class is the root of all Rib files and the unified point of access for all of its child
components (and, optionally, it's window).
A helper class to add Ribs specific functionality to RJPanel.
Provides inspector for RJPanelShape.
This class draws the buttons in the border chooser, plus holds utility methods for choosing
borders
An RMShape subclass to represent Swing components.
This class encapsulates a list of child components which can be switched in and out, like a tab
view without the tabs.
A class to act as switch pane's inspector.
An inner class to act as a RJTextShape's tool.
This class has the behavior of a slider, without boundaries (so you can set values beyond the
visible min and max).
This class has the behavior of a slider, without boundaries (so you can set values beyond the
visible min and max).
Ribs Helper for RJThumbWheel.
An RMShape subclass for RJThumbWheel.
An RMTool implementation for RJThumbWheelShape.
An inner class to act as RJThumbWheelShape Tool
Copyright (c) 2004 ReportMill Software, Inc.
Copyright (c) 2004 ReportMill Software, Inc.
Created by carl.gould on 7/14/2015.
Created by carl.gould on 7/20/2015.
An AWTEventListener to listen for app activate/deactivate and modal dialog activate/deactivate to
hide or show hide-on-deactivate windows and disable always-on-top for always-on-top windows.
This class provides an anim agent to fade and scale a shape in over time.
This class provides an anim agent to drop a shape over time as if it's pulled by gravity.
This class provides an anim agent to insert text letters sequentially with typewriter sound
effect.
This class is the base class used for creating sophisticated animation effects, like gravity.
This class represents a timer for animation, holding things like a current time and max time.
This class represents a timer for animation, holding things like a current time and max time.
An interface for classes that want to receive notification of certain animator events.
An interface for classes that want to receive notification of certain animator events.
A shape that can orient its children along a bezier path.
A shape subclass that adds the ability to be rotated about an arbitrary point.
Provides Swing UI editing for RMAnimPathShape.
This class holds a number of convenient static methods used for animation stuff.
This class holds a number of convenient static methods used for animation stuff.
Does special Mac-only initialization.
This is an applet implementation used to host an RMViewer in a browser.
This class handles RM document archival.
This class handles RM's legacy unarchival.
This interface defines the method necessary to add archival support to an object.
A collection of array utility methods.
A collection of array utility methods.
RMASNode is the class used by the parser to construct a tree representation of an ActionScript
file based on the parser grammar.
RMASParser parses ActionScript to generate the byte-codes and binary encoded actions that are
executed by the Flash Player.
This class has a bunch of convenience utility methods from drawing lines, RMRects, buttons, etc.
This class has a bunch of convenience utility methods from drawing lines, RMRects, buttons, etc.
This class models a simple bezier curve, providing methods for extracting points, distance
calculation, bisection, hit detection and such.
This class models a simple bezier curve, providing methods for extracting points, distance
calculation, bisection, hit detection and such.
Hit detection for bezier and a line.
Hit detection for bezier and a line.
An implementation of interface CharStream, where the stream can contain any binary data.
This class adds a blur to a given shape.
Swing UI editing for RMShadowEffect.
A class to represent Swing borders for JComponentShape.
A subclass for bevel border.
A subclass for empty border.
A subclass for etched border.
A subclass for line border.
A subclass for etched border.
This stroke subclass strokes the rectangular border of a given shape, with option include/exclude
individual sides.
This class is like a StringBuffer for bytes instead of chars.
This shape is used as the bar chart component for the reporting module.
A text shape subclass used to form the basis of a table.
Provides info for a column in a cell table.
This class represents a line that divedes a cell row or cell column.
This shape manages a row of cells.
Manages a table of RMCells, which is really a stack of RMCellRows.
An emboss effect that uses contour fill as its bump map.
Swing UI editing for RMChiselEffect.
Utility methods for Class.
Clipboard utilities.
This class has utility methods to code and decode into various different formats: hex, ASCII85,
base 64.
This class has utility methods to code and decode into various different formats: hex, ASCII85,
base 64.
This class decodes LZW encoded bytes.
This class represents an RGBA color, just like Java.awt.Color.
This class represents an RGBA color, just like Java.awt.Color.
A multi-stop gradient inspector.
JPanel can be added to the configuration panel of a ScriptableChart to enable users to edit the
chart's configuration script
RMFill implementation of a shape-burst gradient.
Marker interface marking Legacy components inheriting from
AbstractJ2DShape which have now been replaced by
AbstractRM2DShape.Manages a table of RMCells, which is really a stack of RMCellRows.
This class represents a groupable data matrix (or crosstab).
A tool to set formatting options on a simple table from a list of templates.
A text shape subclass used to form the basis of a table.
Provides Swing UI editing for RMCell shapes.
Provides info for a column in a crosstab.
This class represents a line that divides a cell column.
This class represents a line that divides a cell row or cell column.
Provides ReportMill UI editing for CellDivider shape.
This class wraps a shape around a crosstab to constrain the crosstab's bounds to a region on the
page.
Provides UI inspector for crosstab frame.
This shape manages a row of cells.
This class represents a line that divides a cell row.
This class provides support for UI editing of RMCrossTab.
A class for reading file of comma separated values, or really any separated values.
This class creates an approximating polygon for a given RMFunction.
A function whose value is the inverse of another function ie.
A function whose value is determined by interpolating through a set of sample points using
Neville's Method.
A function scaled such that f(1) == 1
This class is like a StringBuffer for bytes instead of chars.
This class helps read encoded basic data types, from a raw byte stream.
This class is used as a proxy for objects passed to document's generateReport() method.
This class is used as a proxy for objects passed to document's generateReport() method.
This datasource provides data in the form of a search result from Google Search.
This class provides a datasource representing a JDBC database fetch.
This class is used as a proxy for objects passed to document's generateReport() method.
This is just a SimpleDateFormat subclass to support RM archiving and legacy formats.
This is just a SimpleDateFormat subclass to support RM archiving and legacy formats.
Token literal values and constants.
Token Manager.
Utility methods for Java Date.
The RMDocument class represents a ReportMill document and is also an RMShape subclass, so it can
be a real part of the document/shape hierarchy.
The RMDocument class represents a ReportMill document and is also an RMShape subclass, so it can
be a real part of the document/shape hierarchy.
An interface to define objects that want to get document notifications.
This class provides UI for configuring an RMDocument.
An inner class to render Page control.
Strokes a path with 2 lines of different widths, with an arbitrary separation (d) between them.
Swing UI editing for RMDoubleStroke.
This class subclasses RMViewer to support RMDocument editing.
This class subclasses RMViewer to support RMDocument editing.
Handles editor methods specific to clipboard operations (cut, copy paste).
Handles editor methods specific to clipboard operations (cut, copy paste).
Handles editor methods specific to event operations.
Handles editor methods specific to event operations.
This class is a container for an RMEditor in an enclosing scroll pane with tool bars for editing.
Menu bar for RMEditor pane.
Tool bar for RMEditorPane.
Some utility methods for RMEditorPane.
This class offers some methods to provide "proximity guides" for RMEditor.
This class offers some methods to provide "proximity guides" for RMEditor.
Handles editor methods specific to rulers.
Handles editor methods specific to rulers.
The root shape for RMEditor.
A Java2D painter subclass for editor.
A Shape painter subclass for painting shapes in an editor.
Handles editor methods specific to clipboard operations (cut, copy paste).
Handles editor methods specific to clipboard operations (cut, copy paste).
A text editor subclass suitable for editing RMText shapes in the RMEditor.
A text editor subclass suitable for editing RMText shapes in the RMEditor.
This class contains all of the methods to display and handle RMEditor UI methods.
A Viewport for painting foreground.
An RMFill subclass for drawing effects that rely on shape's standard fill/stroke.
A PDF helper/writer class for RMEffect.
Provides a tool for editing RMFills.
Renders a given shape with an emboss effect.
Inspector for RMEmbossEffect.
This class represents an entity for an RMDataSource.
Utilities for enums.
This class is used to generate an Excel file from an RMDocument.
This class is used to generate an Excel file from an RMDocument.
This class is used to generate an Excel file from an RMDocument.
A simple subclass of RuntimeException that RM uses to indicate errors that don't always really
need to be declared or caught.
A simple subclass of Error that RM uses to indicate errors thrown by RM.
This file is just meant to hold various utility methods that customers have asked for.
This file is just meant to hold various utility methods that customers have asked for.
Movie category constant type.
A movie class.
A movie role class.
A movie class.
FileChooser utilities.
A JFileChooser subclass that gets (and saves) its size to preferences.
Utility methods for file.
This class represents a simple shape fill, drawing a given color in a provided path.
This class represents a simple shape fill, drawing a given color in a provided path.
This RMObjectPdfr subclass writes PDF for RMFill.
Provides a tool for editing RMFills.
This class write an RM document to a flash bufer.
This class is like a StringBuffer, except its for writing binary bit data instead of strings,
including signed and unsigned bit values, but, more importantly Flash file format primitives
(Tags, Rects, Colors, Matrices, records, etc.).
A flash shape subclass for buttons.
This flash shape subclass is for shapes that change size or color.
This class is responsible for writing simple RMShapes to a flash buffer.
A flash shape for rm sound shapes.
A flash shape for shapes with their own animator/timeline (like Switch shapes).
This class writes an RMText shape to flash.
A shape to layout children with flow.
Tool for RMFlowShape.
This class represents a font for use in rich text.
This class represents a font for use in rich text.
This class represents all the information about a font that is independent of size.
This class represents all the information about a font that is independent of size.
Provides some utility methods for Fonts.
An interface for RM format classes (they all should get/set format strings, format objects and
archive XML).
An interface for RM format classes (they all should get/set format strings, format objects and
archive XML).
This class represents a fill that draws a linear gradient between an arbitrary list of colors.
This class represents a fill that draws a gradient of colors from the basic fill color to the end
color.
Simple static class to represent a stop (they're immutable).
Swing UI editing for RMGradientFill.
The RMGraph class provides a template and the machinery for generating graphs.
The RMGraph class provides a template and the machinery for generating graphs.
An inner class for bar labels.
Returns the part rect.
An inner class for Legend.
This class generates (and represents) a RPG'd bar graph content.
An interface for a shape that renders a bar graph from bar graph pieces.
A simple implementation of the BarGraphView interface.
This class renders a bar graph in 3D.
This class represents the actual graph content (a place holder really).
Class creates ReportMill shapes and adds these shapes to a root node.
Returns a list of graph intervals given a range and count.
An inner class for Legend.
Provides UI editing for RMGraphLegend.
This shape is used by graph area to hold attributes of bars.
Provides UI inspection for GraphPartBars.
This shape is used by graph area to hold attributes of the value axis.
Provides UI editing for graph part label axis.
This shape is used by graph area to hold attributes of pies.
Provides UI inspection for GraphPartBars.
This shape is used by graph area to hold attributes of the value axis.
Provides UI editing for graph part series.
This shape is used by graph area to hold attributes of the value axis.
Provides UI editing for graph part value axis
This class generates (and represents) a RPG'd pie graph content.
An interface for a shape that renders a bar graph from bar graph pieces.
A simple implementation of the BarGraphView interface.
This graph renders a pie graph in 3D.
A shape class for a generated RMGraph.
This class represents a report generated graph.
An interface to identify generated graph shapes.
This class generates (and represents) a RPG'd bar graph area.
An interface for a shape that renders a bar graph from bar graph pieces.
A BarGraphShape implementation.
This class generates (and represents) a RPG'd line graph area.
This class generates (and represents) a RPG'd pie graph area.
An interface for a shape that renders a bar graph from bar graph pieces.
Represents the data in the sections of a merged or separated graph.
A class to represent a graph series, contains a list of series items.
A class to represent an individual item inside a graph series, including its key, group, value
and bar/wedge shape.
This class provides RMEditor inspector support for RMGraph.
This class is a smart List subclass used to hold objects from an original list broken down by
grouping keys.
This class is a smart List subclass used to hold objects from an original list broken down by
grouping keys.
This RMGroup subclass/inner-class represents a subset of a group up to the given endGroup.
This RMGroup subclass/inner-class represents a subset of a group up to the given endGroup.
This class simply manages a list of groupings and has some nice convenience methods.
This class simply manages a list of groupings and has some nice convenience methods.
This object represents an individual grouping with attributes like key, sorts, topN sort, etc.
This object represents an individual grouping with attributes like key, sorts, topN sort, etc.
This class encapsulates simple hit information of a given curve or line against another curve or
line.
This class encapsulates simple hit information of a given curve or line against another curve or
line.
Generates an HTML file.
Makes a path string from an AWT Path.
This class provides methods to create an xstring from HTML and RTF.
This class provides some utility methods for generating HTML suitable for wrapping other file
types.
This class generates HTML for a ReportMill RMDocument object.
Some useful Icon utilities and subclasses.
An icon implementation that renders a border on another icon.
An icon implementation that draws two icons.
An icon implementation that draws two icons.
An icon implementation that uses a JLabel.
A simple icon implementation to draw a given shape in a given color in a given size.
An icon implementation that renders a border on another icon.
An icon implementation that stretches another icon to specified with.
This class is a shape representation of an image.
This class manages image data.
This class manages image data.
An interface for classes that can handle image reading for RMImageData.
An interface for classes that can handle image reading for RMImageData.
The preferred method for seeding RMImageData with an image source.
A effect based on image filtering.
A kernel class for box filters (really?).
A kernel class for cone effects.
Extends Kernel with constructor which takes Kernel size and automatically generates a gaussian
matrix.
This class is used to fill a shape's path with an image.
This class is used to fill a shape's path with an image.
This RMFillPdfr subclass writes PDF for RMImageFill.
UI editing for RMImageFill.
Uses ImageIO or JAI to read an image, its basic info and its decoded bytes.
This class is a shape representation of an image.
PDF writer for RMImageShape.
Provides Swing UI for RMImage shape editing.
This class provides functionality to interpolate between two numbers given a ratio between 0-1.
Parameterizable bounce interpolator class.
An Interpolator subclass that can be used for periodic (ie looping) motion.
This class represent a method call and is used to set values on another object, either by calling
a "setFoo()" method or by directly setting the value of a public instance variable.
This class represent a method call and is used to set values on another object, either by calling
a "setFoo()" method or by directly setting the value of a public instance variable.
Implemented by any class that can interpolate themselves for animation purposes.
An archiver to read/write objects from/to JSON.
An interface so objects can provide archival class to archiver.
An interface so objects can provide archival attributes to archiver.
An interface so objects can provide archival values to archiver.
An interface so objects can set archival values from archiver.
Represents a node in a JSON tree.
A JSONTokener takes a source string and extracts characters and tokens from it to create
RMJSONNode(s).
The RMJSONException is thrown by the JSON.org classes when things are amiss.
Writes a JSON to string.
This class provides an optimized convenience for getting named values from arbitrary objects.
This class provides an optimized convenience for getting named values from arbitrary objects.
This is interface is implemented by objects that can get key values themselves.
This is interface is implemented by objects that can get/set key value themselves.
KeyAccessor - enclosed class for actually getting/setting values for a given object (class) and
key.
NoSetMethodException.
This interface is implemented by objects that want to handle getting key values themselves.
This interface is implemented by objects that want to handle getting keychain values
themselves.
This class evaluates a string expression on a given object: RMKeyChain.getValue(object,
expression).
This class provides the powerful RMKeyChain.valueForKeyChain() functiionality.
This is interface is implemented by objects that can get key chain values themselves.
A class to evaluate keys on lists.
This class represents an RM function call (method plus args) and defines a bunch of built-in
functions.
This class holds all of RM's built-in key chain functions.
Token literal values and constants.
Token Manager.
An animation object that holds an object key/value for a given time.
A list implementation that tries to get objects from aKey+"Size" or aKey+"Count" and aKey(index),
eg., getThingCount(), getThing(index).
An exception class which is thrown when creating a new key-list with invalid object key.
This class provides methods to set values (using RMKey) over time using an interpolator.
A class representing an individual change to be animated by this timer.
An animation class that represents a key/value pair in a key frame.
An animation object that keeps track of Key-Values at Key Frame times for a target/key pair.
This class represents an individual label inside an RMLabels template.
This class represents an individual label inside an RMLabels template.
This class represents a block of labels.
This class represents a block of labels.
A tool for UI editing of labels shape.
This class models a simple line, providing methods for extracting points, distance calculation,
bisection, hit detection and such.
This class models a simple line, providing methods for extracting points, distance calculation,
bisection, hit detection and such.
This class represents a simple line shape, drawing a line from a start point to an end point.
This class represents a simple line shape, drawing a line from a start point to an end point.
A line segment arrow head.
This class handles creation of lines.
This class is a shape used to render text that didn't fit in a referenced text shape.
This class is a shape used to render text that didn't fit in a referenced text shape.
A class that holds a list of instances for given class.
Utility methods for use with Java.util.List.
Utility methods for use with Java.util.List.
This class provides a simple abstraction for logging messages.
A logger to combine multiple other loggers.
A logger that does nothing.
A logger that wraps around a print stream.
A class to read lines from a given input stream in a separate thread and print them.
Utility methods for use with Java.util.Map.
Utility methods for use with Java.util.Map.
Utility methods for common math operations.
Utility methods for common math operations.
A class used to specify an arbitrary mathematical function.
Utility methods for method reflection.
An RMShape subclass to support morphing from one shape to another.
A morphing shape is a shape which geometry is constructed from two other shapes: a start shape
and an end shape.
Provides Swing UI editing for RMMorphShape.
An implementation of the java.awt.Paint interface for RMGradientFills.
Multiple stop angle gradient with angles.
A multiple stop diamond gradient.
Multiple stop radial gradient.
This class represents a shape for a document inside a page of another document.
This class represents a shape for a document inside a page of another document.
This class is responsible for UI editing of nested document shape.
This subclass extends DecimalFormat to implement ReportMill's RMFormat interface and to support
the extended features "Negative in Red" and "Null String".
This subclass extends DecimalFormat to implement ReportMill's RMFormat interface and to support
the extended features "Negative in Red" and "Null String".
This class forms the basis of many objects to add global functionality, like archiving.
This class forms the basis of many objects to add global functionality, like archiving.
This class and its subclasses write PDF for their corresponding base class.
This class represents a simple oval, with a setable start angle and sweep angle.
This class represents a simple oval, with a setable start angle and sweep angle.
A tool subclass for editing RMOval.
The RMPage class represents an individual page in an RMDocument.
The RMPage class represents an individual page in an RMDocument.
This class represents a page layer, a standard feature of page layout applications that lets you
manage the children of a page as separate groups, so that some can be made unselectable or
invisible to ease template editing.
This class represents a page layer, a standard feature of page layout applications that lets you
manage the children of a page as separate groups, so that some can be made unselectable or
invisible to ease template editing.
This RMShapePdfr subclass writes PDF for RMPage.
This class provides UI editing for RMPage shapes.
An object to process painter shape operations.
A path construction operation for painting a bezier curve.
An op class for moving a shape forward along the path of its current roll.
An op class for moving a shape forward along the path of its current roll.
A path construction operation for painting a line.
An inner class for path move to.
A class representing an operation to an painter shape, like MoveTo or LineTo.
An inner class for path construction operations.
A path construction operation for painting a quadratic curve.
An operation to set paint color.
An operation to set painting speed.
An operation to set stroke width.
An op class for turning a shape by a given number of degrees.
A base class for painting RMShapes.
A shape that references another shape and acts.
This class represents attributes of a paragraph in an RMXString (all of the characters up to and
including each newline in an RMXString make up a paragraph).
This class represents attributes of a paragraph in an RMXString (all of the characters up to and including each
newline in an RMXString make up a paragraph).
A shape implementation that can have children.
A tool class for RMParentShape.
RMPath - A graphics path (moveTo, lineTo, etc.).
RMPath - A graphics path (moveTo, lineTo, etc.).
This class represents a path in 3D space.
This class represents a path in 3D space.
Helper methods for the RMPath3D class.
Helper methods for the RMPath3D class.
Bezier curve fitting code adapted from "An Algorithm for Automatically Fitting Digitized Curves",
by Philip J.
An implementation of path iterator for RMPath.
An implementation of path iterator for RMPath.
Offset path - a path that follows the curvature of the input path but is located a constant
distance away from the curve.
Offset path - a path that follows the curvature of the input path but is located a constant
distance away from the curve.
Some utility methods for RMPaths.
Some utility methods for RMPaths.
Provides info for an encapsulated PDF (a PDF used as an image).
Provides info for an ecapsulated PDF (a PDF used as an image).
A test program for the parser.
PDF Writer.
Filename: RMPencilShape Author: Perry Arellano-Jones Created on: 6/11/15 Project:
ignition_dev_7_8B
Filename: RMPencilShapeTool Author: Perry Arellano-Jones Created on: 6/11/15 Project:
ignition_dev_7_8B
This shape is used as the pie chart component for the reporting module.
UI for customizing the reporting pie chart shape.
This class extends Point2D.Float to add a few convenience methods.
This class extends Point2D.Float to add a few convenience methods.
This class represents a 3D point.
This class represents a 3D point.
This class is an RMShape subclass that encapsulates an arbitrary path.
This class is an RMShape subclass that encapsulates an arbitrary path.
This class manages creation and editing of polygon shapes.
This class offers a number of useful general purpose utilities used by ribs classes.
A Preferences implementation that just stores prefs to a map, in case we don't have permission
to read invalid input: '&' write permissions.
This class describes an attribute of an entity.
An (Indexed) PropertyChangeEvent subclass to describe shape property changes.
An interface for objects that let others listen in to property changes.
Utilities for property changes.
This class models a simple quadratic curve, providing methods for extracting points, distance
calculation, bisection, hit detection and such.
This class models a simple quadratic curve, providing methods for extracting points, distance
calculation, bisection, hit detection and such.
UI for customizing the reporting pie chart shape.
RadialAxis Picker.
Radial Gradient Fill.
This class represents a simple integer range (from start to end).
This class maintains the list of the recently used files.
This class extends Rectanlge2D to add some convenient rect methods.
This class extends Rectanlge2D to add some convenient rect methods.
This class represents a simple rectangle shape with a rouding radius.
This class represents a simple rectangle shape with a rounding radius.
This class handles editing of rectangle shapes.
This class adds a reflection to a given shape.
Swing UI editing for RMReflectionEffect.
A utility class for converting an integer into roman numerals.
This RMEditor subclass has editor functionality specific to ReportMill: - Generates report as a
part of previewing - Draws XML icon in viewport
Parses rtf data from a string and returns it as an xstring.
Write RTF for a document.
This class manages a list of children and transforms them to 3D representations for display based
on X and Y axis rotations.
This class manages a list of children and transforms them to 3D representations for display based
on X and Y axis rotations.
RMPolygon subclass that encapsulates a Path3D.
RMPolygon subclass that encapsulates a Path3D.
Tool for visual editing RMScene3D.
This class describes the structure of a datasource by managing a list of RMEntity.
This class makes a schema from an object graph, given a top level object.
This class handles mouse selection and manipulation of shapes, including: - Click on a shape
selects a shape - Double click on a shape super-selects a shape - Drag a rect selects shapes -
Shift click or shift drag XORs selection - Click and drag handle resizes shape
This class adds a shadow to a given shape.
UI editing for RMShadowEffect.
Implements a simple control to edit shadow position.
This class adds a shadow to a given shape.
Extends Kernel with constructor which takes Kernel size and automatically generates a gaussian
matrix.
This class is the basis for all graphic elements in a ReportMill document.
This class is the basis for all graphic elements in a ReportMill document.
This class holds animation record information for an RMShape.
An inner class to represent a time/value snapshot for an attribute.
A class to listen for Swing events and send them on.
An icon to paint a shape.
A class to produce an image for an RMShape.
Handles code for laying out shape children with springs and struts.
The RMShapeMouseEvent is a subclass of MouseEvent which is sent to an RMShape's mouse listeners.
A listener for shape mouse events.
An adapter class for RMShapeMouseListener.
This class manages the painting of shapes to a Java2D graphics object.
This class is responsible for rendering all the base shapes with AWT and Java2D.
An interface for shapes that want to define their own drawing.
This class manages the painting of shapes to a Java2D graphics object.
This RMObjectPdfr subclass writes PDF for RMShape.
A class to hold a shape roll, scale and skew.
Shapes can implement this and the selfInit() function will be called once when the shape is first
created in the designer.
This class creates a table from a given list of shapes.
Defines a region of coordinates along with a list of shapes that occupy that region.
A class to represent an interval
A class to represent a list of spans.
A class for cells.
A class for columns.
A class for rows.
Some shape utility methods.
A Timer subclass.
An inner class to hold less-common attributes.
This class represents a simple geometric size (width, height).
This class represents a simple geometric size (width, height).
This class provides a basic description for comparison and sorting with a simple key and order
(ascending or descending).
This class provides a basic description for comparison and sorting with a simple key and order
(ascending or descending).
Provides UI for configuring a grouping for a tool.
An interface for SortPanelOwner
This class represents a sound in a document.
Manages sound data from sound file bytes.
This class represents a sound in a document.
A listener interface that can be implemented by anyone that cares.
Provides UI editing for RMSound shapes.
This class provides provides generic spell check API ideal for RM's needs.
This class provides provides generic spell check API ideal for RM's needs.
An innder class to represent a misspelled word.
This shape subclass is like a JSplitPane for shapes.
Handles code for laying out shape children with springs and struts.
A parent shape that does child layout with RMSpringLayout.
Tool for RMSpringShape.
Utility methods for ResultSet.
SQL Utility methods.
An n pointed star.
Tool for start shape.
A string tokenizer that can provide token location.
This class is a collection of convenient static String utils.
This class is used to write a String representation of an RMDocument.
This class is used to write a String representation of an RMDocument.
An RMFill subclass specifically designed to describe strokes.
An RMFill subclass specifically desgined to describe strokes.
UI editing for RMStroke.
A shape to reference another template.
A tool implementation for RMSubreport.
This class represents a sophisticated shape that can maintain multiple versions of itself.
This class represents a sophisticated shape that can maintain multiple versions of itself.
Tool for Swing shape.
This RMShape subclass provides functionality to graphically represent a list of data in a
ReportMill report.
This RMShape subclass provides functionality to graphically represent a list of data in a
ReportMill report.
This class manages a hierarchy of tables so that multiple tables can be configured to display in
the same area of a given page.
This class manages a heirarchy of tables so that multiple tables can be configured to display in
the same area of a given page.
This class handles UI editing of table groups.
This Hashtable subclass provides page number information for table rows in a generated report for
the purpose of generating a table of contents.
This Hashtable subclass provides page number information for table rows in a generated report for
the purpose of generating a table of contents.
An inner class to assist flattening.
An inner class to assist flattening.
This class models a table row in a table.
This class models a table row in a table.
This class represents a text cell in a table header.
A shape layout implementation that handles layout of structured table rows.
Report generation shape for RMTableRow.
This class represents a filled table row and has all the code to rpg clone a table row.
This class provides Swing UI editing for table rows.
Performs RPG for a table.
This class is a basic implementation of Table RPG.
This class is a subclass of the basic implementation of Table RPG.
This class provides Swing UI editing for Tables.
Deprecated.
This class is an RMShape subclass for handling rich text.
A text editor subclass for editing text in a Swing component.
This class provides all of the event and drawing code necessary to edit text in the form of an
RMXString (separated from an actual UI Component).
This class provides all of the event and drawing code necessary to edit text in the form of an
RMXString (separated from an actual UI Component).
Listener class so other objects can track changes to text editor.
A text editor subclass for editing text in a Swing component.
Text editor utils.
Transferable implementation for text editor and xstrings.
This class represents a group of characters in a text line that all share the same text
attributes and are simply spaced apart by their char widths.
A class to layout text.
This class lays out characters in an RMXString inside a bounding rect.
Performs text layout in a path.
A class to represent a line of text in a layout.
This class represents a line of characters in a text layout.
A simple text pane.
Represents a run of characters in a line.
A class to represent a selection of text.
This class is an RMShape subclass for handling rich text.
This class generates PDF for an RMText.
This class provides Swing UI editing for text shapes.
Utility methods for some esoteric text functionality.
A class to hold style attributes for a text run.
Text constants.
Some utility methods for text processing.
An animation object that holds a list of key frames.
Config UI for the reporting module's timeseries chart.
This is the base class for tools in RM - the objects that provide GUI editing for RM shapes.
An inner class describing a shape and a handle.
This is a sort subclass to support sorting objects by their relative position in an array of
values.
This class implements the trackball widget.
This class implements the trackball widget.
This class represents a simple 2D transform.
This class represents a simple 2D transform.
This class represents a 3D transform.
This class represents a 3D transform.
An animation class that represents a change of an object property from one value to another.
A transition for rotation.
A transition for XY.
Common types.
RMUndoer - this object manages undo by keeping lists of property changes.
RMUndoer - this object manages undo by keeping copies of changed objects.
This class reprents a distinct "undoable event".
An interface for undo/redo selection.
This class represents a single undo but holds a list of PropertyChangeEvents.
Utilities for URL.
This class provides a bunch of utility methods for common problems.
This class provides a bunch of utility methods for common problems.
This is a sort subclass to support sorting objects by their relative position in an array of
values.
This class represents a 2D vector.
This class represents a 2D vector.
This class represents a 3D vector.
This class represents a 3D vector.
The RMViewer class is a JComponent subclass that can be used in Swing applications to display
and/or print an RMDocument.
The RMViewer class is a JComponent subclass that can be used in Swing applications to display
and/or print an RMDocument.
A phantom component that resides in the viewer, that Swing JComponentShapes can attach to, to
draw.
Swing UI controls for RMViewerPane bottom.
A viewer input adapter to perform selection of a rectangle and copy as image.
A transferable for copy.
This class handles functionality related to mouse and keyboard input on a viewer, so that
different behavior can easily be swapped in beyond the standard interactive behavior, like text
selection or area-selection.
A class to manage an RMViewer and .rpt file.
A RibsHelper implementation for RMShape.
A RibsHelper implementation for JComponentShape.
This class is a container for a viewer and tool bars.
A shape to act as root of shape to be viewed.
A viewer input adapter to perform text selection and copy (as RTF and CSV).
A transferable for copy.
Swing UI controls for RMViewerPlus top.
This class abstracts an object (or object graph) into core Java types (Map, List, String Number,
Boolean, Date and byte[]) via Java reflection/introspection.
This class creates an object graph of collections (Map/List) and core Java types from a given XML
source.
This class tries to load an XML file as a plist.
This class turns any Java dataset into XML.
This is just a stub class so that developers can reach XML dataset archival from it's old
location in this package.
This class turns any Java dataset into XML.
An RMXString is like a String that lets you apply attributes, like fonts and colors, to character
ranges.
An RMXString is like a String that lets you apply attributes, like fonts and colors, to character ranges.
The Outline inner class represents the attributes of outlined text: strokeWidth and fillColor.
The Outline inner class represents the attributes of outlined text: strokeWidth and fillColor.
The Run class represents a range of characters in an xstring that share common attributes.
The Run class represents a range of characters in an xstring that share common attributes.
This class provides a method to perform @key@ substitution on an xstring.
Config UI for the reporting module's xy chart.
A role is a permission that can be assigned to a user.
Validated text field that uses intelli hints list for entering user roles into textfield
A
BrowsePublisher that publishes browse results beneath a root path.This is available to the user as the saveContext variable passed in on certain extension
functions.
Filename: RosterManagementPanelTermFinder.java Created on Jan 02, 2014 Author: Kathy Applebaum
Copyright Inductive Automation 2014 Project: AlarmNotification
Indicates a paint that needs to be rotated when a shape is rotated.
RoundRectangle2d only gained eq and hash in java 1.6, so we backport them here.
A bundle of routes mounted underneath /data/group-name/*
A "list" route is a route that returns a list of items.
Handler that is associated with a mounted route.
Contextual information for a Route to be mounted
Exception thrown during route mounting if validation of the properties of the route-to-be-mounted
fails
Used as the "context object" for push operations that originate from resource CRUD routes.
These are the Perspective routes that are used for the Perspective application itself.
One assembled row emitted by
RowAssembler into a RowSink.Represents a data bearing object from a WebSite.
Wraps a row to stamp a non-null
engineId on it for multi-engine attribution; every
other accessor delegates to the wrapped row.Calculation row: one aggregate result per row, with the
timestamp of the start of the
window it finalized over.Tall-format row: one path, value and quality per row, with the aggregate that produced the
value or
null for a raw sample.Wide-format row: one timestamp, with parallel value and quality arrays per column.
This class is used for rendering a jtable that is meant as the row header view on a JScrollPane
for row headers on a table.
This object represents a relation between a source row and a destination row or rows.
Describes the schema of rows emitted by a
QueryPipeline.Terminal subscriber for assembled
Rows.Metadata for a given RPC call, identifying the target function to be invoked.
Container for meta-information on an incoming RPC request.
To optimize transmission of across rpc, this class passes a subset of info from DatasourceMeta.
This class is a utility for creating an
RpcRouter from object(s) that implement an RPC
interface.Annotate a particular method on your RPC implementation with
RequiredMutabilityMode to indicate that the client must have at least the given MutabilityMode, or the call will be rejected.Annotate a particular method on your RPC implementation with
RunsOnBackup to
allow it to be invoked on a backup node.Annotate a particular method or your entire RPC implementation with
RunsOnClient
to allow it to be invoked by a client.Common wrapper for an exception that is thrown during an RPC call.
Core interface representing the handling of an RPC call.
Marks an interface as an RPC interface.
An RpcMessage is always either an actual value, or an error thrown on the gateway; nothing more and nothing less.
An RpcMessage is always either an actual value, or an error thrown on the gateway; nothing more and nothing less.
Handles the indirection between an RpcCall (already guaranteed to be arriving at a given module)
and a particular handler, as identified by
RpcCall.packageId() and RpcCall.function().Marker meta-interface combining
GatewayRpcSerializer and ClientRpcSerializer.This class offers a number of useful general purpose utilities used by ribs classes.
A class to help manage and archive borders.
Provides some Ribs utility methods for Fonts.
This stub font class is responsible for returning the appropriate font reference by a rib font
tag.
Component that draws the ruler for the DesignPanel.
This class offers a number of useful List utilities used by ribs classes.
Author: Perry Arellano-Jones Year: 2014
Filename: RunScriptAction Author: Perry Arellano-Jones Created on: 6/8/15 Project: Reporting 3.0
Filename: RunScriptActionConfig Author: Perry Arellano-Jones Created on: 6/8/15 Project:
Reporting 3.0
This is a special type of property that indicates that we want the current runtime value
of a parameter as opposed to the config value.
A resource collection that holds an inheritance hierarchy of collections and can be easily kept
up-to-date using diffs.
An EffectiveSnapshot is a
Snapshot of a Resource Collection and its effective resource
set plus additional information about what its hierarchy was at the time the snapshot was made.These are properties of tags that only exist at runtime.
This class offers a number of useful String utilities used by ribs classes.
This class offers a number of useful general purpose utilities used by ribs classes.
This class manages archival and unarchival to/from RXElements.
This class manages archival and unarchival to/from RXElements.
This inner class represents a named resource associated with an archiver.
This inner class represents a named resource associated with an archiver.
The
RXAttribute class represents an XML attribute by simply having a name and value.The
RXAttribute class represents an XML attribtue by simply having a name and value.The
RXElement class represents an XML element and simply manages a list of XML
elements (recursively) and a list of attributes.The
RXElement class represents an XML element and simply manages a list of XML
elements (recursively) and a list of attributes.A class to load an RXElement from aSource using SAX.
A FileOutputStream that implements a two-stage write process, and additionaly copies any existing
file to a backup location.
Default java deserialization is dangerous with untrusted payloads.
Safely deals with increments / decrements of a
JSlider in a way that
will not allow for the value of the slider to go out of bounds.This class holds the logic need to determine if sample data needs to be loaded or re-loaded based
upon changes to the data configuration.
This is a specialization of the RMDataSource class that understands the Map structures that we
feed our reports.
Type 0 sampled functions.
How every aggregated route reads a stored sample's quality: its level, with a held value counted
as Bad; whether a quality filter admits it at that level; and whether it is noise, a sample with
no value that the filter admits, which the read ignores as if it had never been stored.
The package's one public face: hands out the on-demand sample tools an Event Stream
script-assist agent installs, keyed by the surface being edited.
A WebSite subclass to manage files in ~/Library/SnapSandboxes.
Modal dialog box that presents a checkbox-tree of all modified, added, or deleted resources to
the user so they can pick what to push (a.k.a.
Contains the user's choices from the save dialog box, such as which changes to push, and
whether or not to update and resolve conflicts before pushing.
Filename: SaveFileActionConfig.java Created on Feb 05, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: SaveFileActionPanel.java Created on Feb 04, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Filename: SaveFileReportAction.java Created on Feb 06, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Concrete implementation of ISelectionControls that provides the standard stretch/resize handles
around a component selection
since 8.0
Defines the properties of a scan class.
Represents a scan class, and is easily serializable for messaging
Deprecated.
Represents the run stats for a given scan class instance.
Tool for editing RMScene3D in Swing.
An inner class to provide inspector manipulation of a Scene3D's 3D orientation.
com.inductiveautomation.ignition.common.user.schedule.ScheduleAdjustment
com.inductiveautomation.ignition.common.user.schedule.ScheduleAdjustment
Filename: ScheduledParametersPanel.java Created on Mar 10, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Represents a tab for editing scheduled script configurations in a resource editor.
The extension point for creating schedules.
Filename: ScheduleManagementPanelTermFinder.java Created on Jan 02, 2014 Author: Kathy Applebaum
Copyright Inductive Automation 2014 Project: Vision
Created by carl.gould on 2/3/2015.
Filename: ScheduleParameter.java Created on Mar 13, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Scheduling interface useful for unit testing.
The trigger configuration of a Gateway scheduled event script: the cron expression that fires it.
A customized version of the PMIWeekView that shows user schedules
Used by self scheduling runnables to request a re-evaluation of their scheduling.
This class describes the structure of a data source by managing a list of entities.
SchemaFeature is used to ensure that the internal database has particular attributes
("features").
A utility class for creating JSON schemas in
JsonObject form.A builder for creating JSON schemas.
A number format that will switch between a "small" and "large" format depending on the magnitude
of the value.
Created by colby.clegg on 2/2/2015.
The ScopeLocator system provides an extensible mechanism for module authors to provide new
scopes, or locate virtual scopes.
Facilitates the creation of a scope-specific hash of a specific combination of modules and their
versions.
Created by colby.clegg on 10/23/2014.
Created by colby.clegg on 10/23/2014.
A chart that can be customized and controlled through scripting at runtime
Action which runs a python script when an event occurs.
Annotates an argument of a function being added to the scripting system.
Used to mark public methods on a
ComponentModelDelegate that should be accessible to
users in the script system.Per-editor context handed to a
ScriptCategoryProvider when its node is built.Contributes an extra top-level node to the Perspective scripts editor for a specific component
type.
Registry for
ScriptCategoryProviders contributed by other modules.This class is simply a storage class for the serialization of various script configuration
things.
Configuration resource for message handler scripts.
Configuration resource for shutdown scripts.
Configuration resource for startup scripts.
Configuration resource for tag change scripts.
Configuration resource for timer scripts.
Implemented by a
ComponentModelDelegate that needs to react when its component's script
config is edited in place on a running model — the Designer's live script-config push.Cursor for iterating over a list of search objects pertaining to event scripts search objects
The ScriptContext class is used to provide implicit values to scripts, based on the context of
the call.
Created by carl.gould on 3/3/2015.
This interface represents a compiled scripting function that can be executed multiple times.
Entrypoint to the autocomplete system for scripting functions.
Helper to consolidate the logic of an extension-function style script that must be compiled the
first time before it runs.
Protobuf type
ignition.script.DatasetProtobuf type
ignition.script.DatasetProtobuf type
ignition.script.Dataset.ColumnProtobuf type
ignition.script.Dataset.ColumnDeprecated.
This is the older shared library concept of
app.* user scripts; prefer the
modern ModuleLibrary alternative.A navigable view over a tree of script symbols in
CompletionDescriptor form: named roots
whose MODULE-kind attributes are branches (packages,
script modules) and whose remaining attributes and methods are leaves (functions, classes,
values).A message sent between systems, containing a target handler name and a data payload.
The serialization format that will be used for script messages going between the client/designer
and the gateway via RPC.
Handles script messages that arrive from push notifications.
A Python scripting module
Listens for the push message when the user has altered the contents of pylib
Tracks default 3rd party Python modules in user-lib/pylib.
Class used by the ScriptManager to act as a namespace that can hold either more packages or
executable modules/functions
Created by carl.gould on 3/3/2015.
This special implementation of SearchProvider collects together sub-providers and displays them
as selectable categories.
This is just a JPanel that implements Scrollable, and has getters/setters for the things that
scrollable implements.
Used to mark fields inside a BindingConfiguration object that should be used by the
search-and-replace system.
A searchable object returned by a search provider.
An implementation of Iterator<SearchObject> that aggregates multiple SearchObjectCursor
objects.
A simplified adaptation of iterator that is made to work with a SearchObjectAggregator.
A search request that is to be sent to a gateway search provider.
Defines a coarse unit of searchability.
Passed to the search provider when the user wants to select which objects to search.
Installs SearchableBar into a BorderLayout JPanel
This class holds all of the secondary desktops, which are additional frames which hold their own
Vision window stack.
Helper class which aids in retrieving the current
Plaintext value of a secret without
having to be concerned with the implementation details of embedded vs referenced secrets.Configuration describing a secret.
An Embedded
SecretConfig which encapsulates the ciphertext secret valueA
JsonSerializer and JsonDeserializer implementation for JSON-serializing and
deserializing instances of SecretConfig using GsonA Referenced
SecretConfig which encapsulates the name of the SecretProvider and the
name of the Secret within the Secret Provider where the secret value lives.The type of SecretConfig: Embedded or Referenced
An instance of this Exception is thrown if there is a problem getting the plaintext from a Secret
Represents metadata for a secret, including its name.
A
SecretProviderException thrown when a secret cannot be foundA
SecretProvider exposed methods for listing, reading, and writing secrets managed by the
provider.Immutable config record class which encapsulates the profile properties common to all Secret
Provider types.
Encapsulates contextual information for a running
SecretProviderAn instance of this Exception is thrown if there is a problem reading or writing a secret from/to
a SecretProvider.
Represents metadata for a secret, including its name.
A
SecretProviderException thrown when a secret provider cannot be foundService security configuration for controlling access to a specific
SecretProvider.The security service access modes for protecting a
SecretProvider.The
SecuredEntity.ConfigFactory for SecretProvider service security.The
SecuredEntity.ConfigPropDescriptionFactory for SecretProvider service security.An
ExtensionPoint for defining new types of SecretProvidersAn instance of this Exception is thrown if there is a problem creating a new secret provider
through its
SecretProviderTypeStrips secret values out of configuration JSON before it is shown to an AI agent.
Consumer that can be used to add a
ReferencePropertyBuilder for a SecretProviderConfig reference to a resource allowing SecretConfig to consume renames of
the SecretProviderConfig.Builder for a
SecretReferenceProperty.Class for secret utilities, providing methods to interact with secret providers and secrets.
The SecuredEntity annotation can be used on gateway network service objects (services, service
methods, intents) to secure access in a way that plays into the generic security configuration
system in the gateway.
This factory provides a list (display order will follow list order) of DescriptiveProperties
for security restrictions/properties that can be set.
This interface can be implemented (it is not required) by services and intents that use the
SecuredEntity annotation in order to gain access to some handy helper functions concerning
security config.
A client session secured by the security levels set in the project's permissions.
A more secure
WriteHandler since SecureWriteHandler.write(TagPath, Object) delegates to SecureWriteHandler.write(TagPath, Object, SecurityContext) with a SecurityContext.emptyContext() by
default.Encapsulates contextual security information about the current user of the tag system
Base interface is com.inductiveautomation.ignition.common.tags.model.SecurityContext
Base interface is com.inductiveautomation.ignition.common.tags.model.SecurityContext
Serializes a
SecurityContext to and from its protobuf representation for tag RPC.A SecurityLevelConfig is a node on a security level tree which encapsulates the node's name, its
description, and its children.
Support for Gson serialization and deserialization
A SecurityLevelManager is the source of record for all SecurityLevels configured in the system
Enclosing panel for a SecurityTable that also adds a header and add/delete/refresh buttons.
Table used to choose security zones and roles
Combination of TagPath and SecurityContext.
Protobuf type
common.protobuf.SecurityTagPathListPBProtobuf type
common.protobuf.SecurityTagPathListPB
com.inductiveautomation.ignition.common.tags.model.SecurityTagPath
SecurityTagPath is *not* an implementation of TagPath.
com.inductiveautomation.ignition.common.tags.model.SecurityTagPath
SecurityTagPath is *not* an implementation of TagPath.
The pre and post seed values of a query, by node, identified by
HistoricalNodeId.Represents a single straight-line segment of an orthogonal path.
A control that mimics OSX's "Segmented Control" which is basically a bunch of toggle buttons that
butt up against each other.
A focus listener that attempts to select all of the text when a component gets focus.
Displays a component hierarchy dialog for property selection.
Filename: SelectedTagsPanel.java Created on Aug 06, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Simple class that implements ItemListener, and then sets the Enabled property of components based
on selection.
Event object that will be posted to the editor's event bus when we receive notice through the JS
bridge that the set of selected components has changed.
Event object that will be posted to the editor's event bus when the current selection receives
property changes
This tool handles
selecting components via click, marquee, and fence selection
moving components by dragging
This class handles mouse selection and manipulation of shapes, including: - Click on a shape
selects a shape - Double click on a shape super-selects a shape - Drag a rect selects shapes -
Shift click or shift drag XORs selection - Click and drag handle resizes shape
A component implements this class if it wants to come 'pre-configured' with some bindings (to
itself) For example, a component with an integer status could come pre-configured with color
bindings to its own status
A checkbox whose text is either "True" or "False"
This only exists because we want to hide the completion functions from the scripting system, so
we break it out to a different interface (MessageResultHandler).
This is the transport object used to communicate results for system.util.sendRequest between the
gateway and the client, and across the gateway network.
Created by colby.clegg on 11/13/2015.
Queues up submitted items and executes them in serial on an ExecutorService.
An
SerialExecutionQueue.ExecutionCallback that executes Runnables.Context for serialization used when serializing data with a
PersistentSerializer.Helper class that helps gson serializers make JsonObject instances and avoid serializing null
fields where omitting them would make for a cleaner serialized object.
A custom exception that is thrown when serialization fails.
A service connector is a component that connects the Gateway to an external service.
Listener for state changes in a
ServiceConnector.Base class for all Service Connector extension points.
The service connector manager is responsible for managing service connectors of different types.
A class which implements a cross-platform print dialog.
A simplified http session, managed by a
SessionManager.Represents a node for session event scripts in the navigation tree.
Enum that maps ResourceTypes to their corresponding session script editors.
The nucleus of a Perspective Session.
Factory for creating
SessionKernel instancesBase class for Perspective Sessions which wrap a session kernel.
Session values that implement this interface will be started up and shut down with the session's
lifecycle.
Management for basic http sessions.
Created by carlg on 11/23/2016.
Represents the two "scopes" that a perspective webpage can represent - client or designer
Delegates to the actual view, this prevents the scripting system from being able to call
everything on ViewModel, like startup(), shutdown, etc.
This condition does set comparison.
Carries a
Set element by element, each element encoded as a TagValuePB by the
calling context.An object to get, set and store site settings.
Displays a modal dialog used to edit the value of key-value pairs.
This is the entry-point to the Gateway scope section of the SFC module's API.
This is the vision component used to monitor an SFC
Created by carl.gould on 6/13/2014.
This is the actual class that is added to the scripting system to implement the SFC functions.
Created by carl.gould on 6/16/2014.
PDFShadingPattern.
Created by carl.gould on 5/5/2015.
Created by carl.gould on 5/5/2015.
This class provides UI for editing the currently selected shapes stroke, fill, effect,
transparency.
This class manages the Swing UI for editing the currently selected shapes fill attributes, like
fill color, stroke color, transparency, etc.
Provides UI inspector for Shape image fills.
Implements a simple control to edit shadow position.
An inspector for general shape attributes, like property keys, name, text wrap around, etc.
An inspector for general shape attributes, like property keys, name, text wrap around, etc.
Handy class that lets you use a Shape as an icon.
This class provides UI editing for the currently selected shapes layout attributes (in parent).
This class provides Swing UI editing for the currently selected shapes location and size.
This class provides Swing GUI editing for the currently selected shapes location and size.
An inner class to provide a simple springs and struts control.
This meta annotation contains the keys used by the palette.
Created by carl.gould on 4/17/2015.
Holds colors, paint modes, and stroke widths - everything needed to paint a shape
This class provides Swing UI editing for the currently selected shapes location and size.
This class provides Swing UI editing for the currently selected shapes location and size.
Use this annotation on a property's getter or setter method to indicate that it is a property
that should be exposed through the report module's property inspector.
This class provides Swing UI editing for advanced transforms such as rotation, scale and skew for
the currently selected shapes.
This class provides Swing UI editing for advanced transforms such as rotation, scale and skew for
the currently selected shapes.
This class offers a command line interface to some of ReportMill's functionality.
This class offers a command line interface to some of ReportMill's functionality.
com.inductiveautomation.ignition.common.alarming.ShelvedFilter
A ShelvedFilter holds up to two conditions, keyed by field name in the ShelvedFilter class:
a provider filter (ShelvedFilter.PROVIDER) and a system filter (ShelvedFilter.SYSTEM).
com.inductiveautomation.ignition.common.alarming.ShelvedFilter
A ShelvedFilter holds up to two conditions, keyed by field name in the ShelvedFilter class:
a provider filter (ShelvedFilter.PROVIDER) and a system filter (ShelvedFilter.SYSTEM).
com.inductiveautomation.ignition.common.alarming.query.conditions.PathCondition holding StringPaths
com.inductiveautomation.ignition.common.alarming.query.conditions.PathCondition holding StringPaths
Serializes and deserializes the provider and system conditions of a
ShelvedFilter.This class provides information about a path that has been "shelved", such as when it was
shelved, and by whom, and the actual path.
com.inductiveautomation.ignition.common.alarming.evaluation.ShelvedPath
com.inductiveautomation.ignition.common.alarming.evaluation.ShelvedPath
Tab for editing shutdown intercept event scripts.
When objects are uninitialized, it could be due to a normal shutdown, or to something else- like
the item being deleted.
Tab for editing shutdown event scripts.
Specific kind of PushException indicating that a push supplied a base signature that does not
match the current signature of the resource it targets, so the caller is working from a copy that
is no longer current.
This is the event object for the route to post to the page's gauva event bus, to get picked up
by this delegate.
This is the event object that will be passed to the `onSignatureSubmitted` actions.
A simple username and password pair.
An implementation of
Binding that hides the complicated method signature required of that
interface.Deprecated.
THIS CLASS IS DEPRECATED.
Deprecated.
THIS CLASS IS DEPRECATED.
A property adapter that hooks up a property to a tag.
An implementation of interface CharStream, where the stream is assumed to contain only ASCII
characters (without unicode processing).
An implementation of interface CharStream, where the stream is assumed to contain only ASCII
characters (without unicode processing).
Simple recursive descent parser for simple arithmetic expressions.
An abstract formatter factory that always returns the same AbstractFormatter
This class helps with "simple" pattern matching.
A simple (and rather inefficient) implementation of a PredicateMap.
Filename: SimpleSqlQueryConfig Author: Perry Arellano-Jones Created: 13April2015 Project:
Reporting 3.0
Filename: SimpleSqlQueryConfigPanel Author: Perry Arellano-Jones Created: 13April2015
SimpleSqlQuerySource provides a SQL Query data source that allows for binding-like paths to be
added via {} refs in SQL queries.
Puts a JTree and a JTable next to each other so that it feels like the JTree is the first column
of a resulting new "table".
This is a simplified wrapper around the legacy PropertyTableModel that is used in the classic
chart customizer.
Deprecated.
A wrapper around a delegate TagPath that strips the path of its property, for use with managing
subscriptions to tags.
Created by colby.clegg on 11/16/2015.
SingleFiledLayout lays out components singled filed.
A single-line code editor for editing expressions.
A version of project resource listener that only listens for changes to a specific resource, and
is suppressible.
A handler for a singleton resource.
Sealed interface representing lifecycle events for data sinks in the store-and-forward system.
Event indicating that a sink has been deleted.
Event indicating that a sink has been renamed.
Enum representing the status of a data sink.
The slide-over pane displays one component at full-size, and then allows another component to
slide over the top of that component.
A panel that can be used along with the SlideOverPane, or any popup panel system.
SlidingPane is a panel that acts very much like a CardLayout, as in: one pane displayed at a
time.
An
EmailProfile which supports SMTP.Encapsulates an authentication credential used to authenticate the SMTP client against the SMTP
server
The connection settings used for establishing a connection to an SMTP server
This class represents an RGBA color, just like Java.awt.Color.
Represents the data (from a file)
This class represents a font for use in rich text.
This class represents all the information about a font that is independent of size.
Provides some utility methods for Fonts.
A row for SnapSite.
A lightweight immutable "snapshot" of a
ResourceCollection.An entity that can be copied as a snapshot at a given time; implemented by
DataPoint.This class provides shared functionality to redundant providers that use RedundantSnapshots to
calculate differences between redundant nodes.
A class to manage resources for a Snap site (a data source subclass).
A DataTable for SnapSite.
A class to represent a dataset generated from a table, a query and query parameters.
A class to evaluate SnapTableView keys.
Miscellaneous Utility methods.
Acts as a bag (kind of like an un-ordered list or a set of like items) whose entries are kept in
SoftReferences.
A very simple cache map implementation using soft references around the keys.
Fills the area with a solid fill at some transparency level.
This class provides a basic description for comparison and sorting with a simple key and order
(ascending or descending).
What a
TemporalPointBatch may assume about the ordering of the points it is given,
relative to TemporalPoint's natural
ordering (timestamp ascending).Defines standard sorting strategies for alarm events, allowing multi-column sort priorities.
A sorter for TableModels.
A tag path that delegates to another tag path, but alters the source.
A tag path that delegates to another tag path, but alters the source.
A change to a source: a rename from an old path to a new one, or a retirement of the old path.
The old and new source paths of a source change.
Protobuf binary adapter for
SourceChangePoint.Source configuration
Source identity attached to generated or explicit rows for preview diagnostics.
This condition is basically a standard path condition, but the value is an array of paths.
Thrown when a point's source path differs from the path of the
DataNodeSession it is
processed against.Connects to
EventStreamSource based on current state of Event Stream.
// Indexes of Data Types
// Unknown placeholder for future expansion.
// Indexes of Data Types
// Unknown placeholder for future expansion.
Protobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSetProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSetProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.DataSetValueProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.DataSetValueProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.DataSetValue.DataSetValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.DataSetValue.DataSetValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.RowProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.DataSet.RowProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.MetaDataProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.MetaDataProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.MetricProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.MetricProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Metric.MetricValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertySetProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertySetProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertySetListProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertySetListProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertyValueProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertyValueProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertyValue.PropertyValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.PropertyValue.PropertyValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.TemplateProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.TemplateProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Template.ParameterProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Template.ParameterProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Template.Parameter.ParameterValueExtensionProtobuf type
com.cirruslink.sparkplug.protobuf.Payload.Template.Parameter.ParameterValueExtensionThis class just runs a simple modal panel to register user name and email on first run.
This class just runs a simple modal panel to register user name and email on first run.
For a SplitPane that you want to have the visibility of one of the two components set in the
SplitPane to be toggled between being visible and being not visible, you can use this class to
provide that capability.
A class to layout children using springs/struts settings.
Provides UI editing for shapes with SpringsLayout.
An inner class to provide a simple springs and struts control.
This class is the root of all Rib files.
A helper class for SpringsPane.
JComponentShape subclass for SpringsPane.
Provides inspector for SpringsPaneShape.
This class draws the buttons in the border chooser, plus holds utility methods for choosing
borders
A 1.4 file that provides utility methods for creating form- or grid-style layouts with
SpringLayout.
A class for running operations in the background.
The SQL Configurator configures an
SQLPropertyAdapter.Created by colby.clegg on 11/12/2015.
Created by colby.clegg on 11/12/2015.
This class provides information and utilities concerning SQLTags, and Complex Types in
particular.
Protobuf enum
common.protobuf.AccessRightsTypePB
com.inductiveautomation.ignition.common.sqltags.model.types.AlertAckMode
com.inductiveautomation.ignition.common.sqltags.model.types.ClampMode
com.inductiveautomation.ignition.common.sqltags.model.types.DataType
Note that there is a gap between 20 and 29.
com.inductiveautomation.ignition.common.sqltags.model.types.DeadbandMode
com.inductiveautomation.ignition.common.sqltags.history.InterpolationMode
com.inductiveautomation.ignition.common.sqltags.model.types.OpcDataMode
com.inductiveautomation.ignition.common.sqltags.history.ReturnFormat
com.inductiveautomation.ignition.common.sqltags.model.types.ScaleMode
com.inductiveautomation.ignition.common.sqltags.model.types.ScanClassComparison
com.inductiveautomation.ignition.common.sqltags.model.types.SQLQueryType
Protobuf type
common.protobuf.SqlTagEnumsPBProtobuf type
common.protobuf.SqlTagEnumsPB
com.inductiveautomation.ignition.common.sqltags.model.types.TimestampSource
Convenience class that can serialize the common sqltag enums
DialogPage that wraps an instance of an AbstractPropertyEditorPanel in a JIDE DialogPage, adding
a banner on top.
Listen for this event on the GatewayContext's EventBus to be notified when the Gateway Web
Server's TLS Setup has changed
This class has the logic used by all 3 AD user sources to handle a single-sign-on (SSO) request.
Stage represents each unit of work a
StageEvent will pass through.Encapsulates communication between stages.
Diagnostics for an individual stage
Signals an
EventStream has been shut down.A record representing a submission event to be processed.
Stage has been disabled.
Exception was encountered during creation or startup of Stage.
Stage has successfully been created and is awaiting events.
Stage has been disabled.
Exception was encountered during creation or startup of Stage.
Stage has successfully been created and is awaiting events.
This class exists just for testing and development purposes.
The platform's aggregates: the only list the platform owns.
The standard change point types, each with its
ChangePoint class.The standard
CollectionContext, usable for both streaming and batch collection.The standard complex point types, each pairing a
ComplexPoint class with its query
options class.Standard types for data points, mapping to their respective implementations.
A
QualifiedPathAdapter that normalizes paths from various forms, such as driver-based or
mixed-component paths, into the order sys (system), prov (provider), tag
(tag and any remaining components).Tab for editing startup event scripts
Extends BaseAction by adding support for item events like Toggle buttons and Checkbox menu items.
Deprecated.
Use com.inductiveautomation.ignition.client.util.action.StateChangeAction instead.
The response to a
ResourceAction that does not affect anything outside this
resource.The request could not be carried out because of something the caller did.
StaticDataConfigPanel
Implementation of property tree privacy model that allows for static (hard-coded) configuration.
StaticReportDataObject
StaticReportDataSource
A StatMetric keeps track of various statistics for one metric.
com.inductiveautomation.ignition.common.StatMetric
com.inductiveautomation.ignition.common.StatMetric
Carries a
StatMetric as the JSON of its fields, the same message the Gateway Network
serializer uses, since the metric exposes its running statistics only through serialization.Provides status for storage and query capabilities of a historian.
Flattened entry from PathTree<StringPath, DiagnosticsSample.Diagnostic>
Flattened entry from PathTree<StringPath, DiagnosticsSample.Diagnostic>
com.inductiveautomation.ignition.common.DiagnosticsSample.DiagnosticLevel
com.inductiveautomation.ignition.common.tags.status.TagDiagnostics
com.inductiveautomation.ignition.common.tags.status.TagDiagnostics
A JLabel that will display a status message with an optional hold time.
A factory that creates editing UIs for SFC chart elements.
This is where you register your
StepConfigFactory in the designer if you're implementing
a new type of step.Created by Colby on 12/9/2015.
Base interface for factory that creates objects to represent steps.
This is the control interface for step elements.
StepFactorys are responsible for instantiating StepElements; the interface encapsulating the execution
logic of a an SFC step.A FilterInputStream that updates the launch step's progress automatically
Created by colby.clegg on 3/18/2015.
A Stitching function is a function that contains an array of subfunctions.
Call
StopCellEditTableSupport.stopCellEditing() to stop editing for all child components of JComponent
passed in the constructor StopCellEditTableSupport(JComponent)
StopCellEditTableSupport}.Backing storage for atomic, complex and change points, written by
DataCollector sessions
and by pre-batched writers.An enumeration that represents the storage forwarding policy.
A composite key that identifies storage destinations and sinks within the store-and-forward
system.
The outcome of a storage operation: success, partial failure, failure, exception or none.
The operation threw an exception.
All data failed to store.
Nothing was stored or attempted.
Some data was stored and some failed.
All data was stored.
A point-in-time reading of the data accumulating in a
PointStorageStrategy that buffers
work before flushing it, reported by PointStorageStrategy.metrics().Renders the parts of the store-and-forward digest that the resource system cannot supply: live
engine state, buffer and throughput symptoms, pipeline and sink status, and quarantined batches,
all read from
EngineInformation rather than from stored configuration.The StoreAndForwardEngine interface provides a common API for store and forward engines.
The main manager interface for handling all store and forward operations.
A
FailureHandlingStorageStrategy.StorageFailureHandler that puts failed points back into Store & Forward as pending
data, which forwards automatically once the sink under storageKey accepts again.A
FailureHandlingStorageStrategy.StorageFailureHandler that holds failed temporal points in the Store & Forward
quarantine of the target engine until an operator retries or deletes them; nothing is retried
automatically.A class containing constants used in the store and forward logging system.
This is an implementation of Dataset that received data in a streaming manner.
Protobuf type
ignition.rpc.StreamingDatasetPbProtobuf type
ignition.rpc.StreamingDatasetPbProtobuf type
ignition.rpc.StreamingDatasetPb.CellProtobuf type
ignition.rpc.StreamingDatasetPb.CellProtobuf type
ignition.rpc.StreamingDatasetPb.ColumnProtobuf type
ignition.rpc.StreamingDatasetPb.Column
Data is always either a row in the dataset, or an error thrown on the gateway
Data is always either a row in the dataset, or an error thrown on the gateway
Protobuf type
ignition.rpc.StreamingDatasetPb.HandshakeProtobuf type
ignition.rpc.StreamingDatasetPb.HandshakeProtobuf type
ignition.rpc.StreamingDatasetPb.RowProtobuf type
ignition.rpc.StreamingDatasetPb.RowTurns a stream of backend records into
DataPoints pushed onto a DataPointProcessor.Where to read one column from a record.
Where a row holds the first and last samples of an aggregated window: time, quality and value
of each.
One node's columns as the dispatch loop sees them.
How the backend orders one statement's rows, which decides whose watermark a timestamp advance
is.
The per-node column metadata the dispatcher consults for each record.
Delimiter parameter of STRING_AGG and STRING_DISTINCT_AGG.
Holds a map of integer ID -> String.
Much like the enum condition, but matches against a list of strings.
Like StringBuffer but with double formatting.
A pair of strings.
A parser that handles string interpolation, supporting literal text mixed with bound paths (e.g.,
"{path/to/tag}").
A simple path based on string based path components.
A case-sensitive subclass of
StringPath.Result of an alignment operation.
com.inductiveautomation.ignition.common.StringPath
com.inductiveautomation.ignition.common.StringPath
Validates that the provided string satisfies the following conditions:
Each path component is a legal resource name.
Validator that checks if a string is non-null and non-blank.
This class is a collection of convenient static String utils.
This class is a collection of convenient static String utils.
Represents a simple string value, such as "value ".
Fills the area with a solid fill at some transparency level.
The response to a
ResourceAction that does affect other resources, such as when a
resource is deleted, renamed, or otherwise modified in a way that requires other resources to be
updated or references to be checked.The request could not be carried out because of something the caller did.
Created by pjones on 6/1/17.
Enum that determines the origin of this event.
Simple document listener that performs the consumers operation on any text changes.
Represents a style class's stored configuration.
An editor for Borders
A "style declaration" is a map of style attribute to value.
Class: StyleListener
Small rectangular component that displays a color, and when pressed, shows a popup editor.
Use a table to fake a list so we can more easily support cell editors
Interface that marks a component as one who supports the notion of Styles.
A style variant is one style or animated style, which might serve as the base style for a Style
Class or as a media-query or pseudo-selector variant style.
A SubCache resides under the main cache, and represents the cache for a certain set of
parameters.
A SubIndex represents a way to get a sub element from a value.
This expression takes a reference to an array, dataset, collection, or map and subscripts inside
it to pull out a value, like:
{dataset}[0,5].Pair-builder for subsystem diagnostic digest agents.
Configuration object for a pair of summary/analysis agents.
Canonical system-prompt preambles shared by every subsystem diagnostic-digest agent.
The SubSystemIdentifiers class contains constants for all known subsystems that store data
through the store and forward system.
Holds the state information for use with the
InformationSubtextPanel.A basic WriteOperation that is always instantly successful.
An editor that uses a non-editable combo box displaying a list of pre-canned items
A suggestion is intended to be used on an enum whose values are suggestions for a free-form type
of field.
Filename - SumPensDatasource Author: Perry Arellano-Jones Year: 2014
Emits only the Object provided by Supplier
This class will consume all the SVG files in a folder, and emit a JSON file representation of all
of their paths, which is the format we ship with Ignition for the client-api's built-in vector
icons.
This SVG importer imports the SVG into a single component.
Models the "d" attribute of SVG using objects that understand how to mimic the same path using
Path2D.
Parses an svg path using the "d" attribute format.
Modified from the standard color swatch chooser.
This class helps to load and manage panels of UI components in the form of a UI file, which is a
simple XML description of UI controls.
An editor which represents a boolean value.
Swing version of a Border property editor.
Swing version of a Color property editor.
A file class to represent Ribs Swing files.
A PropertyEditor for editing a Dimension object.
A class to manage dragging.
A File Transferable.
Base class of all Swing based property editors.
A property editor for a swing enumerated type.
This class encapsulates information for UI changes, like button clicks, text field entries, list
selections, etc..
A timer event.
A class to listen for Swing events and send them on.
Provides fill inspector for JComponentShape Swing shape attributes.
A Font property editor.
A gallery panel for ribs Swing components.
This class provides Ribs functionality for abstract widgets (display objects).
An editor for editing Insets.
Created by Carl.Gould on 11/23/2015.
A property editor which allows for the display and instantaition of arbitrary objects.
A base controller class class that manages a JComponent usually loaded from a rib file.
A PropertyEditor for editing a Point object.
An editor for editing Rectangle.
A runner than invokes success/failure methods in Swing EventDispatch thread.
A property editor for editing strings.
A UITimer for Swing and SwingOwner.
This class offers a number of useful general purpose utilities used by ribs classes.
A class to manage the Window of a SwingOwner.
This class encapsulates a list of child components which can be switched in and out, like a tab
view without the tabs.
Swing Helper for SwitchPane.
An RMShape subclass for SwitchPane.
A class to act as switch pane's inspector.
An object used to drop SVG symbols onto vision windows.
This interface provides functions for sending syncable data to a remote system.
This allows state provider to notify the manager that something has changed.
This is a provider for a subsystem that wishes to synchronize data across redundancy.
Classes that implement this interface will provide a RedundancySnapshot to the redundancy
system as needed, typically during sync operations.
Represents the result of a sync operation.
Defines the behavior of this Syncable, which will be used by the
SyncManager to create a
self-scheduled runnable.A simple text style class.
Class with several utility functions used by jEdit's syntax colorizing subsystem.
A JIDE GroupList that is compatible with our look and feel
A Synthetica
ProgressBarPainter so we can set the Synthetica.background client
prop before painting the progress bar foreground.A Synthetica
ToggleButtonPainter so we can set the Synthetica.background client
prop before painting the background if the user has applied a background color with no alpha.SystemEncryptionService exposes APIs to:
Encrypt any arbitrary plaintext into ciphertext
Decrypt previously encrypted ciphertext back into the plaintext
An exception associated with the SystemEncryptionService methods
Filters to only logging events that are "system events", or get logged with a "system" marker.
A subclass of the Ignition platform's
ScriptConfig class that adds JSON serialization /
deserialization.A single Identity Provider entry in the system-level (Gateway and Designer) IdP list,
GatewaySystemProperties.SystemIdentityProviders.Convenience class for getting access to the system details and ID.
A marker interface that should be put on classes that provide system functions or fields to
scripting, e.g.
LibraryPromptAssist over Ignition's system.* scripting library, letting the user
drop a reference to a system function, constant, or whole package into an AI prompt.Agent tool surface for browsing Ignition's system scripting library.
A named slot in an
Agent's system prompt.Provides a listener that can react to SystemPropertyRecord changes.
Manages access to the SystemPropertiesResource.
Whenever a SystemPropertiesListener fires, this provides a read-only version of the system
properties map that can be safely passed to listeners.
The collection of
SystemProps used in the Vision module.The collection of
SystemProps used in the Ignition core platform.The collection of
SystemProps used in the Perspective module.The collection of
SystemProps used in the Reporting module.The collection of
SystemProps used in the SFC module.SystemProps contributed to this registry will be presented on the Gateway.Provides core system functions exposed as system.util.* in scripting.
This is a resource workspace that allows multiple resources to be open at once using a tabbed
interface.
Created by carl.gould on 8/6/2014.
This is the base class for the different types of column attributes.
A file that represents a table of data.
Filename: TableGroupShapeConfigFactory.java Created on Jun 30, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
This class handles UI editing of table groups.
A label that paints its background and border to look like a JTable header.
TableLayout is a layout manager that is more powerful than GridBagLayout yet much easier to use.
TableLayoutConstants define the constants used by all the TableLayout classes.
TableLayoutConstraints binds components to their constraints.
This class provides Swing UI editing for table rows.
This wizard subclass is used to create a simple table.
Deprecated.
Totally unused.
This wizard is just like TablesBasic, but with additional screens for:
Created by carl.gould on 5/5/2015.
This class has some RJTable utility methods in it (for drag and drop).
This class provides Swing UI editing for Tables.
A DefaultTableCellRenderer subclass to add tool tips.
A JTable subclass to make table as big as scrollpane for drag and drop.
We use the term "table" for everything, including procedures, so this is used to actually know
what we're talking about.
A file for managing table views.
Thrown by whichever gateway owns a tag provider when it refuses an operation on that provider's
tags, so that "you may not" is not mistaken for "there is nothing there".
A TagActor can be thought of as part of a pipeline.
The ValueMeta record encapsulates metadata about a value, specifically its backfill and initial
state.
A TagActorFactory creates TagActors, which are the execution building blocks of tags.
since 8.0
Represents the definition of an alarm on a tag.
Represents a property of a tag alarm.
Tag attributes are related to TagProp, but are usually more complicated data types.
A
BindingFactory for creating the appropriate AbstractBinding instance driven by
the TagBindingConfigExtends the standard FolderNode, which allow us to filter child tags before they are passed to
the TagBrowserTree model.
Extends the standard TagProviderNode with a version that can filter out tags at the root level.
Provides a tag browser action that allows users to select tags from a tree dialog.
Extends the standard RootTagManagerNode with a version where we can add TagBrowseProviderNode,
which are extended TagProviderNodes.
com.inductiveautomation.ignition.common.tags.browsing.BrowseValue
com.inductiveautomation.ignition.common.tags.browsing.BrowseValue
Filename: TagCalculationQueryConfig.java Created on Aug 06, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
Filename: TagCalculationQueryConfigPanel.java Created on Aug 06, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
An event listener that is notified when a tag changes
An event listener that is notified when a tag changes
com.inductiveautomation.ignition.common.tags.model.event.TagChangeEvent
com.inductiveautomation.ignition.common.tags.model.event.TagChangeEvent
com.inductiveautomation.ignition.common.tags.client.PropertyChangePushNotification
com.inductiveautomation.ignition.common.tags.client.PropertyChangePushNotification
Holds the configuration for a gateway or client scoped tag change script.
Tab for editing tag change event scripts.
The trigger configuration of a tag-change event script: which kinds of tag change fire it and,
optionally, which tag paths it subscribes to.
The TagCollection interface is used to denote an object that contains many tags.
java.util.List
java.util.List
java.util.Set
java.util.Set
The basic definition of any tag type.
com.inductiveautomation.ignition.common.tags.config.TagTypeDescriptor
com.inductiveautomation.ignition.common.tags.config.TagTypeDescriptor
Request object for
TagProvider.getTagConfigsAsync.Fluent builder for
TagConfigQuery.
com.inductiveautomation.ignition.common.tags.config.model.TagConfigQuery
com.inductiveautomation.ignition.common.tags.config.model.TagConfigQuery
A TagConfiguration represent the local configuration of a single tag node.
This form of the builder is for child member builders, and only adds the "close()" function
that will finish that builder and return the parent.
This is the manager responsible for handling custom tag editing extensions.
Protobuf type
common.protobuf.tags.BasicTagConfigurationModelPBProtobuf type
common.protobuf.tags.BasicTagConfigurationModelPBProtobuf type
common.protobuf.tags.TagConfigurationPBProtobuf type
common.protobuf.tags.TagConfigurationPBAgent tool surface for inspecting tag providers, the tag tree, and tag configuration.
Where the reading tools load tag configuration from.
Cursor-paginated envelope.
Created by colby.clegg on 7/14/2015.
Protobuf type
common.protobuf.tags.BasicDatasetPBProtobuf type
common.protobuf.tags.BasicDatasetPBProtobuf type
common.protobuf.tags.DatasetPBProtobuf type
common.protobuf.tags.DatasetPBProtobuf type
common.protobuf.tags.DataSetRowPBProtobuf type
common.protobuf.tags.DataSetRowPBA tag definition is essentially a collection of properties, with various helpers to aid with the
wide range of features a tag has.
This class provides information about a currently executing SQLTag, including its definition,
last error, last value, etc.
This class provides information about a currently executing Tag, including its definition, last
error, last value, etc.
com.inductiveautomation.ignition.common.DiagnosticsSample.DiagnosticLevel
com.inductiveautomation.ignition.common.DiagnosticsSample.Diagnostic
com.inductiveautomation.ignition.common.DiagnosticsSample.Diagnostic
com.inductiveautomation.ignition.common.DiagnosticsSample
com.inductiveautomation.ignition.common.DiagnosticsSample
com.inductiveautomation.ignition.common.tags.status.TagDiagnostics
com.inductiveautomation.ignition.common.tags.status.TagDiagnostics
A Tag Diff represents an edit to a tag that may encompass various fields.
To add a TagDropHandler to a bean, set an instance of one as a property named "tagDropHandler" in
the bean's BeanDescriptor
This class add a little extra information on top of the base PropertyConfigurationController
about the tag configuration that we are editing.
These flags dictate what editing capabilities custom SQLTags support.
Used to decouple Tag Editor parent components from their child components
This is a property set comprised of all of the items that might be relative to a tag provider.
Created by mattgross on 12/4/2017.
com.inductiveautomation.ignition.common.tags.config.CollisionPolicy
com.inductiveautomation.ignition.common.tags.model.InheritanceRelationship
com.inductiveautomation.ignition.common.tags.config.MemoryTagValuePersistence
com.inductiveautomation.ignition.common.tags.config.SampleMode
com.inductiveautomation.ignition.gateway.tags.distributed.TagProviderService2.SubscriptionState
com.inductiveautomation.ignition.common.TagCreatorUtil.Modify
Protobuf type
common.protobuf.TagEnumPBProtobuf type
common.protobuf.TagEnumPB
com.inductiveautomation.ignition.common.tags.config.TagExecutionMode
com.inductiveautomation.ignition.common.tags.config.TagGroupMode
com.inductiveautomation.ignition.common.tags.config.types.TagObjectType
The tag event scripts are python code that execute for certain events.
Protobuf enum
common.protobuf.tags.ChangeTypePBProtobuf type
common.protobuf.tags.ChangeTypeScriptEntryPBProtobuf type
common.protobuf.tags.ChangeTypeScriptEntryPBProtobuf type
common.protobuf.tags.ScriptEntryPBProtobuf type
common.protobuf.tags.ScriptEntryPB
com.inductiveautomation.ignition.common.sqltags.model.scripts.BasicTagEventScripts
com.inductiveautomation.ignition.common.sqltags.model.scripts.BasicTagEventScripts
A source that listens for tag changes and publishes them as events.
Settings to determine how a tag is executed by an execution manager.
This function factory adds additional expression functions that are used by SQLTags, and not by
bindings.
com.inductiveautomation.ignition.common.tags.config.TagGroupConfiguration
com.inductiveautomation.ignition.common.tags.config.TagGroupConfiguration
since 8.0
com.inductiveautomation.ignition.common.tags.config.TagGroupConfiguration
com.inductiveautomation.ignition.common.tags.config.TagGroupConfiguration
Filename: TagHistorianDataSourceConfigPanel.java Created on Jul 10, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
A cache system for SQLTags History data.
Parameters with a different time range, and a return size adjusted accordingly.
The "Configurator" for the Tag History binding type
Store-and-forward data sink that converts legacy tag history data into modern points and stores
them through a
StorageEngine.Deprecated.
since 8.0
Deprecated.
use
Historian directly with a query engine.This class defines static values that can be set on the flag field of
TagHistoryQueryParams in order to change the behavior of the query.This interface shares some functions with TagHistoryProvider.
Deprecated.
use
AggregatedQueryOptions or RawQueryOptions.Note that this class only handles serialization for BasicTagHistoryQueryParams; other classes
that extend from TagHistoryQueryParams are not sent over the gateway network.
Security marker interface for history provider access control.
Factory that discovers available history providers by querying the
TagHistoryManager for all registered
historians.Storage engine that lets legacy
TagGroupHistorySet-based providers store through the
modern historian.Filename: TagHistorianReportDataObject.java Created on Jul 10, 2015 Author: Kathy Applebaum
Copyright Inductive Automation 2015 Project: Reporting
Deprecated.
A class that can listen for tag changes and notify an InteractionListener.
Deprecated.
Deprecated.
Provides information about a type of SQLTag.
com.inductiveautomation.ignition.common.tags.browsing.NodeDescription
com.inductiveautomation.ignition.common.tags.browsing.NodeDescription
This class tags a tag node and returns the flattened hierarchy beneath it in iterator form.
This is a special exception used by the expression tag to indicate that a referenced tag was not
found.
The root interface for objects in the SQLTags type system.
This enum represents the core set of object types in the tag system.
com.inductiveautomation.ignition.common.tags.config.properties.ParameterValue
com.inductiveautomation.ignition.common.tags.config.properties.ParameterValue
Deprecated.
Filename: TagPathAliasObject.java Created on Jul 10, 2015 Author: Kathy Applebaum Copyright
Inductive Automation 2015 Project: Reporting
Deprecated.
com.inductiveautomation.ignition.common.tags.paths.BasicTagPath
com.inductiveautomation.ignition.common.tags.paths.BasicTagPath
com.inductiveautomation.ignition.common.tags.paths.PropertyAlteredTagPath
com.inductiveautomation.ignition.common.tags.paths.PropertyAlteredTagPath
com.inductiveautomation.ignition.common.tags.tagpaths.SimplifiedTagPath
com.inductiveautomation.ignition.common.tags.tagpaths.SimplifiedTagPath
com.inductiveautomation.ignition.common.tags.paths.SourceAlteredTagPath
com.inductiveautomation.ignition.common.tags.paths.SourceAlteredTagPath
Base interface is com.inductiveautomation.ignition.common.tags.model.TagPath
Base interface is com.inductiveautomation.ignition.common.tags.model.TagPath
A general purpose expression that can read a tag path from a generic reader function.
Class contains a text area that can be used to specify multiple
TagPath, and validate them.Represents a tree of objects, accessible by a tag path.
Created by colby.clegg on 7/14/2015.
This condition checks the path, but does not take tag provider into account.
A Condition implementation with the smarts to be able to search a TagPermissionsModel for a
certain value
Deprecated.
Deprecated.
Deprecated.
PromptAssist that lets the user browse the Designer's tag system through the
@-popup.Configures provider visibility for a
TagPromptAssist, following the
TagBrowserTree.Builder idiom: TagPromptAssist.Builder.withProviders(String...) restricts to an allow-list, TagPromptAssist.Builder.withoutProviders(String...) builds a deny-list, and with neither every provider is visible.Wraps a tag as a property set.
The value of a property that can be stored to a tag store.
The TagProto class provides a mechanism for encoding and decoding objects, collections, enums,
and various primitive types into protocol buffers using a set of registered adapters.
An interface that provides methods for parsing, encoding, and decoding between protocol buffer
messages of type M and domain-specific objects of type T.
The DecodeContext interface provides methods for decoding various types of messages and values,
producing results of corresponding types.
The EncodeContext interface defines methods for encoding values into specific protocol buffer
message types or a general-purpose TagValuePB message format.
The EnumAdapter interface defines a mechanism for encoding and decoding between a Java Enum
type and a Protocol Buffers Enum type.
Caller-supplied settings for a single encode or decode call.
com.inductiveautomation.ignition.common.sqltags.model.BasicInformation
com.inductiveautomation.ignition.common.sqltags.model.BasicInformation
com.inductiveautomation.ignition.common.NamedValue
com.inductiveautomation.ignition.common.NamedValue
com.inductiveautomation.ignition.common.tags.model.TagProviderInformation
com.inductiveautomation.ignition.common.tags.model.TagProviderInformation
com.inductiveautomation.ignition.common.tags.config.EditRights
com.inductiveautomation.ignition.common.tags.config.EditRights
com.inductiveautomation.ignition.common.tags.config.EditRights
com.inductiveautomation.ignition.common.tags.config.EditRights
com.inductiveautomation.ignition.common.tags.model.TagProviderProps
com.inductiveautomation.ignition.common.tags.model.TagProviderProps
com.inductiveautomation.ignition.common.tags.model.TagProviderProps
com.inductiveautomation.ignition.common.tags.model.TagProviderProps
com.inductiveautomation.ignition.common.tags.config.TagTypeDescriptor
com.inductiveautomation.ignition.common.tags.config.TagTypeDescriptor
The
RpcSerializer of TagProviderRpc, shared by the gateway and the Designer as
TagProviderRpcSerializer.INSTANCE.Deprecated.
This class was used to provide remote tag access to 7.9 gateways.
Implements all of the functions necessary for remote tag providers.
This class does some trickery to avoid sending our new Parameters and ParameterValues to old
gateways.
Swaps serialVersionUID of SubPropertyCondition to allow previous classes to deserialize even
though they have different serialVersionUID.
Supports AlarmFilter and TagQueryFilter
Supports AlarmFilter and TagQueryFilter
org.python.core.PyObject
org.python.core.PyObject
Base interface is com.inductiveautomation.ignition.common.model.values.QualifiedValue
Base interface is com.inductiveautomation.ignition.common.model.values.QualifiedValue
Deprecated.
A Tag Query is a set of conditions for querying tags.
The TagQueryFilter wraps a query to add on additional temporal data, such as current continuation
point, offset, etc.
Protobuf type
common.protobuf.ComparisonConditionPBProtobuf type
common.protobuf.ComparisonConditionPBProtobuf type
common.protobuf.ConditionPBProtobuf type
common.protobuf.ConditionPBProtobuf type
common.protobuf.HierarchyItemPBProtobuf type
common.protobuf.HierarchyItemPB
com.inductiveautomation.ignition.common.tags.query.conditions.NodeIdCondition
com.inductiveautomation.ignition.common.tags.query.conditions.NodeIdCondition
com.inductiveautomation.ignition.common.tags.query.TagQuery.Options
com.inductiveautomation.ignition.common.tags.query.TagQuery.Options
com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition
PropertyConditions can get quite complex.
com.inductiveautomation.ignition.common.alarming.query.conditions.PropertyCondition
PropertyConditions can get quite complex.
com.inductiveautomation.ignition.common.tags.query.conditions.ValueQualityCondition.QualityCondition
com.inductiveautomation.ignition.common.tags.query.conditions.ValueQualityCondition.QualityCondition
com.inductiveautomation.ignition.common.tags.query.conditions.SetCondition
For tag queries, the SetCondition is a Set of NodeAttributes
com.inductiveautomation.ignition.common.tags.query.conditions.SetCondition
For tag queries, the SetCondition is a Set of NodeAttributes
com.inductiveautomation.ignition.common.tags.query.conditions.AnyOfCondition that is specifically defined in
com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder.tagObjectType
com.inductiveautomation.ignition.common.tags.query.conditions.AnyOfCondition that is specifically defined in
com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder.tagObjectType
com.inductiveautomation.ignition.common.tags.query.conditions.TagPathWithoutSourceCondition
com.inductiveautomation.ignition.common.tags.query.conditions.TagPathWithoutSourceCondition
com.inductiveautomation.ignition.common.tags.query.TagQueryFilter
Protobuf type
common.protobuf.tags.TagQueryFilterPB
com.inductiveautomation.ignition.common.tags.query.TagQueryFilter
Protobuf type
common.protobuf.tags.TagQueryFilterPB
com.inductiveautomation.ignition.common.tags.query.TagQuery
com.inductiveautomation.ignition.common.tags.query.TagQuery
com.inductiveautomation.ignition.common.tags.query.conditions.TypeHierarchyCondition
com.inductiveautomation.ignition.common.tags.query.conditions.TypeHierarchyCondition
com.inductiveautomation.ignition.common.tags.query.conditions.ValueQualityCondition
com.inductiveautomation.ignition.common.tags.query.conditions.ValueQualityCondition
com.inductiveautomation.ignition.common.tags.query.conditions.AnyOfCondition that is specifically defined in
com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder.valueSource
com.inductiveautomation.ignition.common.tags.query.conditions.AnyOfCondition that is specifically defined in
com.inductiveautomation.ignition.common.tags.query.TagQuery.Builder.valueSource
This is a proxy for the tags, used for querying.
This action, which needs to be initalized with a text component, will show a dialog box prompting
the user to find a tag.
The TagReferenceBinder is a parse context that looks for references to tags, and possibly
properties.
com.inductiveautomation.ignition.common.tags.config.model.TagReferenceLocation
com.inductiveautomation.ignition.common.tags.config.model.TagReferenceLocation
com.inductiveautomation.ignition.common.tags.config.model.TagReferencePath
com.inductiveautomation.ignition.common.tags.config.model.TagReferencePath
com.inductiveautomation.ignition.common.tags.config.model.TagReference
com.inductiveautomation.ignition.common.tags.config.model.TagReference
com.inductiveautomation.ignition.common.tags.config.model.TagReferenceQuery
com.inductiveautomation.ignition.common.tags.config.model.TagReferenceQuery
com.inductiveautomation.ignition.common.tags.config.model.TagReference.Type
Used to provide different types of situations in different contexts, gets passed into
TagReferenceAction to create the component for reference selection.
Deprecated.
Since 8.3.0, only in place for backwards compatibility.
com.inductiveautomation.ignition.common.tags.query.TagReportSearch
com.inductiveautomation.ignition.common.tags.query.TagReportSearch
com.inductiveautomation.ignition.common.browsing.TagResult
com.inductiveautomation.ignition.common.browsing.TagResult
This class is used to communicate tag retirement to the data sinks.
Deprecated.
The TagScriptManager handles the compilation and execution of tag event scripts.
Deprecated.
Since 8.3.0, only in place for backwards compatibility.
Performs a gateway-side Tag search
An interface that can be implemented by anything that provides selection of tags.
A tree model for use with a simple tag selection tree.
Displays a simple tree of
BrowseTreeNodes used for selecting tag paths.Copied over from the TagSelectionComponentBuilder class used in 7.9
Utility class for creating tag selection panels.
A tag store is where configured tags are saved.
A TagStoreObject is something that is stored by the tag store and is pass around along with an id
that can be used to efficiently operate on the object later.
Represents a Pair<TagPath, NodeBrowseInfo> for a moved tag
Represents a Pair<TagPath, NodeBrowseInfo> for a moved tag
com.inductiveautomation.ignition.gateway.tags.model.TagStructureEvent
com.inductiveautomation.ignition.gateway.tags.model.TagStructureEvent
Used to display a tag tree with relative paths to the root node.
com.inductiveautomation.ignition.common.tags.model.TagStructureTree.TagNode
com.inductiveautomation.ignition.common.tags.model.TagStructureTree.TagNode
com.inductiveautomation.ignition.common.tags.model.TagStructureTree
com.inductiveautomation.ignition.common.tags.model.TagStructureTree
A combination of a tag path and listener, with hashCode and equals implemented in order to make
it properly hashable.
The TagSubscriptionModel holds subscriptions to tags, broken up by provider.
Designed to import Vision client tags via XML text
Represents a tree of Tags, accessible by their path.
Base for a tag action on the tag browser panel.
since 8.0
Says what a tag is, in the words an agent should see — a kind (
opc, memory,
UdtInstance, Folder) paired with a qualifier (Int4, PumpType) when there is one.This interface is the same as QualifiedValue.
Protobuf type
common.protobuf.tags.TagValuePBProtobuf type
common.protobuf.tags.TagValuePBBuilds and reads the
AuditProvenance a tag write carries from its origin site (scripting,
RPC, a Perspective binding, the Gateway Network, or the Gateway web API) to the tag provider.Prompt assist provider for selecting an existing destination folder for generated UDT instances.
An exception that can be used in the process of canceling a task.
Extends from
ProgressListener to add the ability to tell the task that it has been
canceled.Provides the current state of a progress operation.
This is a helper wrapper class that simply adds an increment() function around the
ProgressListener, and tracks the current progress internally.
Convenience builder to create telemetry contributors that contribute some part of a json
document.
Vision component that renders multiple template instances inside it.
Event object for template events.
Created by carl.gould on 10/21/2014.
This is an editor (to be used in the vision module's property table) that uses an editable tree
combo box that browses the template hierarchy
A point in time carrying a value, a source and a type, comparable by timestamp.
A batch of points of one type, with the future that completes with their storage result.
The type of a temporal point.
Describes a translatable term inside of a component.
Test class.
This is just a class that's here to have a convenient main() method to run
Helpers for writing tests.
This class represents text.
A text editor subclass for editing text in a Swing component.
String table cell editor with touchscreen support
A base class for using Snap Text in Swing.
A special drop handler for components who are setting the tag value to a text property.
A text area subclass for consoles.
A basic subclass of JTextField that fires more property change events for "text" by adding a
document listener
Wrapper around various components that can be modeled like a JTextComponent.
Snapshot of a text component's user-visible state at a single moment.
Wrapper for the extension-function panel.
A class to represent text with attributes.
A custom class.
A panel for editing text files.
Fills the area with a solid fill at some transparency level.
A base class for text classes that have location and size.
The Run class represents a range of characters in an TextLine that share common attributes.
A class to represent a selection of text.
Created by carl.gould on 5/5/2015.
A class to hold style attributes for a text run.
A class to represent a group of characters in a line that share a set of attributes.
This class provides Swing GUI editing for text shapes.
This tool provides inspector functionality for advanced text attributes.
Text constants.
Text Utilities.
The class this annotation is attached may be assumed thread-safe.
Aggregates items, grouping them if they are submitted consecutively within a specified delay or
if a specified maximum delivery frequency dictates that no more deliveries can be made at the
time.
java.lang.Throwable
java.lang.Throwable
Protobuf type
common.protobuf.tags.ThrowablePB.StackTraceElementPBProtobuf type
common.protobuf.tags.ThrowablePB.StackTraceElementPBCarries a
Throwable to a peer: its class name, message, stack trace, cause chain and, for
an RpcException, its error code.A class of utility methods to make exception handling cleaner.
This class is a GoF "Decorator" that augments the "raw"
Date_selector_panel with a title that displays
the time of day Create a time date selector like this:Runnable which wraps another runnable and records its execution duration using a
TimerA timeline is a simple list of time segments.
A timeline list is a list of values that cover a span of time.
This class is used to organize overlapping time events.
com.inductiveautomation.ignition.common.util.TimelineList + com.inductiveautomation.ignition.common.util.Timeline
com.inductiveautomation.ignition.common.util.TimelineList + com.inductiveautomation.ignition.common.util.Timeline
com.inductiveautomation.ignition.common.util.TimelineSet
com.inductiveautomation.ignition.common.util.TimelineSet
com.inductiveautomation.ignition.common.util.Timeline.TimelineStyle
com.inductiveautomation.ignition.common.util.TimelineList.TimeSegment
com.inductiveautomation.ignition.common.util.TimelineList.TimeSegment
This dataset wrapper limits the view to a specific time range.
This class provides information about the specific absolute time to run, but also the symbolic
time of day, and the id of the event that was used to generate it.
Represents a time range with optional boundary inclusion.
Protobuf binary adapter for
TimeRange.Protobuf type
common.protobuf.TimeRangePBProtobuf type
common.protobuf.TimeRangePBSealed time-range specifier on a
HistorianQueryBindingConfig.Absolute start/end.
Sliding window anchored at the current tick's "now".
Concrete resolved range.
Created by carlg on 4/28/2016.
Serializer for encoding and decoding
TimerKey attributesTab for editing timer event scripts.
The trigger configuration of a timer event script: how often it runs, in what timing mode, and on
which thread.
How the interval between runs is measured;
toString() is the schema token.Which thread the timer runs on;
toString() is the schema token.Deprecated.
Deprecated.
use the Historian
QueryEngine pipeline.
com.inductiveautomation.ignition.common.util.TimeUnits
Protobuf type
common.protobuf.TimeUnitsPBProtobuf type
common.protobuf.TimeUnitsPBRepresents a window of time with a size and unit.
Protobuf binary adapter for
TimeWindow.Protobuf type
common.protobuf.TimeWindowPBProtobuf type
common.protobuf.TimeWindowPBProtobuf enum
common.protobuf.WindowUnitAn
EventBus Event for publishing time zone changes within the designer.Listens for
TimeZoneChangeEvent on the CommonContext.getEventBus() by
registration.TimeZone editor that lets the user choose any of the internal timezones, or the special timezones
"Gateway Timezone" or "Client Timezone"
Deprecated.
Annotation for adding a string title to a Resource Schema objects.
This class is a GoF "Decorator" that augements the "raw"
Date_selector_panel with a title that displays
the month name and year.Annotation for adding i18n Title keys to Resource object fields.
The shared title pane for any AbstractManagerPanel.
Marker interface for classes that are slated for deletion
A linked list of tokens.
Describes the input token stream.
Describes the input token stream.
Represents a portion of a char sequence.
Describes the input token stream.
Describes the input token stream.
A basic implementation of a Token.
CUP generated class containing symbol constants.
A class to extract tokens from a char sequence.
Token Manager Error.
Marks a method as a tool callable by an AI model.
This is the base class for tools in RM - the objects that provide GUI editing for RM shapes.
An inner class describing a shape and a handle.
A group of
CallableTools contributed to an Agent as a unit.Declarative metadata for a tool: how it's identified to the model.
Describes a parameter of a
Tool-annotated method.Helpers for building
CallableTools.Simply concatenates all sub expressions into a single string value.
Use this class in panels where you want a AutoResizingTextArea with touch screen capability.
Filename: TouchscreenEnabledTable.java Created on Dec 26, 2014 Author: Kathy Applebaum Copyright
Inductive Automation 2014 Project: FactoryPMI_Client
Moved to api/client/components/touchscreen
This mouse listener implements touchscreen logic for most
TouchscreenMouseListener.TouchscreenEnabledComponent
vision components.Filename: TouchscreenTable.java Created on Dec 26, 2014 Author: Kathy Applebaum Copyright
Inductive Automation 2014 Project: SRClientAPI
Use this class in panels where you want a text field to have touch screen capability.
TPC = Thread Performance Context
This class simply contains some constant strings for common systems to encourage consistency.
Describes the context in which a thread is executing
Callback object returned by the various "set*" methods that is used to un-set whatever was
previously set.
A Byte array that notifies an instance of child interface "Tracker" about the progress through
the stream
An interface for a set of transactions.
Whether a harness writes a conversation transcript.
Created by carlg on 1/26/2017.
Configuration required for transform
A way to create transform instances of a certain transform type.
Transforms events based return value from user's script function.
Use on either the getter or setter method (or both) of a property to mark it as transient with
respect to the XMLSerializer.
TransitionFactorys are responsible for
instantiating TransitionElements; the interface
encapsulating the execution logic of an SFC transition.Filename: TranslatablePanelTitledBorder.java Created on Sep 26, 2014 Author: Kathy Applebaum
Copyright Inductive Automation 2014 Project: Vision
Filename: TranslatableTitledBorder.java Created on Sep 26, 2014 Author: Kathy Applebaum Copyright
Inductive Automation 2014 Project: Vision
A container for a single translated key.
This class contains translated keys for a specific locale.
The primary translation editing surface: a list of keys beside a per-locale value editor.
The supported translation export formats.
Dialog content for exporting the project's translations to a single archive file.
The supported translation import formats.
The translation manager content panel: a toolbar plus three swappable surfaces (the translation
editor, the language picker, and the key-entry workspace).
Hosts the
TranslationManager panel in a standalone top-level window, opened from the
designer's Tools menu.A map of Locales to translated strings for a specific key.
A translation package holds the keys and one or more translations for the keys.
A specialized translation package that tracks added, modified, and removed keys and translations.
Settings that define how translations are handled, including normalization rules like ignoring
whitespace or punctuation.
A lightweight inline popup for editing the translation matching settings (the key-hash rule).
Message sent to the perspective client containing information about the localization terms
available for a locale.
Tools used for translating component properties.
Deprecated.
No longer needed since Java 5
A Class that implements the listener registration and event fire methods for a TreeModel.
Static utility methods for working with
BindableTreeNode trees.A JPanel that combines a tree and a table for the tag browser in a clever way to make it look
like a bonafide treetable! Hack-a-riffic!
This annotation can be used to protect any gateway network intent object (service, service
method, or intent) such that it can only be called if the specified moduleId is licensed, or if
the demo period is not expired.
One event-script tab's trigger-configuration contract with the embedded assistant: the schema a
proposal must satisfy, the configuration the panel holds right now, and the write-back and
preview for a proposal the user accepts.
A JList-like component that uses TristateCheckBoxes for each item
A
CheckBoxTreeSelectionModel extended to support three checkbox states.Binders for
TriStateCheckBoxTree that manage checked state via a two-path design.Simple implementation of
X509ExtendedTrustManager that trusts all certificates.Simple implementation of
X509TrustManager that trusts all certificates.The TTSEngineManager is exposed as a module service in order to permit modules to register new
engines, and modules to utilize TTS when available.
A very simple interface that generates an audioinputstream for text.
com.inductiveautomation.ignition.common.tags.browsing.TypeDefBrowseValue
com.inductiveautomation.ignition.common.tags.browsing.TypeDefBrowseValue
TypeDescriptors for common backend types that aren't available in the designer for
autocompletion.Thrown by
AgenticHarness.send(String, Class) when the turn itself succeeded but the
model's final reply could not be decoded into the requested type.This filter is used to specify types of annotations to return during a query.
com.inductiveautomation.ignition.common.sqltags.history.annotations.TypeFilter
com.inductiveautomation.ignition.common.sqltags.history.annotations.TypeFilter
com.inductiveautomation.ignition.common.sqltags.history.annotations.TypeFilter
com.inductiveautomation.ignition.common.sqltags.history.annotations.TypeFilter
Represents a condition that dictates how potentially matches should relate to the given type id.
Initializes most basic classes.
This is a definition of a Udt type, including all of its members.
Used when we need to dynamically build out a BrowseNodeInfo tree based on the current
StructureNodes in the tag editor.
Protobuf type
common.protobuf.tags.MembersPbProtobuf type
common.protobuf.MembersPbProtobuf type
common.protobuf.tags.MembersPbProtobuf type
common.protobuf.MembersPbProtobuf type
common.protobuf.tags.UdtDefinitionInfoPBProtobuf type
common.protobuf.UdtDefinitionInfoPBProtobuf type
common.protobuf.tags.UdtDefinitionInfoPBProtobuf type
common.protobuf.UdtDefinitionInfoPBAgent for the UDT Definition Editor's embedded assistant.
Apply callbacks for UDT editor suggestions rendered in the embedded assistant.
One ordered structural edit proposed by the UDT editor assistant.
Supported targeted edit operations in the assistant JSON contract.
Applies UDT assistant suggestions to the active Tag Editor draft.
Minimal bridge implemented by the Tag Editor side of the integration.
Fast, editor-local state captured from the UDT Definition Editor on submit.
OPC source information from the primary-selected member.
One selected root or member node from the structure tree.
UDT editor JSON codec helpers that use the normal tag import/export conventions exposed by
TagUtilities.TAG_GSON.Composes the UDT editor's live snapshot into the assistant message's host-context blocks; the
framework appends the canonical references block and the user's prompt.
Bounded related UDT context loaded outside the Swing event thread.
Loads bounded related UDT context for the UDT editor assistant.
Parsed inner payload from a
ResponseEnvelope.Suggestion#value() string for the UDT editor
assistant.Top-level inner payload variants supported by the UDT editor assistant.
Non-throwing parse result for renderer and validator entry points.
ReplyRenderer for UDT Definition Editor suggestions.Complete context snapshot used to compose one UDT assistant turn.
Captures editor-local UDT state immediately and optionally loads related UDT context on a worker.
Detached validator for UDT editor AI payloads.
Validation result for a replacement or full targeted-change batch.
Validation result for one targeted change in a batch.
One validation message for either the whole batch or an individual change.
Severity levels surfaced to the suggestion renderer.
JSON Pointer style path rooted at the UDT currently open in the Tag Editor.
Destination parent resolved for a move operation.
Resolved location for an edit path.
Kinds of JSON locations that a UDT edit path can resolve to.
Converts accepted AI wizard UDT-instance rows into normal Designer
TagConfiguration
drafts.Row-mapped generated draft.
Full result of tag draft generation, including plan-level and row-level diagnostics.
Mode-specific plan for creating UDT instances.
Compact generated axis such as a numeric range or explicit list.
Declarative mapping from dimensions/source fields/constants into preview fields.
Resolved destination folder for generated instances.
Prompt assist provider for selecting the UDT type the AI Multi-instance Wizard should
instantiate.
This property node represents a sub-tag of a UDT property.
Represents a UI event sent to a UIOwner.
Types for events.
A class to provide utility methods for UI components.
A base controller class class that manages a SwingPanel usually loaded from a rib file.
A Vision Module settings resource object.
Utility class for building common Swing UI components with consistent styling and behavior.
A utility class for UI related needs.
Underline border that is best used for JLabels.
Deprecated.
in favor of
UnderlineBorderUsed to take control of the undo/redo stack.
Swing UI editing for undos.
An UndoAction to allow page configuration changes to be controlled via the UndoManger.
Represents a de-constructed component group for helping to support undo/redo
Implement to not exposed child nodes.
A marker class, used to indicate that the EventData came from a remote source and all props
should be trusted/accepted
A tag browse tree that displays realtime and historical providers together in one tree
A exception thrown whenever the system tries to do or access something that has not been
licensed.
An aggregate known only by id: built where no aggregate catalog is available (client scripting,
RPC decode) and resolved to the engine's real
AggregationType by the gateway before the
query runs.Extension of
ProjectResourcePathValidatedTextField which performs an additional validation after the path
check to ensure that the path resolved to a query with an update type (see FB9017).Configuration resource for gateway update scripts.
A tab for editing update scripts
A multipart file part that has been buffered into a
DeferredFileOutputStream.A model-provider call failed for a provider-side reason.
Host-supplied surface for pausing the agent's tool-dispatch loop to consult the user.
LibraryPromptAssist over the project's user-defined script library — the Jython modules
authored under "Project Library" — letting the user drop a reference to a symbol they authored
into an AI prompt.Agent tool surface for browsing the project's user-defined script library — the Jython modules
authored under "Project Library" in the Designer.
This is available to the user as the saveContext variable passed in on certain extension
functions.
Filename: UserManagementPanelTermFinder.java Created on Dec 26, 2013 Author: Kathy Applebaum
Copyright Inductive Automation 2013 Project: Vision
com.inductiveautomation.ignition.common.user.User
com.inductiveautomation.ignition.common.user.User
Event object for when the user sends a message to one of the perspective event buses.
Represents the data that gets stored in the users.json file for each internal user source
profile.
A special
IllegalArgumentException thrown by the UsersJsonResource constructor in
the event that duplicate users sharing the same username / user ID or duplicate roles sharing the
same role name / role ID are detected, or if a user has a role ID that doesn't existThis enumeration contains capabilities that a user source can support.
Base class for
ExtensionPoints that provide a UserSourceProfile implementation.A user management profile provides access to users, groups, and provides authentication
verification for users.
Configuration for a user source profile.
The nucleus of a User Source Profile.
UUID-shaped node id, for backends keyed by UUID such as QuestDB, SQLite and file-backed ones.
An abstract class that extends
ValidatedComboBox with an abstract ValidatedWorkerComboBox.doInBackground() method to return a List of the supplied type T.Engine for validating values of a given type.
This record (which is designed to be directly GSON-serializable) models validation error
messages.
A kind of
DecodingException that contains specific validation errorsComponent that displays an icon indicating the validation status.
This is basically a glorified wrapper around a Multimap<DocumentNode, String>
Interface for validating text.
Protobuf type
ignition.rpc.ValueProtobuf type
ignition.rpc.ValueProtobuf type
ignition.rpc.Value.ValueCollectionProtobuf type
ignition.rpc.Value.ValueCollectionProtobuf enum
ignition.rpc.Value.ValueCollection.ImplementationDeprecated.
use the Historian
QueryEngine pipeline.A cache of value shared across all sessions.
This is the tag script for any change of value (including quality change).
This editor knows how to edit the basic types for json: string, boolean, null, and number, as
well as two special types: Date and Dataset.
Top-level value-format selector for the historian.query binding.
since 8.0
A historical column that contains a list of arbitrary values.
Deprecated.
Where the values of a data collection come from.
A condition that dictates whether the target value should be a specific quality, or a more
general quality condition, like "good".
Handles scaling of values for tags.
clearVariables() clears all of the stored variables and returns the number of variables
cleared.
deleteVariable(name) deletes a named variable.
storeVariable(name, value) stores the variable and returns the stored value.
A Vector icon is an Icon implementation that uses Java2D to draw the icon from a Shape object,
rather than using a raster image.
Represents a source of
VectorIcon instances.This interface is for a property set that has knowledge of which properties have changed since a
certain point.
com.inductiveautomation.ignition.common.model.Version
com.inductiveautomation.ignition.common.model.Version
Just like FlowLayout, but vertical!
Just like FlowLayout, but vertical!
Just like VerticalFlowLayout, but columns share width equally
A modified version of FlowLayout that allows containers using this Layout to behave in a
reasonable manner when placed inside a JScrollPane
Config object for a single view definition.
Message which is used in both the Designer.js handler, and in the
PerspectiveDesignSession.Subclass of JavaJsBridge for the view editor, to provide the link between the methods defined in
the bridge and the editing of the view.
Tree node implementation used for browsing views.
A class used to specify a specific instance of a running
DesignerViewModel, where the
resourcepath designates a specific view's path in the Resource hierarchy as seen in the
designer's resource browser tree.This is a marker interface denoting classes intended for usage as view models.
Delegates to the actual view, this prevents the scripting system from being able to call
everything on ViewModel, like startup(), shutdown, etc.
Created by carlg on 6/6/2017.
Encapsulates the logic of creating the "Parameters" sub-menu for synchronizing view parameters in
perspective component property editor and docked view config popup ui.
PerspectiveEditor is used as the editor when the Perspective Workspace is active and editing a
Perspective Project Resource.
Serialization helper class for view saves that includes size info about the view itself, used
for getting appropriately sized screenshots
Created by carlg on 11/23/2016.
Created by carlg on 11/23/2016.
Created by carlg on 6/13/2017.
Fired on the
DesignerViewModel's EventBus when a component is added, removed, or
replacedThis is the
ResourceWorkspace for perspective View resources.Actions associated with the Perspective workspace
Created by colby.clegg on 1/30/2015.
A binding that will set the Visible state of the annotated component to the state of a model
boolean.
Enum to specify if normal or inverted comparisons should be used.
Inner utility class that performs the runtime wiring of all
VisibleIf bindings.This validator, which is a proprietary json-schema extension that we added for Ignition, supplies
a condition to control when a given property should be visible by specifying a sibling property
and value(s) for which this property is considered relevant.
A Table component that features greater features like Drag and Drop rows, multi-column sorting,
filtering, etc.
Filename: VisionAdvancedTableTermFinder.java Created on Oct 31, 2014 Author: Kathy Applebaum
Copyright Inductive Automation 2014 Project: Vision
Bean Descriptor
Minor extension of ClientContext that gets used to initialize bindings and components
The public API interface for the Vision client.
An aggregate interface that marks the typical interfaces required by most Vision components.
An interface that marks a component that is used as a container for other components.
Optional sub-interface for customizers that want to be notified when they are displayed
This is the core of the Vision module, implementing both
DesignerModuleHook and VisionDesignerInterface.DesignerResourceMeta entries for every Vision project resource type.This is the custom JDesktopPane that makes up the top level of the Vision client that manages all
the open windows.
An interface that allows modules to listen to when windows are opened and closed.
Interface for a visitor class.
A Label with a warning indicator to the right of some text.
A normal textfield, that supports a watermark which is displayed when the text box is empty.
Superclass for
BindableModel instances, this class handles the binding tasks for
subclassed models.A stand-alone implementation of
BindableModel.This class manages data site.
Encapsulates useful information for diagnosing authorization decisions
Encapsulates a snapshot of authentication and authorization state
Immutable details of a user who is federated into the system
Provides context about a user who authenticated using web-based protocols such as OIDC or SAML
Provides a fluent-API (builder-style) pattern for creating new
WebAuthUserContext
objectsA
JsonSerializer and JsonDeserializer implementation for serializing and
de-serializing WebAuthUserContext objects to / from JSON using GSON APIs.A class loader for a WebSite.
A frame which presents the chromium debug tools for the currently selected/active Perspective
View Resource.
Represents a file from a WebSite.
An interface for classes that want to post modifications to files.
Web Server settings taking into account all of the web servers settings to provide connection
details for the Gateway.
This is an abstract class to provide data management (create, get, put, delete) and file
management.
Interface for Servlet.
This class provides functionality to import a list of connected maps.
Encapsulates a WebSocket Session and logic to send messages conforming to the messaging protocol
between the Gateway and the Designer / Vision Clients.
A
WebSocketChannel connection that is mounted for realtime messaging between a running
web-client and the Ignition gateway's Perspective module.This Exception is thrown when there is a problem sending a message over the WebSocketChannel
Protobuf type
ignition.rpc.WebsocketProtoMessageProtobuf type
ignition.rpc.WebsocketProtoMessageProtobuf type
ignition.rpc.WebsocketProtoMessage.ConnectionModeProtobuf type
ignition.rpc.WebsocketProtoMessage.ConnectionMode
Actual enum constants match those defined in GatewayConstants
A lightweight control message sent in place of a PushNotifications batch when that batch's
serialized size exceeds a threshold, triggering an RPC 'pull' out of the WebSocket band.
A lightweight control message sent in place of a PushNotifications batch when that batch's
serialized size exceeds a threshold, triggering an RPC 'pull' out of the WebSocket band.
Protobuf type
ignition.rpc.WebsocketProtoMessage.PingProtobuf type
ignition.rpc.WebsocketProtoMessage.PingProtobuf type
ignition.rpc.WebsocketProtoMessage.PushNotificationProtobuf type
ignition.rpc.WebsocketProtoMessage.PushNotificationProtobuf type
ignition.rpc.WebsocketProtoMessage.PushNotificationsProtobuf type
ignition.rpc.WebsocketProtoMessage.PushNotificationsRepresents a UI component that can be rendered in the web UI.
A session for the react-based web ui for the Gateway, introduced in Ignition 8.3.0.
A
WebUiSession.WebUiSessionAccessControl which requires that each request furnish a valid CSRF
token.An
AbstractGatewayAccessControlStrategy where auth context such as user information and
granted security levels are derived from Web UI session cookies.A
SessionManager which manages WebUiSession instancesA class to represent a URL for a WebSite and WebFile (it can be both for nested sources).
A class to load URLs.
Utility methods for Web classes.
This class provides the welcome panel for RM.
This class provides the welcome panel for RM.
This class provides the welcome panel for RM.
A final class that provides well-defined system flavors.
This class is used as a base for enum-like static definitions of AlarmProperties.
These are path identifiers used by
QualifiedPath for the well-known objects in Ignition.The
TabbedResourceWorkspace calls this right after it obtained the ResourceEditor
that it's about to through the sequence to close the editor.Maps an event timestamp to the start of its window.
Engine-suggested window size for aggregated queries with no explicit window, for example
(endMs - startMs) / returnSize.Every event is its own window; for raw queries.
Fixed-size, non-overlapping windows aligned to
startMs.Implement one of these and register it with the VisionDesignerInterface if you want to add drop
handling to the window workspace.
A project resource object stored for only the Designer's scope.
The first and last stored samples, of any quality, in an aggregate's window.
Identifier for a closed time window:
[startMs, endMs).WindowInfo is a wrapper type that contains an FPMIWindow.
Implementors of this class will be used to initialize a window right before its bindings are
connected and started up.
Custom scale controls that color themselves according to anchoring layout
Executes wmic (Windows Management Instrumentation Command-line) with various (extensible)
parameters to pull various system elements.
The methodns in "NavUtilities" mounted under system.nav.* used to be mounted under system.gui.*
These are the scripting functions mounted at system.gui.* Changes to this class must be made
carefully, as some of the true implementations actually reside in the subclass,
WindowUtilitiesForDesktop.
An object that is used to let the windowing system know when a popup is about to be shown, and
when it has hidden.
This class contains methods that are mounted under system.gui.* that are specific to individual
desktop instances.
Defines the options available for drawing dependency arrows
Interface for classes that actually perform a specific wiring.
This class manages a specific wizard, like "Form 1040EZ" or "Table with Groupings"
This class runs the main welcome panel.
A wizard screen is a one screen module that provides UI to get wizard data.
Listener for workspace de/activation
Note: it is recommended to extend the
SecureWriteHandler instead of the WriteHandler directly.A WriteOperation is returned in response to a write request for a tag.
Single-shot carrier used by the tag write pipeline to report the value a tag held immediately
before a write was applied.
To participate in a tag write pipeline, a TagActor must implement this interface.
Represents the result of a tag write operation, encapsulating the quality of the operation and
optionally the value the tag held immediately before the write occurred.
com.inductiveautomation.ignition.common.tags.model.WriteResult
com.inductiveautomation.ignition.common.tags.model.WriteResult
Serializes a
WriteResult for Gateway-Network transport.Created by carlg on 11/23/2016.
A resource that holds settings for an outgoing Gateway Network connection.
A wizard screen used to select a detail keys.
A wizard screen used to select a grouping key.
A wizard screen used to select header names.
A wizard screen used to select a list key.
A wizard screen used to select sort keys.
This provides static methods to convert an XML text into a JSONObject, and to covert a JSONObject
into an XML text.
This class maintains a pool of XMLReaders.
Used while serializing to keep track of references and indentation.
The XMLTokener extends the JSONTokener to provide additional methods for the parsing of XML
texts.
Deprecated.
since 8.3.
A WebSite subclass for Zip files.
A ZipFile.
The ZipMap provides a convenient way of working with zip files by providing a
Map that is
backed by a zip file.Represents a permission requirement, where the request must originate from a specific security
zone and/or be initiated by a user which has a certain role.
Tests an input IP address against a comma-delimited pattern list.
If the setting is true, the value must be true, otherwise true or false works.
A ZoomableResourceEditor is a designer interface that allows that allows for the 'zooming' in and
out on the content in the main resource workspace panel such as seen in and Report resources.
Filename: ZoomIndicator Author: Perry Arellano-Jones Created on: 6/30/15 Project:
ignition_dev_7_8B
QueryEnginepipeline.