Version.hpp File Reference

#include <Pothos/Config.hpp>
#include <string>

Go to the source code of this file.

Namespaces
	Pothos
	Pothos::System

Macros
#define	POTHOS_API_VERSION   0x00040000
#define	POTHOS_ABI_VERSION   "0.4-3"

Functions
POTHOS_API std::string	Pothos::System::getApiVersion (void)
POTHOS_API std::string	Pothos::System::getAbiVersion (void)
POTHOS_API std::string	Pothos::System::getLibVersion (void)

Detailed Description

Version information for the library.

Copyright

Copyright (c) 2013-2016 Josh Blum SPDX-License-Identifier: BSL-1.0

Macro Definition Documentation

#define POTHOS_ABI_VERSION   "0.4-3"

ABI Version Information - incremented when the ABI is changed. The ABI version format is major.minor-bump. The major.minor comes from the in-progress library version when the change was made, and bump signifies a change to the ABI during library development. The ABI should remain constant across patch releases of the library.

#define POTHOS_API_VERSION   0x00040000

API version number which can be used as a preprocessor check. The format of the version number is encoded as follows: (major << 24) | (minor << 16) | (16 bit increment). Where the increment can be used to indicate implementation changes, fixes, or API additions within a minor release series.

The macro is typically used in an application as follows:

#if defined(POTHOS_API_VERSION) && (POTHOS_API_VERSION >= 0x00001234)
// Use a newer feature from the Pothos framework API
#endif