Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
region [2011/07/31 19:56] hermann [Notes] |
region [2026/08/28 03:31] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Region ====== | + | ====== Region ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This container receives the identifier number of a region internally and passes it on to the functors enveloped by it. | + | This container takes a region identifier and a region manager — normally inherited automatically from an enclosing [[For Each Region]] or another [[Region]] — and re-exposes them to the functors nested inside it. This lets those functors, which already read the current region through auto-bound inputs, be nested one level deeper without an explicit connection. |
| + | |||
| + | This functor is deprecated and will be removed in a future version of Dinamica EGO. | ||
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | None. |
| - | | Region Id | [[Int Type|Int]] | Region identifier. | | + | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Region Manager | [[Region Manager Type|Region Manager ]] | This is internally linked by the “Region Manager” container. | None | | + | | Region Id | [[Integer Value Type]] | Identifier of the region, from the region manager. When this functor is placed inside a [[For Each Region]] or another [[Region]], this port connects to the current region automatically. | Provided automatically | |
| + | | Region Manager | [[Region Manager Type]] | The region manager to use. When this functor is placed inside a [[Region Manager]], another [[Region]], or a [[For Each Region]] container, this port connects to that container's region manager automatically. | Provided automatically | | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| + | |||
| + | None. | ||
| + | |||
| + | ===== Internal Outputs ===== | ||
| + | |||
| + | ^ Name ^ Type ^ Description ^ | ||
| + | | Region Id | [[Integer Value Type]] | Identifier of the region. | | ||
| + | | Region Manager | [[Region Manager Type]] | The region manager holding the regions. | | ||
| ===== Group ===== | ===== Group ===== | ||
| Line 21: | Line 31: | ||
| [[Functor List#Region | Region]] | [[Functor List#Region | Region]] | ||
| - | ===== Notes ===== | + | ===== Notes ===== |
| + | |||
| + | This functor is deprecated and will be removed in a future version of Dinamica EGO. Its main effect — reducing the number of explicit connections by auto-binding the region identifier and the region manager — is already available directly on the functors that need them. | ||
| - | Its use reduces the number of connections, as the region identifier and the [[Region Manager]] are automatically associated with their input ports. | + | Raises an error if Region Id does not identify a region known to the region manager. |
| - | ===== Internal Name ===== | + | ===== Internal Name ===== |
| Region | Region | ||