MultiAgentDecisionProcess  Release 0.2.1
directories.h
Go to the documentation of this file.
1 
28 #ifndef _DIRECTORIES_H_
29 #define _DIRECTORIES_H_ 1
30 
31 #include <string>
32 
33 class PlanningUnit;
35 namespace ArgumentHandlers { class Arguments; }
36 
37 /* This file provides functions to get directory and file names.
38  * The code is structered around the following principles.
39  *
40  * (Input) problem files
41  *
42  * (Output) result files
43  * --------------------
44  * are stored in
45  * MADPGetResultsDir (= ~/.madp/results/METHOD/PROBLEM )
46  * which can be retrieved using MADPGetResultsDir(...)
47  *
48  * and have a basename
49  * METHOD_DESCR_PREFIX_ (where DESCR defaults to PROBLEM)
50  * which can be retrieved with MADPGetResultsBaseFilename(...).
51  *
52  * The result is that result files are written to
53  * ~/.madp/results/METHOD/PROBLEM/METHOD_DESCR_PREFIX_....
54  *
55  * MADPGetResultsFilename(...) gives you the concatenated version directly.
56  *
57  */
58 
59 namespace directories {
60 
61  std::string MADPGetResultsDir();
62  std::string MADPGetResultsDir(const std::string &method,
63  const std::string &problem);
64  std::string MADPGetResultsDir(const std::string &method,
65  const PlanningUnit &pu);
66  std::string MADPGetResultsDir(const std::string &method,
67  const
69  std::string MADPGetResultsDir(const std::string &method,
70  const PlanningUnit *pu);
71  std::string MADPGetResultsDir(const std::string &method,
72  const
74 
75  void MADPCreateResultsDir(const std::string &method,
76  const std::string &problem);
77  void MADPCreateResultsDir(const std::string &method,
78  const PlanningUnit &pu);
79  void MADPCreateResultsDir(const std::string &method,
80  const
82  void MADPCreateResultsDir(const std::string &method,
83  const PlanningUnit *pu);
84  void MADPCreateResultsDir(const std::string &method,
85  const
87 
88  std::string MADPGetResultsBaseFilename(const std::string &method,
89  const std::string &problem,
90  const
92 
93  std::string MADPGetResultsFilename(const std::string &method,
94  const std::string &problem,
95  const ArgumentHandlers::Arguments &args);
96  std::string MADPGetResultsFilename(const std::string &method,
97  const PlanningUnit &pu,
98  const ArgumentHandlers::Arguments &args);
99  std::string MADPGetResultsFilename(const std::string &method,
100  const
102  &problem,
103  const ArgumentHandlers::Arguments &args);
104 
105  std::string MADPGetProblemsDir();
106  std::string MADPGetProblemFilename(const std::string &problem,
107  const std::string &extension);
108  std::string MADPGetProblemFilename(const std::string &problem);
109  std::string MADPGetProblemFilename(const ArgumentHandlers::Arguments &args);
110 
111 } // namespace directories
112 
113 #endif /* !_DIRECTORIES_H_ */
114 
115 // Local Variables: ***
116 // mode:c++ ***
117 // End: ***