Difference between revisions of "Parameter Concept"
| Line 1: | Line 1: | ||
| − | + | __NOTOC__ | |
| − | |||
| − | |||
| + | Wthin the funcion modules there we use parameter to configure these modules. These parameters are called personality parameters and we can set them in config files located in Sim/config/personality_parameter. | ||
| + | == Default configuration== | ||
The default configuration and a description of these parameters is stored in | The default configuration and a description of these parameters is stored in | ||
| − | sim/config/personality _parameter/default.properties. | + | sim/config/personality _parameter/default.properties. |
| + | |||
| + | If you decide to add a new personality parameter to a module add the default value and the description of the parameter to these default file. | ||
| + | |||
| + | == Overwrite the default parameter== | ||
To change the default configuration you can overwrite the default properties by an individual personality property file for each arsin. To do so overwrite the descision unit parameter to the name of the new property file. | To change the default configuration you can overwrite the default properties by an individual personality property file for each arsin. To do so overwrite the descision unit parameter to the name of the new property file. | ||
| Line 17: | Line 21: | ||
| − | At first the default.properties file is loaden. If a specific personality parameter file is set the values from the default file are overwritten by the values from the specified file. | + | At first the default.properties file is loaden. If a specific personality parameter file is set the values from the default file are overwritten by the values from the specified file. The not overwritten values from the default file are still valid. |
| − | In the tutorial scenario a specific personality parameter file for arsin 0 is set! | + | In the tutorial scenario (Sim/config/scenarios/tutorial.properties) a specific personality parameter file for arsin 0 is set! |
==Define a Parameter within a Parameter File== | ==Define a Parameter within a Parameter File== | ||
If you define a new personality parameter you have to add two lines to the default.properties file. One for the default value and one for the description of the parameter. | If you define a new personality parameter you have to add two lines to the default.properties file. One for the default value and one for the description of the parameter. | ||
| − | <Module | + | F<Module Number>.<Parameter Name>. value = |
| − | <Module | + | F<Module Number>.<Parameter Name>. description = |
e.g.: | e.g.: | ||
| Line 38: | Line 42: | ||
== How to load a defined parameter within a module== | == How to load a defined parameter within a module== | ||
| − | call the getPersonalityParameter(String ModuleName, String ParameterNumber) methode | + | If no personality parameter is used within the module you must add the pesonalityParameterContainer to the constructor. |
| + | To load the value call the getPersonalityParameter(String ModuleName, String ParameterNumber) methode of the personalityParameterContainer. | ||
e.g.: | e.g.: | ||
| Line 47: | Line 52: | ||
==Inspector== | ==Inspector== | ||
| − | + | There is also an inspector to show all personality parameters used in the actual simulation. | |
| + | #Double click the arsin | ||
| + | #Brain Details | ||
| + | #Choose the tab personality parameter | ||
| + | All parameters grouped by the containing modules are shown. | ||
Revision as of 09:26, 25 January 2013
Wthin the funcion modules there we use parameter to configure these modules. These parameters are called personality parameters and we can set them in config files located in Sim/config/personality_parameter.
Default configuration
The default configuration and a description of these parameters is stored in
sim/config/personality _parameter/default.properties.
If you decide to add a new personality parameter to a module add the default value and the description of the parameter to these default file.
Overwrite the default parameter
To change the default configuration you can overwrite the default properties by an individual personality property file for each arsin. To do so overwrite the descision unit parameter to the name of the new property file.
Add the following line to the scenario file to change the personality parameter for entitygroup 0:
entitygroups.0.overwritedecisionunitdefaults.processor.psychicapparatus.personality.parameter.file=<file_name>
At first the default.properties file is loaden. If a specific personality parameter file is set the values from the default file are overwritten by the values from the specified file. The not overwritten values from the default file are still valid.
In the tutorial scenario (Sim/config/scenarios/tutorial.properties) a specific personality parameter file for arsin 0 is set!
Define a Parameter within a Parameter File
If you define a new personality parameter you have to add two lines to the default.properties file. One for the default value and one for the description of the parameter.
F<Module Number>.<Parameter Name>. value =
F<Module Number>.<Parameter Name>. description =
e.g.:
F07.SUPER_EGO_STRENGTH.value=0.5
F07.SUPER_EGO_STRENGTH.description= adjusts the strength of the super-ego
To overwrite the value defined in default.properties just add the fist line with the new value to a personality parameter file and define this file for your arsin.
How to load a defined parameter within a module
If no personality parameter is used within the module you must add the pesonalityParameterContainer to the constructor. To load the value call the getPersonalityParameter(String ModuleName, String ParameterNumber) methode of the personalityParameterContainer.
e.g.:
moPersonalityParameterContainer.getPersonalityParameter("F03","HOMEOSTASIS_RECTUM").getParameterDouble());
for more information see Sim/config/personality_parameter/tutorial.properties
Inspector
There is also an inspector to show all personality parameters used in the actual simulation.
- Double click the arsin
- Brain Details
- Choose the tab personality parameter
All parameters grouped by the containing modules are shown.
