iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Yaml.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 
36 #ifndef INCLUDE_NRT_CORE_BLACKBOARD_YAML_H
37 #define INCLUDE_NRT_CORE_BLACKBOARD_YAML_H
38 
40 
41 namespace nrt
42 {
43  namespace blackboard
44  {
45  /*! \defgroup bbyaml YAML load/save functions for Blackboard Federation summary data
46 
47  These functions facilitate saving the contents of a running Blackboard Federation to files, for later
48  re-loading. \ingroup bfsummary */
49 
50  /*! @{ */ // **********************************************************************
51 
52  //! Save a macro-module to YAML
53  void saveMacroModuleYaml(std::string const & namespc,
54  std::shared_ptr<nrt::blackboard::BlackboardFederationSummary const > bfs);
55 
56  //! Load a macro-module from YAML
57  /*! Pass empty namespc and empty instancename to load into the root namespace. */
58  void loadMacroModuleYaml(std::string const & logicalpath, std::string const & instancename,
59  std::string const & namespc,
60  std::map<std::string /* file bbnick */, std::string /* used bbnick */>
61  const & bbnickremap);
62 
63 
64  /*! @} */ // **********************************************************************
65  }
66 }
67 
68 #endif // INCLUDE_NRT_CORE_BLACKBOARD_YAML_H