API
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  * \ingroup common
15  * @{
16  */
17 
18 #ifndef MAGAOX_default_logExt
19  /// The extension for MagAO-X binary log files.
20  /** Do not include period before name here.
21  */
22  #define MAGAOX_default_logExt "binlog"
23 #endif
24 
25 #ifndef MAGAOX_default_writePause
26  /// The default logger writePause
27  /** Defines the default value of how long the logger write thread pauses after clearing the queue. Default is 1 sec.
28  *
29  * Units: nanoseconds.
30  */
31  #define MAGAOX_default_writePause (1000000000)
32 #endif
33 
34 #ifndef MAGAOX_default_max_logSize
35  /// The default maximum log file size
36  /** Defines the default maximum size in for a log file. Default is 10 MB.
37  *
38  * Units: bytes
39  */
40  #define MAGAOX_default_max_logSize (10485760)
41 #endif
42 
43 #ifndef MAGAOX_default_loopPause
44  /// The default application loopPause
45  /** Defines default value of how long the event loop in execute() pauses. Default is 1 sec.
46  *
47  * Units: nanoseconds.
48  */
49  #define MAGAOX_default_loopPause (1000000000)
50 #endif
51 
52 ///@}
53 
54 #endif //common_defaults_hpp