Pothos::System Namespace Reference

Classes
class	NumaInfo
class	Logger
class	HostInfo

Functions
POTHOS_API std::string	getRootPath (void)
POTHOS_API std::string	getDataPath (void)
POTHOS_API std::string	getUserDataPath (void)
POTHOS_API std::string	getUserConfigPath (void)
POTHOS_API std::string	getPothosUtilExecutablePath (void)
POTHOS_API std::string	getPothosRuntimeLibraryPath (void)
POTHOS_API std::string	getPothosDevIncludePath (void)
POTHOS_API std::string	getPothosDevLibraryPath (void)
POTHOS_API std::string	getApiVersion (void)
POTHOS_API std::string	getAbiVersion (void)
POTHOS_API std::string	getLibVersion (void)

Function Documentation

POTHOS_API std::string Pothos::System::getAbiVersion

(

void

)

Get the ABI version string that the library was built against. A client can compare POTHOS_ABI_VERSION to getAbiVersion() to check for ABI incompatibility before using the library. If the values are not equal then the client code was compiled against a different ABI than the library.

POTHOS_API std::string Pothos::System::getApiVersion

(

void

)

Get the Pothos framework API version as a string. The format of the version string is major.minor.increment, where the digits are taken directly from POTHOS_API_VERSION.

POTHOS_API std::string Pothos::System::getDataPath

(

void

)

Get the data path of the Pothos installation. This should be getRootPath()/share/Pothos

POTHOS_API std::string Pothos::System::getLibVersion

(

void

)

Get the library version and build information string. The format of the version string is major.minor.patch-buildInfo. This function is commonly used to identify the software back-end to the user for command-line utilities and graphical applications.

POTHOS_API std::string Pothos::System::getPothosDevIncludePath

(

void

)

Get the full path to the development headers directory.

POTHOS_API std::string Pothos::System::getPothosDevLibraryPath

(

void

)

Get the full path to the development libraries directory.

POTHOS_API std::string Pothos::System::getPothosRuntimeLibraryPath

(

void

)

Get the complete path to the Pothos runtime library.

POTHOS_API std::string Pothos::System::getPothosUtilExecutablePath

(

void

)

Get the complete path for the PothosUtil executable. The executable should be found in getRootPath()/bin.

POTHOS_API std::string Pothos::System::getRootPath

(

void

)

Get the root path of the Pothos installation. The root path is set by the POTHOS_ROOT environment variable. Otherwise set by the CMAKE_INSTALL_PREFIX at configuration time.

POTHOS_API std::string Pothos::System::getUserConfigPath

(

void

)

Where to put user local config. UNIX: This is $XDG_CONFIG_HOME or $HOME/.config/Pothos Windows: This is APPDATA%/Pothos

POTHOS_API std::string Pothos::System::getUserDataPath

(

void

)

Where to put user local data. UNIX: This is $XDG_DATA_HOME or $HOME/.local/share/Pothos Windows: This is APPDATA%/Pothos