Namespace for helper functions related to system or CVB installation information. More...
Classes | |
class | LicenseInfo |
Information about CVB licenses. More... | |
class | MagicNumberEntry |
A single Magic Number entry. More... | |
Functions | |
String | HeaderVersion () noexcept |
Returns the version of these headers. More... | |
String | VersionMin () noexcept |
Gets the minimum CVB required for these headers. More... | |
String | VersionBuild () noexcept |
Gets the CVB version this header set was build/validated with. More... | |
String | Version () |
Full version of the currently installed CVB. More... | |
std::string | GetLastErrorMessage (int &errorCode) |
Returns the last error message and its code. More... | |
std::string | GetLastErrorMessage () |
Returns the last error message. More... | |
std::exception_ptr | GetLastError () noexcept |
Returns a pointer that points at the exception. More... | |
String | ExpandPath (const String &path) |
Expands a path containing an environment variable. More... | |
String | InstallPath () |
Directory Common Vision Blox has been installed to. More... | |
String | DataPath () |
Directory where Common Vision Blox stores its settings. More... | |
std::vector< LicenseInfo > | GetLicenseInfo () |
Get information about available licenses. More... | |
template<class Rep , class Period > | |
WaitStatus | WaitForLicense (const std::chrono::duration< Rep, Period > &timeSpan) noexcept |
Wait for a given time for the license to become available. More... | |
std::vector< MagicNumberEntry > | GetMagicNumberEntries () |
Query the set of currently available Magic Numbers. More... | |
Namespace for helper functions related to system or CVB installation information.
|
inline |
Directory where Common Vision Blox stores its settings.
Any | exception derived from std::exception including CvbException. |
Expands a path containing an environment variable.
[in] | path | Path with environment variable in windows notation. |
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Returns a pointer that points at the exception.
This function assumes it is called because an error has happened.
|
inline |
Returns the last error message.
Any | exception derived from std::exception including CvbException. |
|
inline |
Returns the last error message and its code.
[out] | errorCode | The error code of the last execution. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Get information about available licenses.
Any | exception derived from std::exception including CvbException. |
In theory, the collection of available licenses can change any time. However, it is fairly unlikely that during runtime someone unplugs a dongle or removes a Node Locked license, so Common Vision Blox does not implement a costly push/event model for notifying clients during runtime about the presence of new licenses or the loss of a license. Instead, the license information can and needs to be queried using this method.
|
inline |
Query the set of currently available Magic Numbers.
Any | exception derived from std::exception including CvbException. |
In theory, the collection of available Magic Numbers can change any time. However, it is fairly unlikely that during runtime someone unplugs a dongle or removes a Node Locked license, so Common Vision Blox does not implement a costly push/event model for notifying clients during runtime about the presence of new Magic Numbers or the loss of a Magic Number. Instead, the Magic Number information can and needs to be queried using this method.
|
inlinenoexcept |
Returns the version of these headers.
Does | not throw any exception. |
|
inline |
Directory Common Vision Blox has been installed to.
Any | exception derived from std::exception including CvbException. |
|
inline |
Full version of the currently installed CVB.
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Gets the CVB version this header set was build/validated with.
Does | not throw any exception. |
Usually this is the same as VersionMin(), except for nightlys that are build against the next upcomming CVB version.
|
inlinenoexcept |
Gets the minimum CVB required for these headers.
Does | not throw any exception. |
Even older versions might work in for a subset.
|
inlinenoexcept |
Wait for a given time for the license to become available.
[in] | timeSpan | Time to wait for license. |
Does | not throw any exception. |
This is useful if your application is automatically started after the operating system. E.g. the license service might not be up and running yet. So your application will start without a license. By calling this function you can make sure your application sees a valid license before actually requiring it.