Added documentation, renamed header paths, corrected CMakeLists accordingly.

(dynamicGraph/ -> dynamic-graph/)

Added documentation, renamed header paths, corrected CMakeLists accordingly.
(dynamicGraph/ -> dynamic-graph/)
66516bf8 · Francois Bleibel · 75e76fab · 66516bf8 · 66516bf8 · 66516bf8
Commit 66516bf8 authored Jun 09, 2010 by Francois Bleibel
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -21,12 +21,12 @@ ADD_CUSTOM_TARGET(documentation ALL

 # html files
 INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
-  DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/${PROJECT_NAME})
+  DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/dynamic-graph)

 # doxytag
 INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.doxytag
-  DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/${PROJECT_NAME}/html)
+  DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/dynamic-graph/html)

 # pictures
 INSTALL(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/pictures
-  DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/${PROJECT_NAME}/html)
+  DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/dynamic-graph/html)
--- a/doc/additionalDoc/package.h
+++ b/doc/additionalDoc/package.h
@@ -3,19 +3,14 @@

 \section intro_dynamicGraph Introduction

-This package implements ...
+This code implements the factory design pattern, making creation of entities
+available to packages depending on the dynamicGraph API.

-@defgroup factory Plugin management modules.
-@ingroup factory
-
-This code implements the factory design pattern, making creation of features,
-tasks and objects available.
-
-Objects, which are derived from Entities, Tasks, or Features, can be
- declared within the code and compiled to shared librairies (.so/.dll files).
-These librairies can be loaded at run-time using the sotPluginLoader methods,
+Objects, which are derived from Entities, can be
+ declared within the code and compiled to shared libraries (.so/.dll files).
+These libraries can be loaded at run-time using the PluginLoader methods,
 and at the same time register their class names to the Factory (see the
-sotFactory documentation to learn how).
+examples in the SOT documentation to learn how).

 The Factory can then create instances of these objects and subsequently
 register them in the Pool, where they can be listed, accessed, and acted upon
@@ -23,10 +18,14 @@ register them in the Pool, where they can be listed, accessed, and acted upon
 signal connection graph file generation, help and name print, and signals.

 Finally, a shell (command-line) interface is made available thanks to the
-sotInterpretor class (see the file test_shell.cpp). Objects deriving from
+Interpreter class (see the file test_shell.cpp for an example). Objects deriving from
 Entity can expose their own commands by overriding the Entity's default
 commandLine() method. It is possible to load a plugin to register custom
-shell commands; see sotShellFunctions and sotShellProcedure for an example.
+shell commands; see shell-functions and shell-procedure for an example.
+
+Some basic shell functions, and support for procedures, are also included.
+For a complete list of those, load the plugin shell-functions.so and type 'help'
+at the command line.

 The public static objects (singletons) made available by including the
 corresponding headers in this module are:
@@ -34,12 +33,32 @@ corresponding headers in this module are:
 \li pool: PoolStorage
 \li Shell: Interpreter

-\image html schema_plugin.png
+\image html pictures/use-case.svg
+
+.
+\defgroup dgraph Core classes and objects
+\defgroup signals Signals

+\ingroup dgraph
+@{

-@defgroup signals Signals
-@ingroup softwaresupport
+Classes that make up the core of the dynamicGraph library are listed here.
+@}
+\ingroup signals
+@{
 This part provides the mechanism to transfer information
-from one feature to another.
+from one feature to another. There are three main types of signals,
+all deriving from the common class dynamicgraph::SignalBase :
+\li dynamicgraph::Signal
+\li dynamicgraph::SignalPtr
+\li dynamicgraph::SignalTimeDependant
+
+Signals can be grouped together using dynamicgraph::SignalArray.
+
+Signals implement a caching mechanism by storing the last computation time tick.
+Signals can be plug into one another or set through shell commands.
+@}
+
+\namespace dynamicgraph This is the namespace where every object and class of this library is located.

 */
--- a/doc/cmake_install.cmake
+++ b/doc/cmake_install.cmake
@@ -33,14 +33,14 @@ IF(NOT DEFINED CMAKE_INSTALL_SO_NO_EXE)
 ENDIF(NOT DEFINED CMAKE_INSTALL_SO_NO_EXE)

 IF(NOT CMAKE_INSTALL_COMPONENT OR "${CMAKE_INSTALL_COMPONENT}" STREQUAL "Unspecified")
