User Tools

Site Tools


01_user_documentation:05_object:08_parameter:01_parameter

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
01_user_documentation:05_object:08_parameter:01_parameter [2025/09/08 12:35] gaetan01_user_documentation:05_object:08_parameter:01_parameter [2025/09/08 12:42] (current) gaetan
Line 5: Line 5:
 Only attributes from [[:01_user_documentation:07_rgg_xl:02_xl:10_rgg_addition:02_rgg|RGG]] can be linked to parameters (for instance fields at root of .rgg files can, but fields in module cannot). Only attributes from [[:01_user_documentation:07_rgg_xl:02_xl:10_rgg_addition:02_rgg|RGG]] can be linked to parameters (for instance fields at root of .rgg files can, but fields in module cannot).
  
-====== Declare parameters ======+======  ======
  
-Parameters are declared with the annotations ''@IsParameter'', and ''@AllAsParameter''.+{{namespace>01_user_documentation:05_object:08_parameter:01_parameter}}
  
-===== Single parameter ===== 
- 
-Parameter can be declared on single fields with ''@IsParameter''. 
- 
-<code java> 
-@IsParameter 
-float f1; 
-</code> 
- 
-===== All parameter in RGG ===== 
- 
-Parameters can be declared every applicable fields of an RGG with ''@AllAsParameter''. 
- 
-<code java> 
-@AllAsParameter 
-float f1; 
- 
-Object o1; 
-</code> 
- 
-====== Explicitly use Parameter manager ====== 
- 
-By default, parameter are added to the [[:01_user_documentation:03_interacting_with_groimp:08_parameter:05_parameter_manager:01_default|default parameter manager]]. It is possible to link them to a specific parameter manager either by: 
-  * Creating a new one based on a type 
-  * Referring to an existing one by name 
- 
-===== By type ===== 
- 
-This refer or create a new "default" parameter manager of the given type. 
- 
-<code java> 
-@IsParameter(type=EmptyParameterManager.class) 
-float f1; 
- 
-</code> 
- 
-===== By name ===== 
- 
-<code java> 
-@AddParameterManager(name="envParam", type=TextFilePM.class) 
-@IsParameter("envParam") 
-float f1; 
- 
-</code> 
  
01_user_documentation/05_object/08_parameter/01_parameter.1757327724.txt.gz · Last modified: 2025/09/08 12:35 by gaetan