Software Development Guide - Revision history

Dvernon: /* GUI Component Computation and Communication: the FLTK and guiUtilities Libraries */

2015-02-17T08:19:55Z

‎GUI Component Computation and Communication: the FLTK and guiUtilities Libraries

2015-02-17T08:19:18Z

2014-11-05T22:32:47Z

‎GUI Component Computation and Communication: the FLTK and guiUtilities Libraries

2014-11-05T22:24:49Z

‎Component Configuration and Coordination: the RFModule Class

2014-11-05T14:30:11Z

‎GUI Component Computation and Communication: the FLTK and guiUtilities Libraries

2014-11-05T14:24:08Z

‎File Organization

2014-11-05T14:20:37Z

‎Test Applications

2014-11-05T14:20:07Z

‎Test Applications

2014-11-05T14:14:41Z

‎Test Applications

2014-11-05T14:12:00Z

‎Test Applications

@@ Line 1,111: / Line 1,111: @@
 The first thing to notice is the instantiation of a number of objects from   ''FLTK''  classes <code>Fl_Group</code>, <code>Fl_Box</code>,  and <code>Fl_PNG_Image</code>. These define a group of widgets, a variety of individual widget, and an image with the CINDY logo.
-  /* protoComponentGUIComputation.cpp  Implementation file for the example DREAM component */
+  /* protoComponentGUIComputation.cpp  Implementation file for the example CINDY component */
   void ProtoComponentGUIThread::run(){

@@ Line 1,296: / Line 1,296: @@
      Fl::check();
-We can now interact with the widgets.  First we display some text in the <code>text_output</code> widget using the <code>message()</function>.  This function is one of the utilities that is provided by the ''guiUtilities'' library.
+We can now interact with the widgets.  First we display some text in the <code>text_output</code> widget using the <code>message()</code> function.  This function is one of the utilities that is provided by the ''guiUtilities'' library.
 Having done that, we are done with the GUI definition.   We now revert to the normal YARP thread loop.   Notice however, that we include two ''FLTK'' method calls inside this loop, one to redraw the window and one the tell ''FLTK'' that the window has been re-drawn and needs to be redisplayed.

@@ Line 57: / Line 57: @@
 This section also deals with the  <code>main()</code> function, i.e. with the  <code>protoComponentApplication.cpp</code> file.   It shows how to instantiate a module derived from the <code>RFModule</code> class, set the default configuration file and path for the resource finder, and run the module.  This allows the component to be configured using the resource finder.
-Once this is done, the derived module then instantiates a <code>Thread</code>  or a  <code>RateThread</code> object and launches it, passing it as arguments all the relevant resources (e.g. port names and parameter values) located by the resource finder.
+Once this is done, the derived module then instantiates a <code>Thread</code>  or a  <code>RateThread</code> object and launches it, passing to it as arguments all the relevant resources (e.g. port names and parameter values) located by the resource finder.
 Finally, it is also responsible for shutting down the thread gracefully by stopping the thread, interrupting any port communications, and closing the ports.

@@ Line 1,112: / Line 1,112: @@
   /* protoComponentGUIComputation.cpp  Implementation file for the example DREAM component */
-−
   void ProtoComponentGUIThread::run(){

@@ Line 14: / Line 14: @@
 As noted in the [[Mandatory Standards for File Organization]],  the implementation of a typical DREAM component comprises four files. These are the interface file and three implementation files:
-* The interface file is a header file, e.g. <code>protoComponent.h</code>, with the class declarations and method prototype declarations but no method implementations (C++) or the function prototype declarations (C).  It also contains the Doxygen documentation comments explaining the purpose and usage of the component (see [[Mandatory Standards for Internal Documentation]]).
+* The interface file is a header file, e.g. <code>protoComponent.h</code>, with the class declarations, method prototype declarations, and function prototype declarations, but no method or function implementations.  It also contains the Doxygen documentation comments explaining the purpose and usage of the component (see [[Mandatory Standards for Internal Documentation]]).
 *The implementation files contains the source code for the implementation of each class method (C++) or the source code of each function (C).   For convenience, the implementation is separated in three files:
 # The first source code file — e.g. <code>protoComponentMain.cpp</code> — contains the <code> main()</code>  function that instantiates the module object and calls the <code>runModule</code> method to effect the configuration, coordination, computation, and communication for that component.

← Older revision		Revision as of 14:20, 5 November 2014
Line 78:		Line 78:

	The second test application shows how to configure and run a simple application to use <code> protoComponent</code> and <code> protoComponentGUI</code> together. In this case, the images are displayed in the GUI rather than <code>yarpview</code> displays and the threshold is modified interactively using the GUI controls.		The second test application shows how to configure and run a simple application to use <code> protoComponent</code> and <code> protoComponentGUI</code> together. In this case, the images are displayed in the GUI rather than <code>yarpview</code> displays and the threshold is modified interactively using the GUI controls.
−
−
−	~~[[Software_Development_Guide\|Back to the Top]]~~

	== Component Configuration and Coordination: The <code>RFModule</code> Class ==		== Component Configuration and Coordination: The <code>RFModule</code> Class ==

← Older revision		Revision as of 14:20, 5 November 2014
Line 80:		Line 80:


−	[[~~Software Development Guide~~\|Back to the Top]]	+	[[Software_Development_Guide\|Back to the Top]]

	== Component Configuration and Coordination: The <code>RFModule</code> Class ==		== Component Configuration and Coordination: The <code>RFModule</code> Class ==

← Older revision		Revision as of 14:14, 5 November 2014
Line 80:		Line 80:


−	~~#REDIRECT~~ [[Software Development Guide\|Back to the Top]]	+	[[Software Development Guide\|Back to the Top]]

	== Component Configuration and Coordination: The <code>RFModule</code> Class ==		== Component Configuration and Coordination: The <code>RFModule</code> Class ==

@@ Line 80: / Line 80: @@
-#REDIRECT[[Software Development Guide|Back to the Top]]
+#REDIRECT [[Software Development Guide|Back to the Top]]
-−
 ==  Component Configuration and Coordination: The <code>RFModule</code> Class ==