Macro Functions

This chapter lists all macro functions available for use in GENER macros. It should be noted that functions can be used to retrieve a value only. Functions cannot be used on the left-hand side of an assignment statement.

The first section summarizes the various functions by category.

Syntax Format Conventions

The syntax for macro functions is listed using the following format conventions:

Square brackets $\big[ \; \big]$ encase syntax that is optional. The 0:n symbol preceding the bracketed item, as in $\icamrange{0.8}{0}\,\big[,a\,\big]$ indicates that the bracketed item a can be repeated zero or more times.
Parentheses $\big( \; \big)$ encase syntax that lists a number of choices, one of which is required. The parentheses are omitted when the syntax is a simple choice among a number of keywords. The 1:n symbol preceding the parenthesized item, as in $\icamrange{0.8}{1}\,\big(,a\,\big)$ indicates that the item a can be repeated one or more times.
Any value not contained in square brackets or parentheses must be programmed each time the macro function is used.
Formal keywords are shown in bold upper case, as in ON and AUTO.
Lower case words within angled brackets identify common syntax, as in <axis>. The syntax of axis is then defined separately. This makes complex syntax more readable.
Italicized lower case words identify variable parameters supplied in the syntax, such as offset or 'name'.