GETPB, GETPI, GETPR – Blocks for remote parameter acquirement

Block SymbolsLicensing group: STANDARD
Qt SVG Document Exported by REXYGEN Studio GET Y E GETPB Qt SVG Document Exported by REXYGEN Studio GET k E GETPI Qt SVG Document Exported by REXYGEN Studio GET y E GETPR

Function Description
The GETPR, GETPI, and GETPB blocks are used for acquiring the parameters of other blocks in the model remotely . Blocks have identical functionality, differing only in the type of parameter they acquire. The GETPR block is for a real number, GETPI for an integer, and GETPB for a Boolean value. To comply with the naming convention for variables 1.3, the outputs of individual blocks are named according to the type of the acquired parameter:

  • y – real output of the GETPR block,
  • k – integer output of the GETPI block,
  • Y – Boolean output for the GETPB block.

The blocks operate in two modes, which are switched by the GETF parameter. For GETF = off the output y (or k, Y) is set to the value of the remote parameter at the start and every time when the remote parameter changes. If the GETF parameter is set to on, then the blocks work in single-shot read mode. In that case the remote parameter is read only when rising edge (off on) occurs at the GET input.

The name of the remote parameter is determined by the string parameter sc (string connection), which has the form <block_path:parameter_name>. It is also possible to access individual items of array-type parameters (e.g. the tout parameter of the ATMT block). This can be achieved using the square brackets and item number, e.g. .ATMT:touts[2]. The items are numbered from zero, thus the string connection stated above refers to the third element of the array.

The path to the block whose parameter should be read can contain hierarchic levels separated by dots followed by the block name. The path can be either relative or absolute:

  • Relative:
    • Starts with a ’.’ character, indicating the level where the GETPR block (or GETPI, GETPB) is placed. Examples: ".GAIN:k", ".Motor1.Position:ycn".
    • Starts with ’..’ characters, indicating a level above the GETPR block (or GETPI, GETPB). Examples: "..GAIN:k", "..Motor1.Position:ycn".
  • Relative to Task: Starts at the root level of the task where the GETPR block (or GETPI, GETPB) is located. The string has to be prefixed with ’%’ in this case. Examples: "%GAIN:k", "%Motor1.Position:ycn".
  • Absolute: A complete sequence of hierarchic levels down to the block. For referring to blocks located in the driver task (see the IOTASK block for details on configuration) the ’&’ followed by the driver’s name is used at the beginning of the absolute path. Examples: "task1.inputs.lin1:u2", "&EfaDrv.measurements.DER1:n".

The order and names of individual hierarchic levels are presented in a tree-like structure within the Diagnostics section of the REXYGEN Studio program.

Warning: If the remote parameter is in a task other than the GETPx block, block execution is delayed until the remote task is completed. It is necessary to avoid the so-called race conditions and guarantee the correct value reading. Therefore, it is recommended to include the GETPx block in a slower task (longer period/execution time) and read parameter in a faster task (shorter period/execution time). In the opposite situation (e.g. the GETPx block in a faster task), the SETPx block should be used in a slower task.

Note 1: When using multiple GETPx blocks, it is not guaranteed to read all data from a remote task in the same tick. It is only guaranteed that the previous block will receive a value in the same or previous period as the next block. The execution order can be seen in the REXYGEN Studio program diagnostics. To obtain multiple values in the same period, it is needed to use the Inport and Outport blocks or the GETPA block.

Note 2: The GETPX and INCONN blocks can also be used to read the value remotely.

This block propagates the signal quality. More information can be found in the 1.4 section.

Input

GET

Input for initiating one-shot parameter read

Bool

Parameter

sc

String connection to the parameter

String

GETF

Get parameter only when forced to

Bool

off ..

Remote parameter is continuously read

on ...

One-shot mode

Output

y

Parameter value

Double (F64)

E

Error indicator

Bool

off ..

No error

on ...

An error occurred

2024 © REX Controls s.r.o., www.rexygen.com