Skip to content

Commit

Permalink
Remove type character when referencing variables (modelica#559)
Browse files Browse the repository at this point in the history
in log messages

(see modelica#442)
  • Loading branch information
t-sommer authored Mar 13, 2019
1 parent 71ab3a5 commit cfc978b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/2_1_common_api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -326,14 +326,14 @@ All string-valued arguments passed by the FMU to the `logger` may be deallocated
The environment must therefore create copies of these strings if it needs to access these strings later. +
The `logger` function will append a line break to each message when writing messages after each other to a terminal or a file (the messages may also be shown in other ways, for example, as separate text-boxes in a GUI).
The caller may include line-breaks (using "\n") within the message, but should avoid trailing line breaks. +
Variables are referenced in a message with `\#<Type><ValueReference>#` where <Type> is "r" for `fmi3Real`, "i" for `fmi3Integer`, "b" for `fmi3Boolean` and "s" for `fmi3String`.
If character `pass:[#]` shall be included in the message, it has to be prefixed with `pass:[#]`, so `#` is an escape character.
Variables can be referenced in a message with `pass:[#]<ValueReference>pass:[#]`.
If the character `pass:[#]` shall be included in the message, it has to be prefixed with `pass:[#]`, so `pass:[#]` is an escape character.
+
_[Example:_ +
_A message of the form "\#r1365#" must be larger than zero (used in IO channel ##4)"_ +
_might be changed by the `logger` function to_ +
_`"body.m must be larger than zero (used in IO channel #4)"`_ +
_if `"body.m"` is the name of the `fmi3Real` variable with `fmi3ValueReference = 1365`.]_
_The message_ `\#1365# must be larger than zero (used in IO channel ##4)` +
_might be changed by the_ `logger` _function to_ +
`body.m must be larger than zero (used in IO channel #4)` +
_if `body.m` is the name of the variable with value reference 1365.]_

Function `allocateMemory`::
Pointer to a function that is called in the FMU if memory needs to be allocated.
Expand Down

0 comments on commit cfc978b

Please sign in to comment.