iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Environment.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_UTIL_ENVIRONMENT_H
36 #define INCLUDE_NRT_CORE_UTIL_ENVIRONMENT_H
37 
38 #include <string>
39 
40 namespace nrt
41 {
42  /*! \defgroup environment Helpers to access values of shell/Unix environment variables used by NRT */
43 
44  //! Enum that defines all the environment variables used by NRT
45  /*! The enum entries used here directly match the environment variable names. The enum is used to provide
46  strongly-typed, typo-proof access to these variables.
47 
48  \ingroup environment */
49  enum class Environment
50  {
51  NRTHOME, //!< Root NRT directory. Many other variables have defaults relative to NRTHOME if not set.
52  NRTMASTER, //!< IP address (or hostname) and port of the Blackboard master
53  NRTMODULEPATH, //!< Colon-separated path list to NRT modules
54  NRTMESSAGEPATH, //!< Colon-separated path list to NRT messages
55  NRTMACROMODULEPATH, //!< Colon-separated path list to NRT macro-modules
56  NRTNETWORKPATH, //!< Colon-separated path list to NRT networks
57  NRTAUTHOR //!< Semicolon-separated info about an author, used to create manifests
58 
59  // Programmer note: you need to update all the functions below in Environment.C each time you add a value here.
60  };
61 
62  //! Get the value of an environment variable
63  /*! If the variable is set, then use that value. Otherwise, use some default (see implementation).
64 
65  \ingroup environment */
66  std::string getenv(Environment const e);
67 
68  //! Get the description of an environment variable
69  /*! \ingroup environment */
70  std::string getenvdescription(Environment const e);
71 
72  //! Get the nameof an environment variable as used by the Unix Shell
73  /*! \ingroup environment */
74  std::string getenvname(Environment const e);
75 }
76 
77 
78 #endif // INCLUDE_NRT_CORE_UTIL_ENVIRONMENT_H