Skip to main content

Extract Macro from Annotation

Synopsis​

Extracts one or more annotations from an object and assigns its value to a macro.

Description​

For a general introduction to annotations please have a look at the help of the Annotate operator.

Input​

object​

Any type of object can be connected to this port. The annotations will be extracted from this object.

Output​

object​

The same object as passed to the input port, unchanged.

Parameters​

extract all​

If checked, all annotations are extracted to macros named the same as the annotations. Optionally, you can define a name prefix which is prepended to the macro names

macro​

Defines the name of the created macro.

annotation​

The name of the annotation to be extracted.

name prefix​

A prefix which is prepended to all macro names.

fail on missing​

If checked, the operator breaks if the specified annotation can't be found; if it is unchecked an empty macro will be created.

See Also​

operator.annotate​

operator.extract_macro​