Documentation Center

Plug-ins User Guide

Version 5.2 | Published March 20, 2024 ©

External Interface

The external interface to DataPool is based on Viz messages sent to the DataPool plug-in. Each message contains a series of data assignments to different DataFields.

The structure of the message is:

command1 command2 command3 ...

The structure of each command is as follows:

<Name>[items range] = datum1, datum2, datum3, ...;

Where name is the name of the DataField to assign data to and items range is a description of items to which the data is addressed.

Note: The semicolon is part of the command and should be added at all times. It is used to define the end of the command.

The item ranges are a comma-separated list of indexes, or a from-to index.

Examples

  1. Send data to a field named VALUE:

    VALUE=30;

  2. Send data to the first five values of a field called VALUES:

    VALUES[0-4] = 0, 1, 2, 3, 4;

    The above is equivalent to sending:

    VALUES[0]=0; VALUES[1]=1; VALUES[2]=2; VALUES[3]=3; VALUES[4]=4;

    Note: The indexes of the items are zero-based (start from 0).

  3. Send data to the items 1-3, 55-57 and 101:

    VALUES[1-3,55-57, 101] = 0, 1, 2, 3, 4, 5, 6;

    This is equivalent to sending:

    VALUES[1]=0; VALUES[2]=1; VALUES[3]=2; VALUES[55]=3; VALUES[56]=4; VALUES[57]=5; VALUES[101]=6;