/usr/include/SoapySDR/Modules.hpp is in libsoapysdr-dev 0.6.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | ///
/// \file SoapySDR/Modules.hpp
///
/// Utility functions to deal with modules.
/// These utility functions are made available for advanced usage.
/// For most use cases, the API will automatically load modules.
///
/// \copyright
/// Copyright (c) 2014-2016 Josh Blum
/// SPDX-License-Identifier: BSL-1.0
///
#pragma once
#include <SoapySDR/Config.hpp>
#include <SoapySDR/Types.hpp>
#include <vector>
#include <string>
namespace SoapySDR
{
//! Query the root installation path
SOAPY_SDR_API std::string getRootPath(void);
/*!
* The list of paths automatically searched by loadModules().
* \return a list of automatically searched file paths
*/
SOAPY_SDR_API std::vector<std::string> listSearchPaths(void);
/*!
* List all modules found in default path.
* \return a list of file paths to loadable modules
*/
SOAPY_SDR_API std::vector<std::string> listModules(void);
/*!
* List all modules found in the given path.
* \param path a directory on the system
* \return a list of file paths to loadable modules
*/
SOAPY_SDR_API std::vector<std::string> listModules(const std::string &path);
/*!
* Load a single module given its file system path.
* \param path the path to a specific module file
* \return an error message, empty on success
*/
SOAPY_SDR_API std::string loadModule(const std::string &path);
/*!
* List all registration loader errors for a given module path.
* The resulting dictionary contains all registry entry names
* provided by the specified module. The value of each entry
* is an error message string or empty on successful load.
* \param path the path to a specific module file
* \return a dictionary of registry names to error messages
*/
SOAPY_SDR_API Kwargs getLoaderResult(const std::string &path);
/*!
* Unload a module that was loaded with loadModule().
* \param path the path to a specific module file
* \return an error message, empty on success
*/
SOAPY_SDR_API std::string unloadModule(const std::string &path);
/*!
* Load the support modules installed on this system.
* This call will only actually perform the load once.
* Subsequent calls are a NOP.
*/
SOAPY_SDR_API void loadModules(void);
}
|