Skip to content

MessagePorts

The ADOxx API is available through MessagePorts. MessagePorts are internal instances in ADOxx, which are parts of any component and receive strings (messages) containing component-specific commands. Actually a message is a LEO text.

When a message is received, the MessagePort decodes it and executes the desired command. Some commands return a value. Mostly the return value is also a LEO text, which makes it possible that structured values are returned.

Sending messages can be achieved in AdoScript using the SEND or CC commands. CC should be generally preferred as it handles the building and processing of the necessary LEO text, i.e. assigning encoded values to runtime variables. As such it is used in this documentation instead of SEND wherever it is possible.

The lists further below contain the MessagePort commands available in ADOxx 1.8 in alphabetical order. The following list contains a general assignment of MessagePorts to API categories.

MessagePort categorization

  • Application APIs:
    • Application - interface to the application and its main window.
    • Drawing - interface to the drawing component (access on graphical models without the need of a model window).
  • Component APIs:
    • Analysis - interface to the Analysis Component.
    • AQL - executing AQL queries.
    • Documentation - interface to the Documentation Component.
    • ImportExport - interface to the Import/Export Component.
    • Modeling - interface to the Modelling Component.
    • Simulation - interface to the Simulation Component.
  • Manipulation APIs:
    • Core - interface to the ADOxx core, meaning storing and accessing model data.
    • DB - interface to the database component.
    • UsrMgt - interfaces to the User Management (Development Toolkit).
  • UI APIs:
    • AdoScript - useful dialogues and other general support.
    • CoreUI - dialogues to model and attribute profile selection, tabular view.
    • Explorer

AdoScript

Analysis

Application

AQL

Core

CoreUI

DB

Documentation

Drawing

Explorer

ImportExport

Modeling

Simulation

UserMgt