Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Henshin/Parameters"
(→Interpreter API: Add link to Interpreter wiki page section) |
m (→Parameter creation and editing in graphical editor: Explain that kind and type are optional.) |
||
Line 51: | Line 51: | ||
To create or edit a parameter with the [[Henshin/Graphical Editor|graphical editor]] open the according ''*.henshin_diagram'' file. | To create or edit a parameter with the [[Henshin/Graphical Editor|graphical editor]] open the according ''*.henshin_diagram'' file. | ||
Select the name of a unit or rule by clicking on it. | Select the name of a unit or rule by clicking on it. | ||
− | Click a second time to edit the | + | Click a second time to edit the name. |
− | You can now text-based add, edit and remove parameters which follow the unit/rule name | + | You can now - text-based - add, edit and remove parameters which follow the unit/rule name encompassed by parentheses and separated by commas. |
The parameter entries adhere to the following scheme: ''<kind> <name>:<type>'' . | The parameter entries adhere to the following scheme: ''<kind> <name>:<type>'' . | ||
+ | Both ''kind'' and ''type'' are optional. | ||
+ | If you omit a ''kind'' the parameter kind will be ''unknown''. | ||
=== Parameter creation in tree-based editor === | === Parameter creation in tree-based editor === |
Revision as of 05:01, 6 April 2018
Parameters allow to shape the behavior of units, including rules, with variable information. A unit can have an arbitary number of parameters. Parameters have a name, a description, a kind, and, optionally, a type.
Contents
Parameter kinds
The kind specifies the time when the parameter is bound to a concrete value, and whether the parameter is intended to be accessed after the unit has been applied. There are four parameter kinds (in, out, inout, var) and an additional legacy parameter kind (unknown)
Parameter kind | IN | OUT | INOUT | VAR | UNKOWN |
---|---|---|---|---|---|
settable before application | x | x | x | ||
settable during application | x | x | x | ||
readable after application | x | x | x |
Usage during definition
Parameters can be created using the tree-based or the graphical editor. They can be edited using the latter or the Properties view.
Parameter creation and editing in graphical editor
To create or edit a parameter with the graphical editor open the according *.henshin_diagram file. Select the name of a unit or rule by clicking on it. Click a second time to edit the name. You can now - text-based - add, edit and remove parameters which follow the unit/rule name encompassed by parentheses and separated by commas. The parameter entries adhere to the following scheme: <kind> <name>:<type> . Both kind and type are optional. If you omit a kind the parameter kind will be unknown.
Parameter creation in tree-based editor
To create a parameter with the tree-based editor open the according *.henshin-file. Right-click on the desired rule or unit and navigate to New Child → Parameter. You can continue with editing the parameter in its Properties view.
Parameter editing in properties view
In the Properties view you can edit a parameter after selecting it in the tree-based editor. To edit a value click in the according row of the Value column.
Parameter mapping
You can define parameter mappings to pass parameters between a unit and its sub-unit(s). A mappings is implicitly defined when using the same name for two parameters. Mappings for parameters with different names can be created manually using the tree-based editor. Therefore right-click the unit and select New Child → Parameter Mapping. The mapping can be edited using its Properties view.
Usage during execution
Before unit or rule execution parameters of kind in and inout have to be set. Parameters of kind unknown may be set depending on their usage in their units/rules. This can be done using the Interpreter Wizard or the Interpreter API.
Interpreter Wizard
To set parameters using the interpreter wizard you have to open the wizard for your unit or rule of interest. In the lower part of the popup window is a table with the available parameters. You can set them by editing the cells in the Values column.
Interpreter API
See Setting and Getting Parameter Values in Henshin/Interpreter#Transforming_and_more.