Skip to main content
Jump to: navigation, search

Difference between revisions of "Henshin/Parameters"

(Usage during definition: Insert text from meta model page)
m (Usage during execution: Add word 'externally')
Line 127: Line 127:
 
== Usage during execution ==
 
== Usage during execution ==
  
Before unit or rule execution parameters of kind ''in'' and ''inout'' have to be set.
+
Before unit or rule execution parameters of kind ''in'' and ''inout'' have to be set externally.
Parameters of kind ''unknown'' may be set depending on their usage in their units/rules.
+
Parameters of kind ''unknown'' may be set externally depending on their usage in their units/rules.
 
This can be done using the [[Henshin/Interpreter#Interpreter_Wizard|Interpreter Wizard]] or the [[Henshin/Interpreter#Interpreter_API|Interpreter API]].
 
This can be done using the [[Henshin/Interpreter#Interpreter_Wizard|Interpreter Wizard]] or the [[Henshin/Interpreter#Interpreter_API|Interpreter API]].
  

Revision as of 07:39, 23 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.

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)

Feature comparison
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.

Declared parameters are used inside the unit by referencing them by name. Parameters can be used at any place in the unit where a string value is expected: in rules, this is the case for node names, attribute values, edge indices, and attribute conditions. In iterated units, this is the case for the iterations condition.

Parameter creation and editing in graphical editor

Henshin Parameters GraphicalEditor.png

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

Henshin Parameters Creation TreeEditor.png

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

Henshin Parameters Editing PropertiesView.png

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

Henshin ParameterMapping Creation TreeEditor.png

Parameters that need to be set externally can be set by the user using the API or the Interpreter Wizard as described in the sections above. In addition, they can be passed in from another unit using a parameter mapping. A parameter mapping assigns a source parameter to a target parameter between a unit and its sub-unit(s). A mapping 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.

Henshin ParameterMapping Editing PropertiesView.png

Allowed mappings
From → / to ↓ IN OUT INOUT VAR
IN x x x
OUT x x x
INOUT x x x x
VAR x x x

Usage during execution

Before unit or rule execution parameters of kind in and inout have to be set externally. Parameters of kind unknown may be set externally depending on their usage in their units/rules. This can be done using the Interpreter Wizard or the Interpreter API.

Interpreter Wizard

Interpreter wizard with parameters

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.

Back to the top