directories.h Source File

CPP API: directories.h Source File
directories.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2020-2026 MEmilio
3 *
4 * Authors: Rene Schmieding, Julia Bicker
5 *
6 * Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20 #ifndef MIO_IO_DIRECTORIES_H
21 #define MIO_IO_DIRECTORIES_H
22 
23 #include "memilio/config.h" // IWYU pragma: keep
24 
25 #include <filesystem>
26 #include <string>
27 
28 namespace mio
29 {
30 
34 std::filesystem::path base_dir();
35 
39 [[maybe_unused]] std::filesystem::path data_dir();
40 
46 [[maybe_unused]] std::filesystem::path example_results_dir(const std::string& example_name);
47 
48 } // namespace mio
49 
50 #endif // MIO_IO_DIRECTORIES_H
A collection of classes to simplify handling of matrix shapes in meta programming.
Definition: models/abm/analyze_result.h:30
std::filesystem::path data_dir()
Returns the absolute path to the project directory.
Definition: directories.cpp:30
std::filesystem::path base_dir()
Returns the absolute path to the project directory.
Definition: directories.cpp:25
std::filesystem::path example_results_dir(const std::string &example_name)
Returns the absolute path to a common ouput directory for the code examples.
Definition: directories.cpp:35