Standards for File Organization - Revision history

Dvernon: /* Directory Structure */

2015-02-17T08:37:36Z

‎Directory Structure

Dvernon at 08:21, 17 February 2015

2015-02-17T08:21:28Z

Dvernon at 12:49, 15 February 2015

2015-02-15T12:49:54Z

Dvernon at 12:48, 15 February 2015

2015-02-15T12:48:43Z

Dvernon at 12:47, 15 February 2015

2015-02-15T12:47:34Z

Dvernon: /* Directory Structure */

2015-02-15T12:47:01Z

‎Directory Structure

Dvernon: /* Directory Structure */

2015-02-15T12:44:47Z

‎Directory Structure

Dvernon: /* Directory Structure */

2015-02-15T12:41:54Z

‎Directory Structure

Dvernon: /* Directory Structure */

2015-02-15T12:41:16Z

‎Directory Structure

Dvernon: Dvernon moved page Mandatory Standards for File Organization to Standards for File Organization

2015-02-15T12:21:16Z

Dvernon moved page Mandatory Standards for File Organization to Standards for File Organization

@@ Line 2: / Line 2: @@
 The directory containing the CINDY cognitive architecture implementation comprises six subdirectories:
-* app
+* <code>app</code>
-* build
+* <code>build</code>
-* bin
+* <code>bin</code>
-* components
+* <code>components</code>
-* config
+* <code>config</code>
-* lib
+* <code>lib</code>
 The app directory contains contains the <code>*.xml</code> XML application files for the entire cognitive architecture, i.e. applications that deploy many components.
@@ Line 26: / Line 26: @@
 The bin lib subdirectory contains the various CINDY libraries.
 == Filename Roots and Extensions ==

← Older revision		Revision as of 08:21, 17 February 2015
Line 69:		Line 69:

	The configuration file contains the key-value pairs that set the component parameters. For readability, each key-value pair should be written on a separate line.		The configuration file contains the key-value pairs that set the component parameters. For readability, each key-value pair should be written on a separate line.
		+
		+
		+	----
		+	Return to [[The CINDY Cognitive Architecture]] main page.

@@ Line 28: / Line 28: @@
-=== Filename Roots and Extensions ===
+== Filename Roots and Extensions ==
 All files should have the same root, reflecting computational purpose of the component, e.g. <code>protoComponent</code>.
 Source code files for C and C++ should use a <code>.c</code> and <code>.cpp</code> extension, respectively. Header files should have a <code>.h</code> extension in both cases.
 == File Organization ==

@@ Line 38: / Line 38: @@
 Normally, there are three different types of source code file in any given project. These are the interface, implementation, and application files.
-In a Component-Based Software Engineering (CBSE) project, such as DREAM, the source code application file is replaced by the application script file or application XML file that runs the various components and connects them together in a working system.
+In a Component-Based Software Engineering (CBSE) project,  the source code application file is replaced by the application script file or application XML file that runs the various components and connects them together in a working system.
 The interface file is a header file with the class declarations and method prototype declarations but no method implementations (C++) or the function prototype declarations (C).
@@ Line 44: / Line 44: @@
 The implementation file contains the source code for the implementation of each class method (C++) or the source code of each function (C). General purpose functions might eventually be placed in a library.
-In DREAM, for YARP modules we further separate the implementation into three files.
+In CINDY, for YARP modules we further separate the implementation into 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.

@@ Line 20: / Line 20: @@
 # The src directory contains the <code>*.c</code>, <code>*.cpp</code>, and <code>*.h</code> files.
 # The app directory contains the <code>*.xml</code> XML application files that are used to test this particular component.
 # The config directory contains the configuration file, named after the component and with a <code>.ini</code> extension. For example, <code>protoComponent.ini</code>. Other resources, e.g. image files are also be placed in the <code>config</code> directory.

@@ Line 19: / Line 19: @@
 In turn, each component sub-directory has three sub-sub-directories: <code>src</code>, <code>app</code>, and <code>config</code>.
-** The src directory contains the <code>*.c</code>, <code>*.cpp</code>, and <code>*.h</code> files.
+# The src directory contains the <code>*.c</code>, <code>*.cpp</code>, and <code>*.h</code> files.
-** The app directory contains the <code>*.xml</code> XML application files that are used to test this particular component.
+# The app directory contains the <code>*.xml</code> XML application files that are used to test this particular component.
-** The config directory contains the configuration file, named after the component and with a <code>.ini</code> extension. For example, <code>protoComponent.ini</code>. Other resources, e.g. image files are also be placed in the <code>config</code> directory.
+# The config directory contains the configuration file, named after the component and with a <code>.ini</code> extension. For example, <code>protoComponent.ini</code>. Other resources, e.g. image files are also be placed in the <code>config</code> directory.
 On the other hand, there is also a config subdirectory of the main CINDY directory.  Like the app directory at this level, it contains the configuration files for these global system applications.

@@ Line 13: / Line 13: @@
 The build directory contains the files that are use to compile the component executables. In particular, it contains the CINDY.sln solution file that is used to compile the project.
-The executables are placed in the bin director by the CINDY.sln file after compilation and linking.
+The executables are placed in the bin directory by the CINDY.sln file after compilation and linking.
 The components file contains the source code for all the individual components.  Each component has a sub-directory of its own. This is named after the component, e.g. <code>protoComponent</code>. Note that we keep the leading letter in lowercase since this directory refers to a component, not a class (in which case, in most conventions, the leading letter would be in uppercase).

← Older revision	Revision as of 12:21, 15 February 2015
(No difference)