Software Integration Guide - Revision history

Dvernon: /* Component Functionality */

2014-09-03T13:47:15Z

‎Component Functionality

Dvernon: /* Component Functionality */

2014-09-03T13:46:33Z

‎Component Functionality

Dvernon: /* Files and Directories */

2014-09-03T13:44:18Z

‎Files and Directories

Dvernon: /* Component Unit Testing */

2014-09-03T13:42:37Z

‎Component Unit Testing

Dvernon: /* Component Unit Testing */

2014-09-02T23:17:54Z

‎Component Unit Testing

Dvernon: /* Component Functionality */

2014-09-02T23:17:10Z

‎Component Functionality

Dvernon at 18:45, 2 September 2014

2014-09-02T18:45:58Z

Dvernon at 18:42, 2 September 2014

2014-09-02T18:42:45Z

Show changes

Dvernon at 18:29, 2 September 2014

2014-09-02T18:29:49Z

Dvernon at 18:27, 2 September 2014

2014-09-02T18:27:15Z

← Older revision		Revision as of 13:47, 3 September 2014
Line 155:		Line 155:

	'''''' <code><componentName>.h</code> contains a declaration of a class derived from<code> yarp::os::RFModule</code>:		'''''' <code><componentName>.h</code> contains a declaration of a class derived from<code> yarp::os::RFModule</code>:
		+
	class <ComponentName> : public RFModule {} // first char in uppercase		class <ComponentName> : public RFModule {} // first char in uppercase

← Older revision		Revision as of 13:46, 3 September 2014
Line 155:		Line 155:

	'''''' <code><componentName>.h</code> contains a declaration of a class derived from<code> yarp::os::RFModule</code>:		'''''' <code><componentName>.h</code> contains a declaration of a class derived from<code> yarp::os::RFModule</code>:
−
	class <ComponentName> : public RFModule {} // first char in uppercase		class <ComponentName> : public RFModule {} // first char in uppercase

← Older revision		Revision as of 13:44, 3 September 2014
Line 76:		Line 76:

	'''''' Each key-value pair is written on a separate line.		'''''' Each key-value pair is written on a separate line.
−

	===Internal Source Code Documentation===		===Internal Source Code Documentation===

@@ Line 230: / Line 230: @@
 ''''''  Unit test instructions are provided in a file named <code>README.txt</code> in the <code>app</code> directory.
-''''''  The instructions explain how the communication and computation functionality are validated by describing the (sink) output data that will be produced from the (source) input data.
+: ''''''  The instructions explain how the communication and computation functionality are validated by describing the (sink) output data that will be produced from the (source) input data.
-''''''  The instructions explain how the configuration functionality is validated by describing what changes in behaviour will occur if the values for the component parameters in the component configuration (<code>.ini</code>) file are altered.
+: ''''''  The instructions explain how the configuration functionality is validated by describing what changes in behaviour will occur if the values for the component parameters in the component configuration (<code>.ini</code>) file are altered.
-''''''  The instructions explain how the coordination functionality is validated by describing what changes in behaviour will occur when commands are issued interactively by the user to the component using the port named after the component itself.
+: ''''''  The instructions explain how the coordination functionality is validated by describing what changes in behaviour will occur when commands are issued interactively by the user to the component using the port named after the component itself.
 ===System Testing===

← Older revision		Revision as of 23:17, 2 September 2014
Line 235:		Line 235:

	'''''' The instructions explain how the coordination functionality is validated by describing what changes in behaviour will occur when commands are issued interactively by the user to the component using the port named after the component itself.		'''''' The instructions explain how the coordination functionality is validated by describing what changes in behaviour will occur when commands are issued interactively by the user to the component using the port named after the component itself.
−

	===System Testing===		===System Testing===

@@ Line 209: / Line 209: @@
                          Value("<componentName>"),
                          "module name (string)").asString();
   setName(moduleName.c_str());
@@ Line 214: / Line 215: @@
 '''''' The component effects all communication with other component using YARP ports.
-−
 ===Component Unit Testing===

@@ Line 200: / Line 200: @@
 '''''' The component allows the port names to be set and overridden using the port name key-value parameters in the <code><componentName>.ini</code> configuration file.