-  FILE(INSTALL DESTINATION "/home/blue/sot-lib/share/doc/dynamicGraph" TYPE DIRECTORY FILES "/home/blue/sot-devel/dynamicGraph/doc/html")
+  FILE(INSTALL DESTINATION "/home/blue/sot-lib/share/doc/dynamic-graph" TYPE DIRECTORY FILES "/home/blue/sot-devel/dynamicGraph/doc/html")
 ENDIF(NOT CMAKE_INSTALL_COMPONENT OR "${CMAKE_INSTALL_COMPONENT}" STREQUAL "Unspecified")

 IF(NOT CMAKE_INSTALL_COMPONENT OR "${CMAKE_INSTALL_COMPONENT}" STREQUAL "Unspecified")
-  FILE(INSTALL DESTINATION "/home/blue/sot-lib/share/doc/dynamicGraph/html" TYPE FILE FILES "/home/blue/sot-devel/dynamicGraph/doc/dynamicGraph.doxytag")
+  FILE(INSTALL DESTINATION "/home/blue/sot-lib/share/doc/dynamic-graph/html" TYPE FILE FILES "/home/blue/sot-devel/dynamicGraph/doc/dynamicGraph.doxytag")
 ENDIF(NOT CMAKE_INSTALL_COMPONENT OR "${CMAKE_INSTALL_COMPONENT}" STREQUAL "Unspecified")

 IF(NOT CMAKE_INSTALL_COMPONENT OR "${CMAKE_INSTALL_COMPONENT}" STREQUAL "Unspecified")
-  FILE(INSTALL DESTINATION "/home/blue/sot-lib/share/doc/dynamicGraph/html" TYPE DIRECTORY FILES "/home/blue/sot-devel/dynamicGraph/doc/pictures")
+  FILE(INSTALL DESTINATION "/home/blue/sot-lib/share/doc/dynamic-graph/html" TYPE DIRECTORY FILES "/home/blue/sot-devel/dynamicGraph/doc/pictures")
 ENDIF(NOT CMAKE_INSTALL_COMPONENT OR "${CMAKE_INSTALL_COMPONENT}" STREQUAL "Unspecified")

--- a/doc/package.dox
+++ b/doc/package.dox
@@ -93,7 +93,7 @@ CHM_FILE               =
 HHC_LOCATION           = 
 GENERATE_CHI           = NO
 BINARY_TOC             = NO
-TOC_EXPAND             = YES
+TOC_EXPAND             = NO
 DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 1
 GENERATE_TREEVIEW      = YES
@@ -158,10 +158,10 @@ SKIP_FUNCTION_MACROS   = YES
 # Configuration::additions related to external references   
 #---------------------------------------------------------------------------
 TAGFILES               = \
-	/home/blue/sot-lib/share/doc/MatrixAbstractLayer/html/MatrixAbstractLayer.doxytag=/home/blue/sot-lib/share/doc/MatrixAbstractLayer/html \
-	/home/blue/sot-lib/share/doc/dynamicsJRLJapan/html/dynamicsJRLJapan.doxytag=/home/blue/sot-lib/share/doc/dynamicsJRLJapan/html \
-	/home/blue/sot-lib/share/doc/hrp2Dynamics/html/hrp2Dynamics.doxytag=/home/blue/sot-lib/share/doc/hrp2Dynamics/html \
-	/home/blue/sot-lib/share/doc/walkGenJrl/html/walkGenJrl.doxytag=/home/blue/sot-lib/share/doc/walkGenJrl/html
+	/html/MatrixAbstractLayer.doxytag=/html \
+	/html/dynamicsJRLJapan.doxytag=/html \
+	/html/hrp2Dynamics.doxytag=/html \
+	/html/walkGenJrl.doxytag=/html
 GENERATE_TAGFILE       = dynamicGraph.doxytag
 ALLEXTERNALS           = NO
 EXTERNAL_GROUPS        = YES
@@ -172,7 +172,7 @@ PERL_PATH              = /usr/bin/perl
 #---------------------------------------------------------------------------
 # Configuration::additions related to the search engine   
 #---------------------------------------------------------------------------
-SEARCHENGINE           = NO
+SEARCHENGINE           = YES



@@ -180,8 +180,8 @@ SEARCHENGINE           = NO
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
-PROJECT_NAME           = "dynamicGraph library documentation"
-PROJECT_NUMBER         = 1.0
+PROJECT_NAME           = "dynamicGraph library"
+PROJECT_NUMBER         = 1.0.0

 #---------------------------------------------------------------------------
 # Build related configuration options
