Interface DesignerToolFactory


public interface DesignerToolFactory
Hands out the Designer-side ToolBundles every assist agent commonly reaches for. Obtained through DesignerAiContext.tools(); the factory captures the surrounding DesignerContext once and is reused for every caller that needs the same tool surfaces.

Each accessor returns a fresh ToolBundle on every call. The bundle constructs its underlying tool owner lazily, so referencing the same bundle from multiple agents is safe and cheap.

  • Method Summary

    Modifier and Type
    Method
    Description
    Read-only browser for the gateway's SQL datasources, their tables, and columns over the Designer's datasource RPC.
    Read-only browser for the state of the Designer's workspaces, open editors, and project configuration.
    Read-only browser for the connected gateway's configuration — the config types it can hold, their schemas, and the resources configured for each (database connections, device connections, alarm notification profiles, and so on).
    Read-only browser for OPC connections, browse structure, and node metadata exposed through the Designer's OPC browse paths.
    Read-only browser for inspecting a project and it's metadata.
    Read-only browser for Ignition's system.* scripting library.
    Read-only browser for tag configuration — paths, properties, alarms, scripts — backed by the client tag manager.
    Read-only browser for the project's user-defined script library — modules authored under Project Library.
  • Method Details

    • systemLibrary

      ToolBundle systemLibrary()
      Read-only browser for Ignition's system.* scripting library. The model can list available symbols for an execution scope and pull per-symbol documentation.
    • userLibrary

      ToolBundle userLibrary()
      Read-only browser for the project's user-defined script library — modules authored under Project Library. Symbols are addressable from Jython without a system. prefix.
    • tagConfigRead

      ToolBundle tagConfigRead()
      Read-only browser for tag configuration — paths, properties, alarms, scripts — backed by the client tag manager.
    • opcBrowse

      ToolBundle opcBrowse()
      Read-only browser for OPC connections, browse structure, and node metadata exposed through the Designer's OPC browse paths.
    • datasource

      ToolBundle datasource()
      Read-only browser for the gateway's SQL datasources, their tables, and columns over the Designer's datasource RPC. Table listings are capped and filterable.
    • gatewayConfig

      ToolBundle gatewayConfig()
      Read-only browser for the connected gateway's configuration — the config types it can hold, their schemas, and the resources configured for each (database connections, device connections, alarm notification profiles, and so on). Lets an agent ground its answers in real resource names instead of inventing them.
    • project

      ToolBundle project()
      Read-only browser for inspecting a project and it's metadata.
    • designerState

      ToolBundle designerState()
      Read-only browser for the state of the Designer's workspaces, open editors, and project configuration.