-'''''' All port names have a leading /.
+'''''' All port names have a leading <code>/</code>.
 '''''' Input and output port names have a trailing :i or :o, respectively.
-'''''' The component allows the default name of the component to be set and overridden with the --name parameter:
+'''''' The component allows the default name of the component to be set and overridden with the <code>--name</code> parameter:
   moduleName            = rf.check("name",
@@ Line 211: / Line 211: @@
   setName(moduleName.c_str());
-'''''' The component allows commands to be issued on a special port with the same name as the component by overloading the respond() method in the resource finder RFModule class in <componentName>Configuration.cpp.
+'''''' The component allows commands to be issued on a special port with the same name as the component by overloading the <code>respond()</code> method in the resource finder <code>RFModule</code> class in <code><componentName>Configuration.cpp</code>.
 '''''' The component effects all communication with other component using YARP ports.
@@ Line 217: / Line 217: @@
 ===Component Unit Testing===
-''''''  A unit test application named <componentName>TEST.xml is provided in the app directory.
+''''''  A unit test application named <code><componentName>TEST.xml</code> is provided in the <code>app</code> directory.
-''''''  The test application launches the component being tested on a YARP run servers called dream1 using the<node> </node>construct.
+''''''  The test application launches the component being tested on a YARP run servers called dream1 using the <code><node> </node></code> construct.
 '''''' The test application connects the component through its ports to a data source and a data sink (linked either to files or driver/stub components).
-''''''  If required, the data source and sink file resources are provided in the config directory.
+''''''  If required, the data source and sink file resources are provided in the <code>config</code> directory.
-''''''  If required, the driver and stub components are located in src directory.
+''''''  If required, the driver and stub components are located in <code>src</code> directory.
-''''''  Unit test instructions are provided in a file named README.txt in the app directory.
+''''''  Unit test instructions are provided in a file named <code>README.txt</code> in the <code>app</code> directory.
 ''''''  The instructions explain how the communication and computation functionality are validated by describing the (sink) output data that will be produced from the (source) input data.
-''''''  The instructions explain how the configuration functionality is validated by describing what changes in behaviour will occur if the values for the component parameters in the component configuration (.ini) file are altered.
+''''''  The instructions explain how the configuration functionality is validated by describing what changes in behaviour will occur if the values for the component parameters in the component configuration (<code>.ini</code>) file are altered.
 ''''''  The instructions explain how the coordination functionality is validated by describing what changes in behaviour will occur when commands are issued interactively by the user to the component using the port named after the component itself.

@@ Line 56: / Line 56: @@
 Refer to Deliverable D3.2, Appendix A (Mandatory Standards for File Organization), for a definition of the standards on which this checklist is based.
-'''''' Files for a single component are stored in a directory named after the component with the leading letter in lowercase: <componentName>.
+'''''' Files for a single component are stored in a directory named after the component with the leading letter in lowercase: <code><componentName></code>.
-'''''' This directory has three sub-directories: src, app, and config.
+'''''' This directory has three sub-directories: <code>src</code>, <code>app</code>, and <code>config</code>.
 '''''' The src directory contains one header file and three source files, named as follows.

@@ Line 83: / Line 83: @@
 '''''' * \section lib_sec Libraries
 '''''' * \section parameters_sec Parameters
 '''''' * <nowiki><b></nowiki>Command-line Parameters <nowiki></b></nowiki>
 '''''' * <nowiki><b><nowiki>Configuration File Parameters <nowiki></b></nowiki>
 '''''' * \section portsa_sec Ports Accessed
 '''''' * \section portsc_sec Ports Created
 '''''' * <nowiki><b></nowiki>Input ports<nowiki></b></nowiki>
 '''''' * <nowiki><b></nowiki>Output ports<nowiki></b></nowiki>
 '''''' * <nowiki><b></nowiki>Port types <nowiki></b></nowiki>
 '''''' * \section in_files_sec Input Data Files
 '''''' * \section out_data_sec Output Data Files
 '''''' * \section conf_file_sec Configuration Files
 '''''' * \section example_sec Example Instantiation of the Component
 '''''' * \author