Cleanup old files and naming conventions

ocra-recipes · May 20, 2016 · 59c7b83 · 59c7b83
1 parent 08262fc
commit 59c7b83
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 109 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,4 +1,4 @@
-# This file is part of ocra-yarp.
+# This file is part of ocra-icub.
 # Copyright (C) 2016 Institut des Systèmes Intelligents et de Robotique (ISIR)
 # author(s): Ryan Lober, Antoine Hoarau
 #
@@ -59,6 +59,7 @@ yarp_configure_external_installation(codyco)
 
 add_subdirectory(ocra-icub)
 add_subdirectory(ocra-icub-server)
+add_subdirectory(ocra-icub-clients)
 
 
 # add a target to generate API documentation with Doxygen

diff --git a/NOTES.md b/NOTES.md
diff --git a/README.md b/README.md
@@ -1,75 +1,47 @@
-#ocra-wbi-plugins [![Build Status](https://travis-ci.org/ocra-recipes/ocra-wbi-plugins.svg?branch=master)](https://travis-ci.org/ocra-recipes/ocra-wbi-plugins)
+# ocra-wbi-plugins [![Build Status](https://travis-ci.org/ocra-recipes/ocra-wbi-plugins.svg?branch=master)](https://travis-ci.org/ocra-recipes/ocra-wbi-plugins)
 
 Controller implementations and plugins for communicating between the whole body controller libraries developed at ISIR, [`ocra-recipes`](https://github.com/ocra-recipes/ocra-recipes), and the iCub Whole Body Interface, [`WBI`](https://github.com/robotology/wholebodyinterface), libraries.
 
 
-##Code Structure
-
+## Code Structure
 Here's how everything is laid out...
 
-###libs
-
-- [ocraWbiPlugins](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/ocraWbiPlugins)
-
-    - Interface libraries between WBI and ocra. The interface consists primarily of an inherited [`Model`](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/ocraWbiPlugins/src/ocraWbiModel.cpp) class who's virtual functions are implemented using WBI's functions. A [`utilities`](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/ocraWbiPlugins/src/ocraWbiUtil.cpp) class is also available for converting between various dynamic representations.
-
-- [taskSequences](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/taskSequences)
-
-    - This library contains a dictionary of "sequences" which are hard coded sets of tasks and control logic. New sequences go in the subdirectory [`sequences/`](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/taskSequences/include/taskSequences/sequences) and are included in [`sequenceLibrary.h`](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/taskSequences/include/sequenceLibrary.h) and their defintions are included in [`sequenceLibrary.cpp`](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/taskSequences/src/sequenceLibrary.cpp).
-
-- [ocraObservers](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/ocraObservers)
-
-    - *under construction*
-    - This library will eventually provide the base set of classes for creating "observerThreads" which can be launched in parallel to the controller for recording data in a way which will not affect controller performance.
-
-- [activityManagerTools](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/libs/activityManagerTools)
-
-    - This library provides the necessary classes and tools for creating [`activityManagers`](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/modules/activityManagers) which provide high level control logic and task set management.
-
-
-###modules
-
-- [wocraController](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/modules/wocraController)
-
-    - wocra controller implementation for the iCub. This module builds an executable which controls the iCub using a weighted QP controller. More info [here](https://github.com/ocra-recipes/ocra-recipes).
-
-- [gocraController](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/modules/gocraController)
+### [ocra-icub](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/ocra-icub)
 
-    - gocra controller implementation for the iCub. This module builds an executable which controls the iCub using a generalized hierarchical QP controller. More info [here](https://github.com/ocra-recipes/ocra-recipes).
+Interface libraries between WBI and ocra. The interface consists primarily of an inherited [`Model`](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/ocra-icub/src/ocraWbiModel.cpp) class who's virtual functions are implemented using WBI's functions. A [`Utilities`](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/ocra-icub/src/Utilities.cpp) class is also available for converting between various dynamic representations.
 
-- [ocraObservers](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/modules/ocraObservers)
 
-    - *under construction*
-    - "ObserverThreads" which can be launched in parallel to the controller for recording data in a way which will not affect controller performance will be held here.
+### [ocra-icub-server](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/ocra-icub-server)
 
-- [activityManagers](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/modules/activityManagers)
+This is an implementation of the ocra-server interface which gets the robot specific model info, calls the `computeTorque()` function and then sends it to the robot. The rest of the code is designed around yarp `RFModule` and `RateThread`, to parse command line args, and talk to the WBI. At the core of this code is the implementation of [`ocra_recipes::ControllerServer`](https://github.com/ocra-recipes/ocra-recipes/tree/master/ocra-recipes/src/ContControllerServer.cpp) class. The rest of the code is icub specific.  
 
-    - High level control logic and task set management modules.
 
+### [ocra-icub-clients](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/ocra-icub-clients)
 
-###cmake
+### [cmake](https://github.com/ocra-recipes/ocra-wbi-plugins/tree/master/cmake)
 
 This folder provides various cmake modules which allow cmake to find various packages and build packages from these projects.
 
 
-##Installation
+## Installation
 
-Superbuild! More details soon...
+Everything here should be built with [`codyco-superbuild`](https://github.com/robotology/codyco-superbuild) to make sure you have all of the required libs.
 
-##Usage
+## Usage
 
 See the video tutorials... Work in progress.
 
-##Authors
+## Authors
 
-###current developers
+### current developers
 
  - [Ryan Lober](https://github.com/rlober)
  - [Antoine Hoarau](https://github.com/ahoarau)
+ - [Jorhabib Eljaik](https://github.com/jeljaik)
  - [Silvio Traversaro](https://github.com/traversaro)
 
 
-###past developers
+### past developers
 
  - [Darwin Lau](https://github.com/darwinlau)
  - [Mingxing Liu](https://github.com/mingxing-liu)
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "ocra-yarp"
+PROJECT_NAME           = "ocra-icub"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

diff --git a/ocra-icub-server/CMakeLists.txt b/ocra-icub-server/CMakeLists.txt
@@ -1,4 +1,4 @@
-# This file is part of ocra-yarp.
+# This file is part of ocra-icub.
 # Copyright (C) 2016 Institut des Systèmes Intelligents et de Robotique (ISIR)
 # author(s): Ryan Lober, Antoine Hoarau
 #
@@ -35,10 +35,6 @@ ADD_EXECUTABLE(${PROJECTNAME} ${folder_source} ${folder_header})
 TARGET_LINK_LIBRARIES(
 ${PROJECTNAME}
 ocra-icub
-# ${OcraRecipes_LIBRARIES}
-# ${iDynTree_LIBRARIES}
-# ${yarpWholeBodyInterface_LIBRARIES}
-# ${Boost_LIBRARIES}
 )
 
 INSTALL(TARGETS ${PROJECTNAME} DESTINATION bin)

diff --git a/ocra-icub-server/app/CMakeLists.txt b/ocra-icub-server/app/CMakeLists.txt
@@ -1,4 +1,4 @@
-# This file is part of ocra-yarp.
+# This file is part of ocra-icub.
 # Copyright (C) 2016 Institut des Systèmes Intelligents et de Robotique (ISIR)
 # author(s): Ryan Lober, Antoine Hoarau
 #

diff --git a/ocra-icub-server/include/ocra-icub-server/Module.h b/ocra-icub-server/include/ocra-icub-server/Module.h
@@ -7,7 +7,7 @@
  *  \copyright  GNU General Public License.
  */
 /*
- *  This file is part of ocra-yarp.
+ *  This file is part of ocra-icub.
  *  Copyright (C) 2016 Institut des Systèmes Intelligents et de Robotique (ISIR)
  *
  *  This program is free software: you can redistribute it and/or modify

diff --git a/ocra-icub-server/include/ocra-icub-server/Thread.h b/ocra-icub-server/include/ocra-icub-server/Thread.h
@@ -7,7 +7,7 @@
  *  \copyright  GNU General Public License.
  */
 /*
- *  This file is part of ocra-yarp.
+ *  This file is part of ocra-icub.
  *  Copyright (C) 2016 Institut des Systèmes Intelligents et de Robotique (ISIR)
  *
  *  This program is free software: you can redistribute it and/or modify

diff --git a/ocra-icub-server/src/Module.cpp b/ocra-icub-server/src/Module.cpp
@@ -7,7 +7,7 @@
  *  \copyright  GNU General Public License.
  */
 /*
- *  This file is part of ocra-yarp.
+ *  This file is part of ocra-icub.
  *  Copyright (C) 2016 Institut des Systèmes Intelligents et de Robotique (ISIR)
  *
  *  This program is free software: you can redistribute it and/or modify

diff --git a/ocra-icub-server/src/Thread.cpp b/ocra-icub-server/src/Thread.cpp
@@ -7,7 +7,7 @@
  *  \copyright  GNU General Public License.
  */
 /*
- *  This file is part of ocra-yarp.
+ *  This file is part of ocra-icub.
  *  Copyright (C) 2016 Institut des Systèmes Intelligents et de Robotique (ISIR)
  *
  *  This program is free software: you can redistribute it and/or modify

diff --git a/ocra-icub-server/src/main.cpp b/ocra-icub-server/src/main.cpp
@@ -7,7 +7,7 @@
  *  \copyright  GNU General Public License.
  */
 /*
- *  This file is part of ocra-yarp.
+ *  This file is part of ocra-icub.
  *  Copyright (C) 2016 Institut des Systèmes Intelligents et de Robotique (ISIR)
  *
  *  This program is free software: you can redistribute it and/or modify