Changes between Version 6 and Version 7 of code/doc/ConfigValueContainer

Timestamp:

Oct 8, 2008, 12:15:17 AM (16 years ago)

Author:

landauf

Comment:

—

code/doc/ConfigValueContainer

@@ -6 +6 @@
 The !ConfigValueContainer is a class that manages [wiki:howto/ConfigValue config-values]. A config-value is a member-variable of a class that can be changed through the [wiki:howto/ConfigFile config-file]. The config-file is usually {{{orxonox.ini}}}.
 
+A !ConfigValueContainer is basically just what it's name says: a container. You can think about it as a buffer between the config-file (which is hard to parse) and a config-value (which will be assigned to lots of class instances).
+
 Every config-value has it's own !ConfigValueContainer. The container is stored in a map inside the [wiki:Identifier] of the corresponding class. This way it's possible to iterate through all ConfigValueContainers of a class.
 
 A !ConfigValueContainer for a specific config-value is either created as soon as a class declares the config-value or when a new config-file with a new value gets loaded.
+
+
+== Usage ==
+The usage of the !ConfigValueContainer is usually hidden from the programmer because several macros (see [wiki:ConfigValueIncludes]) or other classes (see [wiki:ConfigFileManager]) do all the work.
+
 
 == Creating a new config-value ==