MagAO-X
Operations Applications Utilities Source
paths.hpp
Go to the documentation of this file.
1 /** \file paths.hpp
2  * \brief Defaults for the MagAO-X library
3  * \author Jared R. Males (jaredmales@gmail.com)
4  *
5  * History:
6  * - 2018-07-13 created by JRM
7  */
8 
9 #ifndef common_paths_hpp
10 #define common_paths_hpp
11 
12 /** \defgroup default_paths Default Paths
13  * \ingroup common
14  *
15  * @{
16  */
17 
18 #ifndef MAGAOX_path
19  /// The path to the MagAO-X system files
20  /** This directory will have subdirectories including config, log, and sys directories.
21  */
22  #define MAGAOX_path "/opt/MagAOX"
23 #endif
24 
25 #ifndef MAGAOX_configRelPath
26  /// The relative path to the configuration files.
27  /** This is the subdirectory for configuration files.
28  */
29  #define MAGAOX_configRelPath "config"
30 #endif
31 
32 #ifndef MAGAOX_globalConfig
33  /// The filename for the global configuration file.
34  /** Will be looked for in the config/ subdirectory.
35  */
36  #define MAGAOX_globalConfig "magaox.conf"
37 #endif
38 
39 #ifndef MAGAOX_logRelPath
40  /// The relative path to the log directory.
41  /** This is the subdirectory for logs.
42  */
43  #define MAGAOX_logRelPath "logs"
44 #endif
45 
46 #ifndef MAGAOX_sysRelPath
47  /// The relative path to the system directory
48  /** This is the subdirectory for the system status files.
49  */
50  #define MAGAOX_sysRelPath "sys"
51 #endif
52 
53 #ifndef MAGAOX_secretsRelPath
54  /// The relative path to the secrets directory. Used for storing passwords, etc.
55  /** This is the subdirectory for secrets.
56  */
57  #define MAGAOX_secretsRelPath "secrets"
58 #endif
59 
60 #ifndef MAGAOX_driverRelPath
61  /// The relative path to the INDI drivers
62  /** This is the subdirectory for the INDI drivers.
63  */
64  #define MAGAOX_driverRelPath "drivers"
65 #endif
66 
67 #ifndef MAGAOX_driverFIFORelPath
68  /// The relative path to the INDI driver FIFOs
69  /** This is the subdirectory for the INDI driver FIFOs.
70  */
71  #define MAGAOX_driverFIFORelPath "drivers/fifos"
72 #endif
73 
74 ///@}
75 
76 #endif //common_paths_hpp