@@ -210,7 +210,7 @@ SHOW_DIRECTORIES       = NO
 #---------------------------------------------------------------------------
 FILE_PATTERNS          = *.h *.idl
 EXCLUDE_PATTERNS       = 
-INPUT                  = /home/blue/sot-devel/dynamicGraph/include \
+INPUT                  = /home/blue/sot-devel/dynamicGraph/src \
                         /home/blue/sot-devel/dynamicGraph/doc/additionalDoc

 #---------------------------------------------------------------------------

--- a/doc/package.dox.cmake
+++ b/doc/package.dox.cmake
@@ -93,7 +93,7 @@ CHM_FILE               =
 HHC_LOCATION           = 
 GENERATE_CHI           = NO
 BINARY_TOC             = NO
-TOC_EXPAND             = YES
+TOC_EXPAND             = NO
 DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 1
 GENERATE_TREEVIEW      = YES
@@ -172,7 +172,7 @@ PERL_PATH              = /usr/bin/perl
 #---------------------------------------------------------------------------
 # Configuration::additions related to the search engine   
 #---------------------------------------------------------------------------
-SEARCHENGINE           = NO
+SEARCHENGINE           = YES



@@ -180,7 +180,7 @@ SEARCHENGINE           = NO
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
-PROJECT_NAME           = "${PROJECT_NAME} library documentation"
+PROJECT_NAME           = "${PROJECT_NAME} library"
 PROJECT_NUMBER         = ${PROJECT_VERSION}

 #---------------------------------------------------------------------------
@@ -210,7 +210,7 @@ SHOW_DIRECTORIES       = NO
 #---------------------------------------------------------------------------
 FILE_PATTERNS          = *.h *.idl
 EXCLUDE_PATTERNS       = 
-INPUT                  = ${${PROJECT_NAME}_SOURCE_DIR}/include \
+INPUT                  = ${${PROJECT_NAME}_SOURCE_DIR}/src \
                         ${CMAKE_CURRENT_SOURCE_DIR}/additionalDoc

 #---------------------------------------------------------------------------

