MagAO-X
Operations Applications Utilities Source
defaults.hpp
Go to the documentation of this file.
1 /** \file defaults.hpp
2  * \brief Defaults for the MagAO-X library
3  * \author Jared R. Males (jaredmales@gmail.com)
4  *
5  * History:
6  * - 2018-01-05 created by JRM
7  */
8 
9 #ifndef common_defaults_hpp
10 #define common_defaults_hpp
11 
12 
13 /** \defgroup default_app Default App Setup
14  * @{
15  */
16 
17 #ifndef MAGAOX_default_logExt
18  /// The extension for MagAO-X binary log files.
19  /** Do not include period before name here.
20  */
21  #define MAGAOX_default_logExt "binlog"
22 #endif
23 
24 #ifndef MAGAOX_default_writePause
25  /// The default logger writePause
26  /** Defines the default value of how long the logger write thread pauses after clearing the queue. Default is 1 sec.
27  *
28  * Units: nanoseconds.
29  */
30  #define MAGAOX_default_writePause (1000000000)
31 #endif
32 
33 #ifndef MAGAOX_default_max_logSize
34  /// The default maximum log file size
35  /** Defines the default maximum size in for a log file. Default is 10 MB.
36  *
37  * Units: bytes
38  */
39  #define MAGAOX_default_max_logSize (10485760)
40 #endif
41 
42 #ifndef MAGAOX_default_loopPause
43  /// The default application loopPause
44  /** Defines default value of how long the event loop in execute() pauses. Default is 1 sec.
45  *
46  * Units: nanoseconds.
47  */
48  #define MAGAOX_default_loopPause (1000000000)
49 #endif
50 
51 ///@}
52 
53 #endif //common_defaults_hpp