Package com.inductiveautomation.ignition.client.model

Interface ClientContext

All Superinterfaces:

CommonContext

All Known Subinterfaces:

DesignerContext, VisionClientContext

All Known Implementing Classes:

AbstractClientContext, ClientContextImpl, DesignerContextImpl, DesignerContextProxy

public interface ClientContext
extends CommonContext

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
void	addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener pcl)
java.lang.Object	deserialize(byte[] data, org.apache.log4j.Logger log)	Convenience function to deserialize a gzipped byte array into a single object.
java.lang.String	getAuthProfileName()	Returns the current project's user source
java.lang.String	getDefaultDatasourceName()	Returns the current project's default datasource name
java.lang.String	getDefaultTagProviderName()	Returns the current project's default Tag provider
ExecutionManager	getExecutionManager()	Returns the shared task execution manager for this client
LaunchContext	getLaunchContext()
ClientLocalizationManager	getLocalizationManager()
java.util.List<ModuleInfo>	getModules()	Retrieve the list of all modules currently loaded in this context
NamedQueryManager	getNamedQueryManager()	Returns the appropriate named query rpc for the context.
ClientProgressManager	getProgressManager()	Returns the progress manager, which allows the execution of long running or async tasks.
Project	getProject()	Returns the project that this client is running.
java.lang.String	getProjectName()	The name of the project this client will be / is running
javax.swing.RootPaneContainer	getRootPaneContainer()	Returns the RootPaneContainer that is currently the owner of the client
ClientTagManager	getTagManager()	Returns the manager that provides access to Ignition's tag system.
int	getTagPollRate()	Returns the rate at which Tags should be polled for updates
com.google.common.eventbus.EventBus	getUIEventBus()	This event bus schedules event notification on the swing EDT.
void	removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
void	removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener pcl)

Methods inherited from interface com.inductiveautomation.ignition.common.model.CommonContext

createDeserializer, getEdgeEditions, getEventBus, getExpressionFunctionFactory, getLicenseState, getLoggingManager, getModule, getScriptManager

Method Detail

getTagManager

ClientTagManager getTagManager()

Description copied from interface: CommonContext

Returns the manager that provides access to Ignition's tag system.

Specified by:

getTagManager in interface CommonContext

getExecutionManager

ExecutionManager getExecutionManager()

Returns the shared task execution manager for this client

getTagPollRate

int getTagPollRate()

Returns the rate at which Tags should be polled for updates

getDefaultDatasourceName

java.lang.String getDefaultDatasourceName()

Returns the current project's default datasource name

getDefaultTagProviderName

java.lang.String getDefaultTagProviderName()

Returns the current project's default Tag provider

getAuthProfileName

java.lang.String getAuthProfileName()

Returns the current project's user source

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)

addPropertyChangeListener

void addPropertyChangeListener(java.lang.String property,
                               java.beans.PropertyChangeListener pcl)

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)

removePropertyChangeListener

void removePropertyChangeListener(java.lang.String property,
                                  java.beans.PropertyChangeListener pcl)

getRootPaneContainer

javax.swing.RootPaneContainer getRootPaneContainer()

Returns the RootPaneContainer that is currently the owner of the client

deserialize

java.lang.Object deserialize(byte[] data,
                             org.apache.log4j.Logger log)
                      throws SerializationException

Convenience function to deserialize a gzipped byte array into a single object. If multiple objects are found, they will be discarded. Warnings are logged to the given logger. If data is null or empty, null is returned.

Throws:

SerializationException

getModules

java.util.List<ModuleInfo> getModules()

Retrieve the list of all modules currently loaded in this context

getProgressManager

ClientProgressManager getProgressManager()

Returns the progress manager, which allows the execution of long running or async tasks.

getLocalizationManager

ClientLocalizationManager getLocalizationManager()

getLaunchContext

LaunchContext getLaunchContext()

getUIEventBus

com.google.common.eventbus.EventBus getUIEventBus()

This event bus schedules event notification on the swing EDT. This is opposed to the event bus found on CommonContext.getEventBus(), which schedules event notification on a background thread.

Since:

7.9.2

getNamedQueryManager

NamedQueryManager getNamedQueryManager()

Returns the appropriate named query rpc for the context. In the gateway and client, we only want to use named queries that have been saved. In the designer, we want to use the current version so that reports and bindings can be seen and used for testing before the project is saved.

Returns:

The correct NamedQueryManager implementation for the scope.

Since:

7.9.3

getProjectName

@Nonnull
java.lang.String getProjectName()

The name of the project this client will be / is running

getProject

@Nullable
Project getProject()

Returns the project that this client is running. Note that this may be null before the client is fully logged in and started, because the context is created before the project is downloaded.