Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
print [2013/08/10 14:10] admin [Notes] |
print [2026/08/28 03:29] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Print ====== | + | ====== Print ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This container prints messages to the application console. | + | This container prints messages to the application console before and after executing the functors it contains. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| + | |||
| + | None. | ||
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Initial Message | [[String Type|String]] | Message printed before the execution of the container content. | None | | + | | Initial Message | [[String Type]] | Message printed before the contained functors execute. | None | |
| - | | Final Message | [[String Type|String]] | Message printed before the execution of the container content. | None | | + | | Final Message | [[String Type]] | Message printed after the contained functors execute. | None | |
| - | | Log Level | [[Log Tag Type|Log Tag]] | Message log level. | Unconditional | | + | | Log Level | [[Log Tag Type]] | Log level used to print both messages. The log level indicates whether a message is a regular progress message or an error message, for example. | Unconditional | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| + | |||
| + | None. | ||
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Control|Control]] | + | [[Functor List#Control | Control]] |
| ===== Notes ===== | ===== Notes ===== | ||
| - | To print information about the execution of a given functor or group of functors, put these functors inside the Print functor. It is not advised to use a Print functor without any contained functors because the execution order of this functor will be unspecified. | + | Initial Message, when set, is printed before the contained functors run; Final Message, when set, is printed only after all of them have finished running. Both are printed using the level set in Log Level. |
| + | |||
| + | Using this container with nothing placed inside it is not recommended: with no contained functors to order its execution against, when the message is actually printed relative to the rest of the model becomes unspecified. | ||
| - | All messages are printed to the application console using the given log level. | + | This functor has no string-formatting capabilities of its own. To embed a computed value in a message, assemble the string first with [[Create String]] and connect its result into Initial Message or Final Message; some types are also converted to a string automatically when connected directly. |
| - | This functor offers no [[String Type|String]] formatting capabilities, but it is possible to create formatted and complex messages using the [[Create String]] functor. [[string_type#automatic_conversions|Some types]] can also be automatically converted to [[String Type|String]]. | + | ===== Internal Name ===== |
| - | ===== Internal Name ===== | + | |