GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
constants.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2006,2009,2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_GR_CONSTANTS_H
24#define INCLUDED_GR_CONSTANTS_H
25
26#include <gnuradio/api.h>
27#include <string>
28
29namespace gr {
30
31/*!
32 * \brief return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
33 */
34GR_RUNTIME_API const std::string prefix();
35
36/*!
37 * \brief return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
38 */
39GR_RUNTIME_API const std::string sysconfdir();
40
41/*!
42 * \brief return preferences file directory. Typically ${SYSCONFDIR}/etc/conf.d
43 */
44GR_RUNTIME_API const std::string prefsdir();
45
46/*!
47 * \brief return date/time of build, as set when 'cmake' is run
48 */
49GR_RUNTIME_API const std::string build_date();
50
51/*!
52 * \brief return version string defined by cmake (GrVersion.cmake)
53 */
54GR_RUNTIME_API const std::string version();
55
56/*!
57 * \brief return just the major version defined by cmake
58 */
59GR_RUNTIME_API const std::string major_version();
60
61/*!
62 * \brief return just the api version defined by cmake
63 */
64GR_RUNTIME_API const std::string api_version();
65
66/*!
67 * \brief returnjust the minor version defined by cmake
68 */
69GR_RUNTIME_API const std::string minor_version();
70
71/*!
72 * \brief return C compiler used to build this version of GNU Radio
73 */
74GR_RUNTIME_API const std::string c_compiler();
75
76/*!
77 * \brief return C++ compiler used to build this version of GNU Radio
78 */
79GR_RUNTIME_API const std::string cxx_compiler();
80
81/*!
82 * \brief return C and C++ compiler flags used to build this version of GNU Radio
83 */
84GR_RUNTIME_API const std::string compiler_flags();
85
86/*!
87 * \brief return build-time enabled components
88 */
90
91} /* namespace gr */
92
93#endif /* INCLUDED_GR_CONSTANTS_H */
#define GR_RUNTIME_API
Definition: gnuradio-runtime/include/gnuradio/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45
GR_RUNTIME_API const std::string compiler_flags()
return C and C++ compiler flags used to build this version of GNU Radio
GR_RUNTIME_API const std::string sysconfdir()
return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
GR_RUNTIME_API const std::string minor_version()
returnjust the minor version defined by cmake
GR_RUNTIME_API const std::string api_version()
return just the api version defined by cmake
GR_RUNTIME_API const std::string c_compiler()
return C compiler used to build this version of GNU Radio
GR_RUNTIME_API const std::string prefsdir()
return preferences file directory. Typically ${SYSCONFDIR}/etc/conf.d
GR_RUNTIME_API const std::string prefix()
return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
GR_RUNTIME_API const std::string major_version()
return just the major version defined by cmake
GR_RUNTIME_API const std::string version()
return version string defined by cmake (GrVersion.cmake)
GR_RUNTIME_API const std::string build_date()
return date/time of build, as set when 'cmake' is run
GR_RUNTIME_API const std::string cxx_compiler()
return C++ compiler used to build this version of GNU Radio
GR_RUNTIME_API const std::string build_time_enabled_components()
return build-time enabled components