--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -88,17 +88,17 @@ SET(ADDED_SRC_DEPEND_PROPERTIES "")
 FOREACH (header ${libdg_headers} ${libdg_templates}) 
  GET_FILENAME_COMPONENT(headerName ${header} NAME)
  ADD_CUSTOM_COMMAND(
-   OUTPUT ${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${headerName}
+   OUTPUT ${${PROJECT_NAME}_BINARY_DIR}/include/dynamic-graph/${headerName}
   COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/${header} 
-           ${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${headerName}
+           ${${PROJECT_NAME}_BINARY_DIR}/include/dynamic-graph/${headerName}
   DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${header}  
  )
  INSTALL(FILES
-	   ${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${headerName}
-	   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/dynamicGraph
+	   ${${PROJECT_NAME}_BINARY_DIR}/include/dynamic-graph/${headerName}
+	   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/dynamic-graph
 	   PERMISSIONS OWNER_READ GROUP_READ WORLD_READ OWNER_WRITE)
  SET(HEADER_IN_INCLUDE_DIR ${HEADER_IN_INCLUDE_DIR} 
-       ${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${headerName})
+       ${${PROJECT_NAME}_BINARY_DIR}/include/dynamic-graph/${headerName})
 ENDFOREACH(header)

 # --- Create a top level rule to copy all the headers from src to include/dynamicGraph
@@ -218,19 +218,19 @@ FOREACH (plugin ${libdg_plugins_headers})
  
  # Add a command to copy the header.
  ADD_CUSTOM_COMMAND(
-	OUTPUT ${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${pluginHeader}
+	OUTPUT ${${PROJECT_NAME}_BINARY_DIR}/include/dynamic-graph/${pluginHeader}
 	COMMAND ${CMAKE_COMMAND} -E copy 
 	${CMAKE_CURRENT_SOURCE_DIR}/${plugin} 
-	${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${pluginHeader}
+	${${PROJECT_NAME}_BINARY_DIR}/include/dynamic-graph/${pluginHeader}
 	DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${plugin})

-  INSTALL(FILES ${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${pluginHeader}
-	   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/dynamicGraph
+  INSTALL(FILES ${${PROJECT_NAME}_BINARY_DIR}/include/dynamic-graph/${pluginHeader}
+	   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/dynamic-graph
 	   PERMISSIONS OWNER_READ GROUP_READ WORLD_READ OWNER_WRITE)
  
  # Create a top level rule to copy all the headers from src to include/dg
  ADD_CUSTOM_TARGET(header_${newsofile} ALL
-	 DEPENDS ${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${pluginHeader})
+	 DEPENDS ${${PROJECT_NAME}_BINARY_DIR}/include/dynamic-graph/${pluginHeader})
 ENDFOREACH(plugin)

 # --- PLUGIN TEMPLATEs -----------------------------------------
@@ -252,7 +252,7 @@ FOREACH (plugin ${libdg_plugins_templates})
 	DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${plugin})

  INSTALL(FILES ${${PROJECT_NAME}_BINARY_DIR}/include/dynamicGraph/${pluginTemplate}
-	   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/dynamicGraph
+	   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/dynamic-graph
 	   PERMISSIONS OWNER_READ GROUP_READ WORLD_READ OWNER_WRITE)
  
  # Create a top level rule to copy all the headers from src to include/dg

--- a/src/debug/contiifstream.cpp
+++ b/src/debug/contiifstream.cpp
@@ -17,8 +17,8 @@
 *
 * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/

-#include <dynamicGraph/contiifstream.h>
-#include <dynamicGraph/debug.h>
+#include <dynamic-graph/contiifstream.h>
+#include <dynamic-graph/debug.h>

 sotContiifstream::
 sotContiifstream( const std::string& n )

--- a/src/debug/contiifstream.h
+++ b/src/debug/contiifstream.h
@@ -35,7 +35,7 @@
 #endif
 #include <list>

-#include <dynamicGraph/interpreter.h>
+#include <dynamic-graph/interpreter.h>
 #ifndef WIN32
 #include <pthread.h>
 #endif

--- a/src/debug/debug.cpp
+++ b/src/debug/debug.cpp
@@ -31,7 +31,7 @@
 *
 * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/

-#include <dynamicGraph/debug.h>
+#include <dynamic-graph/debug.h>
 #include <fstream>
 #include <ios>


--- a/src/debug/debug.h
+++ b/src/debug/debug.h
@@ -42,7 +42,7 @@
 #include <fstream>
 #include <sstream>
 #include <stdarg.h>
-#include <dynamicGraph/dynamicGraph-API.h>
+#include <dynamic-graph/dynamicGraph-API.h>

 
 /* -------------------------------------------------------------------------- */

--- a/src/dgraph/entity.cpp
+++ b/src/dgraph/entity.cpp
@@ -18,10 +18,10 @@
 * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/

 /*! Local framework includes */
-#include <dynamicGraph/entity.h>
-#include <dynamicGraph/pool.h>
-#include <dynamicGraph/pool.h>
-#include <dynamicGraph/debug.h>
+#include <dynamic-graph/entity.h>
+#include <dynamic-graph/pool.h>
+#include <dynamic-graph/pool.h>
+#include <dynamic-graph/debug.h>

 /*! System includes */
 #include <stdlib.h>

--- a/src/dgraph/entity.h
+++ b/src/dgraph/entity.h
@@ -27,10 +27,10 @@
 /* --------------------------------------------------------------------- */

 /* SOT */
-#include <dynamicGraph/signal-base.h>
-#include <dynamicGraph/exception-factory.h>
-#include <dynamicGraph/signal-array.h>
-#include <dynamicGraph/dynamicGraph-API.h>
+#include <dynamic-graph/signal-base.h>
+#include <dynamic-graph/exception-factory.h>
+#include <dynamic-graph/signal-array.h>
+#include <dynamic-graph/dynamicGraph-API.h>

 /* --- STD --- */
 #include <string>

--- a/src/dgraph/factory.cpp
+++ b/src/dgraph/factory.cpp
@@ -23,8 +23,8 @@
 /* --------------------------------------------------------------------- */

 /* --- SOT --- */
-#include <dynamicGraph/debug.h>
-#include <dynamicGraph/factory.h>
+#include <dynamic-graph/debug.h>
+#include <dynamic-graph/factory.h>

 using namespace std;
 using namespace dynamicgraph;

--- a/src/dgraph/factory.h
+++ b/src/dgraph/factory.h
@@ -31,8 +31,8 @@
 #include <string>

 /* --- SOT --- */
-#include <dynamicGraph/exception-factory.h>
-#include <dynamicGraph/dynamicGraph-API.h>
+#include <dynamic-graph/exception-factory.h>
+#include <dynamic-graph/dynamicGraph-API.h>

 namespace dynamicgraph {


--- a/src/dgraph/interpreter.cpp
+++ b/src/dgraph/interpreter.cpp
@@ -23,9 +23,9 @@
 /* --------------------------------------------------------------------- */

 /* SOT */
-#include <dynamicGraph/interpreter.h>
-#include <dynamicGraph/plugin-loader.h>
-#include <dynamicGraph/debug.h>
+#include <dynamic-graph/interpreter.h>
+#include <dynamic-graph/plugin-loader.h>
+#include <dynamic-graph/debug.h>

 /* --- STD --- */
 using namespace std;
@@ -92,10 +92,10 @@ deregisterFunction( const std::string& funname )
 /* --------------------------------------------------------------------- */
 /* --- NEW ------------------------------------------------------------- */
 /* --------------------------------------------------------------------- */
-#include <dynamicGraph/factory.h>
+#include <dynamic-graph/factory.h>
 using namespace std;
-#include <dynamicGraph/entity.h>
-#include <dynamicGraph/signal-base.h>
+#include <dynamic-graph/entity.h>
+#include <dynamic-graph/signal-base.h>

 void Interpreter::
 cmdPlug( const std::string& cmdLine, istringstream& cmdArg, std::ostream& os )

--- a/src/dgraph/interpreter.h
+++ b/src/dgraph/interpreter.h
@@ -27,10 +27,10 @@
 /* --------------------------------------------------------------------- */

 /* SOT */
-#include <dynamicGraph/signal-base.h>
-#include <dynamicGraph/exception-factory.h>
-#include <dynamicGraph/pool.h>
-#include <dynamicGraph/dynamicGraph-API.h>
+#include <dynamic-graph/signal-base.h>
+#include <dynamic-graph/exception-factory.h>
+#include <dynamic-graph/pool.h>
+#include <dynamic-graph/dynamicGraph-API.h>

 /* --- STD --- */
 #include <string>

--- a/src/dgraph/plugin-loader.cpp
+++ b/src/dgraph/plugin-loader.cpp
@@ -29,8 +29,8 @@
 #endif

 /* --- SOT --- */
-#include <dynamicGraph/plugin-loader.h>
-#include <dynamicGraph/debug.h>
+#include <dynamic-graph/plugin-loader.h>
+#include <dynamic-graph/debug.h>

 /* --- STD --- */
 #include <fstream>

--- a/src/dgraph/plugin-loader.h
+++ b/src/dgraph/plugin-loader.h
@@ -32,8 +32,8 @@
 #include <map>

 /* --- SOT --- */
-#include <dynamicGraph/exception-factory.h>
-#include <dynamicGraph/dynamicGraph-API.h>
+#include <dynamic-graph/exception-factory.h>
+#include <dynamic-graph/dynamicGraph-API.h>

 namespace dynamicgraph {


--- a/src/dgraph/pool.cpp
+++ b/src/dgraph/pool.cpp
@@ -22,9 +22,9 @@
 /* --------------------------------------------------------------------- */

 /* --- SOT --- */
-#include <dynamicGraph/pool.h>
-#include <dynamicGraph/debug.h>
-#include <dynamicGraph/entity.h>
+#include <dynamic-graph/pool.h>
+#include <dynamic-graph/debug.h>
+#include <dynamic-graph/entity.h>
 #include <list>
 #include <typeinfo>

@@ -128,7 +128,7 @@ clearPlugin( const std::string& name )

 /* --------------------------------------------------------------------- */

-#include <dynamicGraph/entity.h>
+#include <dynamic-graph/entity.h>

 #ifdef WIN32
 #include <time.h>
@@ -246,7 +246,7 @@ commandLine( const std::string& objectName,const std::string& functionName,



-#include <dynamicGraph/interpreter.h>
+#include <dynamic-graph/interpreter.h>

 SignalBase<int>&
 PoolStorage::

--- a/src/dgraph/pool.h
+++ b/src/dgraph/pool.h
@@ -30,9 +30,9 @@
 #include <sstream>

 /* --- SOT --- */
-#include <dynamicGraph/exception-factory.h>
-#include <dynamicGraph/signal-base.h>
-#include <dynamicGraph/dynamicGraph-API.h>
+#include <dynamic-graph/exception-factory.h>
+#include <dynamic-graph/signal-base.h>
+#include <dynamic-graph/dynamicGraph-API.h>

 namespace dynamicgraph
 {