Documentation/Modules/IModule - Versionsgeschichte

Admin am 19. März 2014 um 22:06 Uhr

2014-03-19T22:06:25Z

Admin am 12. September 2013 um 20:22 Uhr

2013-09-12T20:22:18Z

Dirk: /* Open Items */

2013-03-18T20:38:20Z

‎Open Items

Dirk: /* Method String init(long index) */

2013-03-18T20:37:53Z

‎Method String init(long index)

Dirk: /* Summary */

2013-03-18T20:36:40Z

‎Summary

Dirk: /* Summary */

2013-03-18T20:36:28Z

‎Summary

Dirk: /* Method void setID(int id) */

2013-03-18T20:35:34Z

‎Method void setID(int id)

Dirk: /* Method void setID(int id) */

2013-03-18T20:35:09Z

‎Method void setID(int id)

Dirk: /* Method int getID() */

2013-03-18T20:34:40Z

‎Method int getID()

Dirk: /* Method String init(long index) */

2013-03-18T20:33:23Z

‎Method String init(long index)

@@ Zeile 1: / Zeile 1: @@
 =Interface <tt>IModule</tt>=
-All <tt>Modules</tt> in OpenDINO must implement the Interface <tt> IModule</tt>.
+All <tt>Modules</tt> in OpenDino must implement the Interface <tt> IModule</tt>.
 The interface contains a set of methods. The purpose and the functionality of these methods is described in the following sections.

@@ Zeile 1: / Zeile 1: @@
 =Interface <tt>IModule</tt>=
-All <tt>Modules</tt> in OpenOpal must implement the Interface <tt> IModule</tt>.
+All <tt>Modules</tt> in OpenDINO must implement the Interface <tt> IModule</tt>.
 The interface contains a set of methods. The purpose and the functionality of these methods is described in the following sections.

← Nächstältere Version		Version vom 18. März 2013, 20:38 Uhr
Zeile 154:		Zeile 154:
	# Objectives		# Objectives
	#* get information about<tt>Modules</tt> properties for checking or debugging user settings		#* get information about<tt>Modules</tt> properties for checking or debugging user settings
−
−	~~= Open Items =~~
−	* 'path handling for files','The path handling of openopal:
−	files that are eg. written by the protocoller are placed in the source directory of the code. Instead the should be a working directory (e.g. the one where one calls openopal from). In addition, the file browsing dialog should remember the working directory (of the previous call).'
−
−	* 'Thead save','Methods like evaluate() or init() are currently not thread save.
−	~~Multiple (optimization) algorithms may call these methods.~~
−
−	~~One solution to this is to synchronize critical methods. ','Methods like evaluate() or init() are currently not thread save.~~
−	~~Multiple (optimization) algorithms may call these methods.~~

@@ Zeile 129: / Zeile 129: @@
+}
 </pre>
 == Method <tt>int getID()</tt> ==

@@ Zeile 149: / Zeile 149: @@
 # Objectives
 #* get information about<tt>Modules</tt> properties for checking or debugging user settings
 = Open Items =

@@ Zeile 151: / Zeile 151: @@
 == Summary ==
-# properties of a<tt>Modules</tt> should only change when the Method <tt>init()</tt> is called.
+# properties of a <tt>Module</tt> should only change when the Method <tt>init()</tt> is called.
-#* this guarantees that <i>Modules</i> do not change while they are checked!
+#* this guarantees that <tt>Modules</tt> do not change while they are checked or other <tt>Modules</tt> are running!
 = Open Items =

@@ Zeile 141: / Zeile 141: @@
 # Objectives
 #* IDs should be set at the time of instantiation and should not be modified.
-#* the ID is important for debugging, e.g. <i>Modules</i> can identify to which other <i>Modules</i> they are connected
+#* the ID is important for debugging, e.g. <tt>Modules</tt> can identify to which other <tt>Modules</tt> they are connected.
 == Method <tt>String getInfo()</tt> ==

@@ Zeile 138: / Zeile 138: @@
 == Method <tt>void setID(int id)</tt> ==
 # Functionality
-#* sets the ID for this<tt>Modules</tt>.
+#* sets the ID for this <tt>Module</tt>.
 # Objectives
 #* IDs should be set at the time of instantiation and should not be modified.

@@ Zeile 81: / Zeile 81: @@
 # Functionality
-#* initialize <i>Modules</i> such that executing optimizations or learning processes is possible
+#* initialize <tt>Modules</tt> such that executing optimizations or learning processes is possible.
 #* Initialization requires several steps:
-#*# check if the argument (SystemTime) has changed compared to the time of the last check (see also example below). If the argument has not changed, the system has not changed and a new initialization is not necessary. Thus, return the message of the previous check and do no further checking.
+#*# check if the argument (index) has changed compared to the time of the last check (see also example below). If the argument has not changed, the system has not changed and a new initialization is not necessary. Thus, return the message of the previous check and do no further checking.
-#*# If the<tt>Modules</tt> is connected to other Modules, it should first
+#*# If the <tt>Modules</tt> is connected to other Modules, it should first
-#*#* call the <tt>init()</tt> of the connected <i>Modules</i> and
+#*#* call the <tt>init()</tt> of the connected <tt>Modules</tt> and
-#*#* return a message, if any connected<tt>Modules</tt> fails to initialize
+#*#* return a message, if any connected <tt>Modules</tt> fails to initialize
-#*# If the initialization of the connected <i>Modules</i> is successful, it should then get the properties of the connected <i>Modules</i>
+#*# If the initialization of the connected <tt>Modules</tt> is successful, it should then get the properties of the connected <tt>Modules</tt>
-#*#* return a message, if any connected<tt>Modules</tt> fails to return properties
+#*#* return a message, if any connected <tt>Modules</tt> fails to return properties.
-#*# Initialize itself and return a string if initialization fails
+#*# Initialize itself and return a string if initialization fails.
 # Objectives
-#* initialization should never lead to exceptions
+#* initialization should never lead to exceptions.
 #* It must not call <tt>check()</tt>!
 # Properties
-#* the <tt>init()</tt>  method is the only method of <tt>IModule</tt> that may require CPU time (e.g. for loading a large data source). Thus the SystemTime as argument to this method should help avoiding unnecessary initializations.
+#* the <tt>init()</tt>  method is the only method of <tt>IModule</tt> that may require CPU time (e.g. for loading a large data source). Thus this method should not be called too often.
 # Advanced Features
 #* the<tt>Modules</tt> should check if initialization is necessary. Typically initialization is necessary when