GNU Radio C++ API Reference: constants.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
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 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_GR_CONSTANTS_H
12#define INCLUDED_GR_CONSTANTS_H
13
14#include <gnuradio/api.h>
15#include <string>
16
17namespace gr {
18
19/*!
20 * \brief return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
21 */
22 GR_RUNTIME_API const std::string prefix();
23
24/*!
25 * \brief return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
26 */
27 GR_RUNTIME_API const std::string sysconfdir();
28
29/*!
30 * \brief return preferences file directory. Typically ${SYSCONFDIR}/etc/conf.d
31 */
32 GR_RUNTIME_API const std::string prefsdir();
33
34/*!
35 * \brief return date/time of build, as set when 'cmake' is run
36 */
37 GR_RUNTIME_API const std::string build_date();
38
39/*!
40 * \brief return version string defined by cmake (GrVersion.cmake)
41 */
42 GR_RUNTIME_API const std::string version();
43
44/*!
45 * \brief return just the major version defined by cmake
46 */
47 GR_RUNTIME_API const std::string major_version();
48
49/*!
50 * \brief return just the api version defined by cmake
51 */
52 GR_RUNTIME_API const std::string api_version();
53
54/*!
55 * \brief returnjust the minor version defined by cmake
56 */
57 GR_RUNTIME_API const std::string minor_version();
58
59/*!
60 * \brief return C compiler used to build this version of GNU Radio
61 */
62 GR_RUNTIME_API const std::string c_compiler();
63
64/*!
65 * \brief return C++ compiler used to build this version of GNU Radio
66 */
67 GR_RUNTIME_API const std::string cxx_compiler();
68
69/*!
70 * \brief return C and C++ compiler flags used to build this version of GNU Radio
71 */
72 GR_RUNTIME_API const std::string compiler_flags();
73
74/*!
75 * \brief return build-time enabled components
76 */
77 GR_RUNTIME_API const std::string build_time_enabled_components();
78
79/*!
80 * \brief return the pybind11 version used to build this version of GNU Radio
81 */
82 GR_RUNTIME_API const std::string pybind_version();
83
84
85} /* namespace gr */
86
87#endif /* INCLUDED_GR_CONSTANTS_H */
api.h
GR_RUNTIME_API
#define GR_RUNTIME_API
Definition gnuradio-runtime/include/gnuradio/api.h:18
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
gr::compiler_flags
GR_RUNTIME_API const std::string compiler_flags()
return C and C++ compiler flags used to build this version of GNU Radio
gr::sysconfdir
GR_RUNTIME_API const std::string sysconfdir()
return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
gr::minor_version
GR_RUNTIME_API const std::string minor_version()
returnjust the minor version defined by cmake
gr::api_version
GR_RUNTIME_API const std::string api_version()
return just the api version defined by cmake
gr::c_compiler
GR_RUNTIME_API const std::string c_compiler()
return C compiler used to build this version of GNU Radio
gr::prefsdir
GR_RUNTIME_API const std::string prefsdir()
return preferences file directory. Typically ${SYSCONFDIR}/etc/conf.d
gr::prefix
GR_RUNTIME_API const std::string prefix()
return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
gr::major_version
GR_RUNTIME_API const std::string major_version()
return just the major version defined by cmake
gr::version
GR_RUNTIME_API const std::string version()
return version string defined by cmake (GrVersion.cmake)
gr::build_date
GR_RUNTIME_API const std::string build_date()
return date/time of build, as set when 'cmake' is run
gr::pybind_version
GR_RUNTIME_API const std::string pybind_version()
return the pybind11 version used to build this version of GNU Radio
gr::cxx_compiler
GR_RUNTIME_API const std::string cxx_compiler()
return C++ compiler used to build this version of GNU Radio
gr::build_time_enabled_components
GR_RUNTIME_API const std::string build_time_enabled_components()
return build-time enabled components