Nix (Dev) 3.5.10
dev - 3.5.10 - 1af9301
Loading...
Searching...
No Matches
paths.hpp
Go to the documentation of this file.
1#ifndef IV_SRC_CORE_PATHS_HPP_
2#define IV_SRC_CORE_PATHS_HPP_
3
4#include "core/defines.hpp"
5#include "core/file.hpp"
6#include "core/system.hpp"
7
8#include <fmt/core.h>
9#include <string_view>
10
11namespace iv::paths
12{
13
14namespace diamar
15{
16
17static constexpr std::string_view kAppDataFolderName = ".diamar";
18
19std::string appDataFolderPath(std::string_view homeDirectory = iv::system::retrieveHomeDirectory());
20std::string configFilePath(std::string_view projectFolder);
21std::string dataLicenseFilePath();
22std::string dataProjectFilePath(std::string_view projectFolder);
23std::string changeFilePath(std::string_view projectFolder);
24std::string defaultProjectFolderPath();
25std::string historyFilePath(std::string_view projectFolder);
26std::string licenseFilePath();
27std::string logicsPath(std::string_view projectFolder);
28std::string logsPath();
29std::string mimicsPath(std::string_view projectFolder);
30std::string mimicFilePath(std::string_view mimicsFolder, const iv::types::mimicId &mimicId);
31std::string mimicResourcesPath(std::string_view mimicFolder);
32std::string networkFilePath(std::string_view projectFolder);
33std::string preferencesFilePath();
34std::string sshConfigFilePath(std::string_view homeDirectory = iv::system::retrieveHomeDirectory());
35std::string environmentFilePath(std::string_view homeDirectory = iv::system::retrieveHomeDirectory());
36std::string tanksPath(std::string_view projectFolder);
37std::string tankFilePath(std::string_view tanksFolder, const iv::types::tankId &tankId);
38std::string unitsPath(std::string_view projectFolder);
39std::string unitFilePath(std::string_view unitsFolder, iv::types::unitId unitId);
40std::string pmsPath(std::string_view projectFolder);
41std::string controlsPath(std::string_view projectFolder);
42std::string pmsBusTieFilePath(std::string_view pmsFolder);
43std::string pmsGeneratorFilePath(std::string_view pmsFolder);
44std::string pmsMainBarFilePath(std::string_view pmsFolder);
45std::string pmsModesFilePath(std::string_view pmsFolder);
46std::string valvesFilePath(std::string_view controlFolder);
47std::string dampersFilePath(std::string_view controlFolder);
48
49bool isValidProjectFiles(std::string_view projectFolder);
51
52}// namespace diamar
53
54namespace editDiamar
55{
56
57static constexpr std::string_view kAppDataFolderName = ".editDiamar";
58static constexpr std::string_view kResourcesFolderName = "../resources/editDiamar";
59
60std::string appDataFolderPath();
61std::string librariesPath();
62std::string libraryFilePath(std::string_view libraryFile);
63std::string editorConfigurationFilePath();
64std::string logicLedFilePath(std::string_view projectFolder, iv::types::unitId unitId);
65std::string logicLimFilePath(std::string_view projectFolder, iv::types::unitId unitId);
66std::string logicLomFilePath(std::string_view projectFolder, iv::types::unitId unitId);
67std::string logicPdfFilePath(std::string_view projectFolder, iv::types::unitId unitId);
68std::string logicPlFilePath(std::string_view projectFolder, iv::types::unitId unitId);
69std::string logicTxtFilePath(std::string_view projectFolder, iv::types::unitId unitId);
70std::string tankTemperatureCorrectionsPath(std::string_view tableFolder);
71std::string logicParamsDatabaseFilePath();
72std::string cssFilePath();
73std::string imageFilePath(std::string_view imageName, std::string_view ext = "png", int32_t width = 16,
74 int32_t height = 16);
75
76}// namespace editDiamar
77
78namespace resources
79{
80
81std::string getResource(std::string_view nameResource, std::string_view ext = "");
82std::string getMimicResource(std::string_view nameResource, std::string_view ext = "");
83
84}// namespace resources
85
86}// namespace iv::paths
87
88#endif//IV_SRC_CORE_PATHS_HPP_
std::string historyFilePath(const std::string_view projectFolder)
Definition paths.cpp:44
std::string logicsPath(const std::string_view projectFolder)
Definition paths.cpp:54
std::string dataLicenseFilePath()
Definition paths.cpp:24
std::string controlsPath(std::string_view projectFolder)
Definition paths.cpp:124
std::string pmsModesFilePath(const std::string_view pmsFolder)
Definition paths.cpp:144
bool isValidDiamarDataFolder()
Definition paths.cpp:166
std::string pmsBusTieFilePath(const std::string_view pmsFolder)
Definition paths.cpp:129
std::string environmentFilePath(const std::string_view homeDirectory)
Definition paths.cpp:94
std::string tanksPath(const std::string_view projectFolder)
Definition paths.cpp:99
std::string mimicsPath(const std::string_view projectFolder)
Definition paths.cpp:64
std::string unitFilePath(const std::string_view unitsFolder, iv::types::unitId unitId)
Definition paths.cpp:114
std::string unitsPath(const std::string_view projectFolder)
Definition paths.cpp:109
std::string pmsGeneratorFilePath(const std::string_view pmsFolder)
Definition paths.cpp:134
std::string mimicResourcesPath(const std::string_view mimicFolder)
Definition paths.cpp:74
std::string dataProjectFilePath(const std::string_view projectFolder)
Definition paths.cpp:29
std::string pmsPath(const std::string_view projectFolder)
Definition paths.cpp:119
std::string preferencesFilePath()
Definition paths.cpp:84
std::string defaultProjectFolderPath()
Definition paths.cpp:39
std::string changeFilePath(std::string_view projectFolder)
Definition paths.cpp:34
std::string mimicFilePath(const std::string_view mimicsFolder, const iv::types::mimicId &mimicId)
Definition paths.cpp:69
std::string pmsMainBarFilePath(const std::string_view pmsFolder)
Definition paths.cpp:139
static constexpr std::string_view kAppDataFolderName
Definition paths.hpp:17
std::string configFilePath(const std::string_view projectFolder)
Definition paths.cpp:19
std::string dampersFilePath(std::string_view controlFolder)
Definition paths.cpp:154
std::string sshConfigFilePath(const std::string_view homeDirectory)
Definition paths.cpp:89
std::string tankFilePath(const std::string_view tanksFolder, const iv::types::tankId &tankId)
Definition paths.cpp:104
bool isValidProjectFiles(const std::string_view projectFolder)
Definition paths.cpp:159
std::string logsPath()
Definition paths.cpp:59
std::string valvesFilePath(std::string_view controlFolder)
Definition paths.cpp:149
std::string networkFilePath(const std::string_view projectFolder)
Definition paths.cpp:79
std::string appDataFolderPath(const std::string_view homeDirectory)
Definition paths.cpp:14
std::string licenseFilePath()
Definition paths.cpp:49
std::string tankTemperatureCorrectionsPath(const std::string_view tableFolder)
Definition paths.cpp:245
std::string cssFilePath()
Definition paths.cpp:255
std::string logicPdfFilePath(const std::string_view projectFolder, iv::types::unitId unitId)
Definition paths.cpp:221
std::string logicLomFilePath(const std::string_view projectFolder, iv::types::unitId unitId)
Definition paths.cpp:213
std::string logicLimFilePath(const std::string_view projectFolder, iv::types::unitId unitId)
Definition paths.cpp:205
static constexpr std::string_view kAppDataFolderName
Definition paths.hpp:57
std::string logicTxtFilePath(const std::string_view projectFolder, iv::types::unitId unitId)
Definition paths.cpp:237
std::string logicPlFilePath(const std::string_view projectFolder, iv::types::unitId unitId)
Definition paths.cpp:229
std::string logicLedFilePath(const std::string_view projectFolder, iv::types::unitId unitId)
Definition paths.cpp:197
std::string imageFilePath(std::string_view imageName, const std::string_view ext, int32_t width, int32_t height)
Definition paths.cpp:260
std::string appDataFolderPath()
Definition paths.cpp:177
std::string librariesPath()
Definition paths.cpp:182
std::string logicParamsDatabaseFilePath()
Definition paths.cpp:250
std::string libraryFilePath(const std::string_view libraryFile)
Definition paths.cpp:187
std::string editorConfigurationFilePath()
Definition paths.cpp:192
static constexpr std::string_view kResourcesFolderName
Definition paths.hpp:58
std::string getResource(const std::string_view nameResource, const std::string_view ext)
Definition paths.cpp:315
std::string getMimicResource(const std::string_view nameResource, const std::string_view ext)
Definition paths.cpp:321
Definition paths.cpp:9
std::string retrieveHomeDirectory()
Retrieve the home directory path.
Definition system.cpp:165
std::string mimicId
Definition types.hpp:72
uint16_t unitId
Definition types.hpp:77
std::string tankId
Definition types.hpp:78