iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ModuleLibrary.H
Go to the documentation of this file.
1 /*! @file
2  @author Laurent Itti
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 #ifndef INCLUDE_NRT_CORE_BLACKBOARD_MODULELIBRARY_H
36 #define INCLUDE_NRT_CORE_BLACKBOARD_MODULELIBRARY_H
37 
38 #include <string>
39 #include <vector>
41 
42 namespace nrt
43 {
44 
45  //! A simple struct to describe an NRT Module from available files on disk
46  /*! \ingroup blackboard */
48  {
49  //! The 'logical path' of the module or macro-module (e.g. category1/category2/modulename)
50  std::string logicalpath;
51 
52  //! The full absolute path of the shared library file (.so) of the module, or yaml file (.yaml) of macro-module
53  std::string fullpath;
54 
55  //! The entire manifest of the module or macro-module
57 
58  //! The module's icon as a byte stream
59  std::vector<unsigned char> icondata;
60 
61  //! The extension of the icon file (e.g. .jpeg, .png, etc)
62  std::string iconext;
63 
64  //! Serialization
65  template <class Archive>
66  void serialize(Archive & ar)
68  };
69 
70 
71  //! A Module library
72  /*! This class scans the locations specified by NRTMODULEPATH and loads all the manifests, icons, etc so they become
73  available to the Blackboard Federation and the nrtDesigner. \ingroup blackboard */
75  {
76  public:
77  //! Constructor from a colon-separated list of paths
78  /*! If the list is empty, we will use the NRTMODULEPATH, NRTMACROMODULEPATH, and NRTNETWORKPATH
79  environment variables instead. */
80  ModuleLibrary(std::string const & paths = "");
81 
82  //! Get all the module descriptions
83  std::vector<ModuleDescription> const & moduleDescriptions() const;
84 
85  private:
86  std::vector<ModuleDescription> itsModuleDescriptions;
87  };
88 
89 } // namespace nrt
90 
91 #endif // INCLUDE_NRT_CORE_BLACKBOARD_MODULELIBRARY_H