Library

Library level functions and types. More...

Data Structures
struct	Version_t
	Version information for ids_peak_afl. More...
class	Exception
	General Error type. More...

Functions
void	Init ()
	Init the peak_afl auto feature library.
void	Exit ()
	Exit the peak_afl auto feature library.
PEAK_AFL_NO_DISCARD std::string	GetLastError ()
	Get the last error message.
PEAK_AFL_NO_DISCARD Version_t	Version ()
	Query the library version.

Detailed Description

Library level functions and types.

Function Documentation

Exit()

void Exit ( )

inline

Exit the peak_afl auto feature library.

Deinitializes the internal library status.

For each call to peak::afl::library::Init there must be a corresponding call to this function to ensure proper deinitialization of the library status.
After the library has been exited its functions (besides peak::afl::library::Init) will not be operable until peak::afl::library::Init has been called again.

Exceptions

peak::afl::error::Exception

if deinitialization fails

Since

1.1

GetLastError()

std::string GetLastError ( )

inline

Get the last error message.

Returns

the last error as string or the error as string

Since

1.1

Init()

void Init ( )

inline

Init the peak_afl auto feature library.

Initializes the internal library status.

This function must be called prior to any other function call.
The function may be called multiple times from a single client process. For each call there must be a corresponding call to peak::afl::library::Exit to ensure proper deinitialization of the library status.

Exceptions

peak::afl::error::Exception

if initialization fails

Since

1.1

Version()

Version_t Version ( )

inline

Query the library version.

Provides the version of the library divided in major, minor, subminor and patch, in that order of magnitude.

Returns

The version struct

Exceptions

peak::afl::error::Exception

if an error occurs. Check code() and what() for an explanation of the error

Note

This function can be used even if the library is not initialized.

Since

1.1