Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
send_tuple [2020/04/28 13:11] argemiro |
send_tuple [2026/08/28 03:34] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Send Tuple====== | + | ====== Send Tuple ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | Send a tuple using an opened communication session. | + | Sends a tuple of numbers to an external application, such as an R script, through an opened communication session. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | Tuple| [[tuple_type|Tuple]] | Any tuple. | | + | ^ Name ^ Type ^ Description ^ |
| + | | Tuple | [[Tuple Type]] | Tuple of numbers to send. | | ||
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | Tag| [[string_type|String]] | Tuple identifier. | | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| + | | Tag | [[String Type]] | Identifier used to match this tuple with the corresponding receive call in the external application. | Empty | | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | outTuple| [[tuple_type|Tuple]] | Input number. | | + | ^ Name ^ Type ^ Description ^ |
| + | | Out Tuple | [[Tuple Type]] | The tuple of numbers that was sent. | | ||
| ===== Group ===== | ===== Group ===== | ||
| Line 21: | Line 24: | ||
| [[Functor List#Integration | Integration]] | [[Functor List#Integration | Integration]] | ||
| - | ===== Internal Name ===== | + | ===== Notes ===== |
| + | |||
| + | This functor blocks until the tuple is sent. | ||
| + | |||
| + | Raises an error if no communication session is open. | ||
| + | |||
| + | In R, a tuple corresponds to a list or vector of real values, sent or received with Dinamica::sendNumberVector() and Dinamica::receiveNumberVector(). See [[External Communication]] for how to open a session from an external application and exchange data with it. | ||
| + | |||
| + | ===== Internal Name ===== | ||
| SendTuple | SendTuple | ||
| + | |||