Differences

This shows you the differences between two versions of the page.

--- get_map_value [2015/10/11 23:48]
admin
+++ get_map_value [2026/08/28 03:20] (current)
hermann Sync from local documentation review
@@ Line 1: / Line 1: @@
 ====== Get Map Value ======
 ===== Description =====
-This functor retrieves a map value at specified line and column coordinates.
+Retrieves the value of a map cell at a specified line and column.
 ===== Inputs =====
-^ Name ^ Type ^ Description ^
+^ Name  ^ Type  ^ Description  ^
-| Map  | [[Map Type]]  | Any input map.  |
+| Map  | [[Map Type]]  | Map the value is retrieved from.  |
-| Cell Line  | [[Positive Integer Value Type]]  | Number of the line. If the number retrieved extrapolates the map dimension an error will be reported.  |
+| Cell Line  | [[Positive Integer Value Type]]  | Line of the cell. Line 1 is the topmost line.  |
-| Cell Column  | [[Positive Integer Value Type]]  | Number of the column. If the number retrieved extrapolates the map dimension an error will be reported.  |
+| Cell Column  | [[Positive Integer Value Type]]  | Column of the cell. Column 1 is the leftmost column.  |
 ===== Optional Inputs =====
-^ Name ^ Type ^ Description ^ Default Value ^
+^ Name  ^ Type  ^ Description  ^ Default Value  ^
-| Value If Null  | [[Real Value Type]]  | Value returned in case a null value is found.  | 0.0  |
+| Value If Null  | [[Real Value Type]]  | Value returned when the cell at the specified coordinates equals Map's null value. This is an advanced port.  | 0.0  |
 ===== Outputs =====
-^ Name ^ Type ^ Description ^
+^ Name  ^ Type  ^ Description  ^
-| Cell Value  | [[Real Value Type]]  | Extracted value.  |
+| Cell Value  | [[Real Value Type]]  | Retrieved cell value.  |
 ===== Group =====
@@ Line 28: / Line 28: @@
 ===== Notes =====
-===== Internal Name =====
+Raises an error if Cell Line or Cell Column falls outside the dimensions of Map.
+===== Internal Name =====
 GetMapValue